Mail::Box::Mbox::Message - one message in a Mbox folder


NAME

Mail::Box::Mbox::Message - one message in a Mbox folder


INHERITANCE

 Mail::Box::Mbox::Message
   is a Mail::Box::File::Message
   is a Mail::Box::Message
   is a Mail::Message
   is a Mail::Reporter


SYNOPSIS

 my $folder  = new Mail::Box::Mbox folder => $ENV{MAIL}, ...;
 my $message = $folder->message(0);


DESCRIPTION

Maintain one message in an Mail::Box::Mbox folder.


METHODS

Constructors

$obj->clone(OPTIONS)

See Constructors in the Mail::Message manpage

Mail::Box::Mbox::Message->new(OPTIONS)

See METHODS in the Mail::Box::File::Message manpage

Constructing a message

$obj->bounce([RG-OBJECT|OPTIONS])

See Constructing a message in the Mail::Message::Construct::Bounce manpage

Mail::Box::Mbox::Message->build([MESSAGE|PART|BODY], CONTENT)

See Constructing a message in the Mail::Message::Construct::Build manpage

Mail::Box::Mbox::Message->buildFromBody(BODY, [HEAD], HEADERS)

See Constructing a message in the Mail::Message::Construct::Build manpage

$obj->forward(OPTIONS)

See Constructing a message in the Mail::Message::Construct::Forward manpage

$obj->forwardAttach(OPTIONS)

See Constructing a message in the Mail::Message::Construct::Forward manpage

$obj->forwardEncapsulate(OPTIONS)

See Constructing a message in the Mail::Message::Construct::Forward manpage

$obj->forwardInline(OPTIONS)

See Constructing a message in the Mail::Message::Construct::Forward manpage

$obj->forwardNo(OPTIONS)

See Constructing a message in the Mail::Message::Construct::Forward manpage

$obj->forwardPostlude

See Constructing a message in the Mail::Message::Construct::Forward manpage

$obj->forwardPrelude

See Constructing a message in the Mail::Message::Construct::Forward manpage

$obj->forwardSubject(STRING)

See Constructing a message in the Mail::Message::Construct::Forward manpage

Mail::Box::Mbox::Message->read(FILEHANDLE|SCALAR|REF-SCALAR|ARRAY-OF-LINES, OPTIONS)

See Constructing a message in the Mail::Message::Construct::Read manpage

$obj->rebuild(OPTIONS)

See Constructing a message in the Mail::Message::Construct::Rebuild manpage

$obj->reply(OPTIONS)

See Constructing a message in the Mail::Message::Construct::Reply manpage

$obj->replyPrelude([STRING|FIELD|ADDRESS|ARRAY-OF-THINGS])

See Constructing a message in the Mail::Message::Construct::Reply manpage

$obj->replySubject(STRING)

Mail::Box::Mbox::Message->replySubject(STRING)

See Constructing a message in the Mail::Message::Construct::Reply manpage

The message

$obj->container

See The message in the Mail::Message manpage

$obj->copyTo(FOLDER, OPTIONS)

See The message in the Mail::Box::Message manpage

$obj->folder([FOLDER])

See The message in the Mail::Box::Message manpage

$obj->fromLine([LINE])

See The message in the Mail::Box::File::Message manpage

$obj->isDummy

See The message in the Mail::Message manpage

$obj->isPart

See The message in the Mail::Message manpage

$obj->messageId

See The message in the Mail::Message manpage

$obj->moveTo(FOLDER, OPTIONS)

See The message in the Mail::Box::Message manpage

$obj->print([FILEHANDLE])

See The message in the Mail::Message manpage

$obj->send([MAILER], OPTIONS)

See The message in the Mail::Message manpage

$obj->seqnr([INTEGER])

See The message in the Mail::Box::Message manpage

$obj->size

See The message in the Mail::Message manpage

$obj->toplevel

See The message in the Mail::Message manpage

$obj->write([FILEHANDLE])

See METHODS in the Mail::Box::File::Message manpage

The header

$obj->bcc

See The header in the Mail::Message manpage

$obj->cc

See The header in the Mail::Message manpage

$obj->date

See The header in the Mail::Message manpage

$obj->destinations

See The header in the Mail::Message manpage

$obj->from

See The header in the Mail::Message manpage

$obj->get(FIELDNAME)

See The header in the Mail::Message manpage

$obj->guessTimestamp

See The header in the Mail::Message manpage

$obj->head([HEAD])

See The header in the Mail::Message manpage

$obj->nrLines

See The header in the Mail::Message manpage

$obj->sender

See The header in the Mail::Message manpage

$obj->study(FIELDNAME)

See The header in the Mail::Message manpage

$obj->subject

See The header in the Mail::Message manpage

$obj->timestamp

See The header in the Mail::Message manpage

$obj->to

See The header in the Mail::Message manpage

The body

$obj->body([BODY])

See The body in the Mail::Message manpage

$obj->decoded(OPTIONS)

See The body in the Mail::Message manpage

$obj->encode(OPTIONS)

See The body in the Mail::Message manpage

$obj->isMultipart

See The body in the Mail::Message manpage

$obj->isNested

See The body in the Mail::Message manpage

$obj->parts(['ALL'|'ACTIVE'|'DELETED'|'RECURSE'|FILTER])

See The body in the Mail::Message manpage

Flags

$obj->delete

See Flags in the Mail::Message manpage

$obj->deleted([BOOLEAN])

See Flags in the Mail::Message manpage

$obj->isDeleted

See Flags in the Mail::Message manpage

$obj->isModified

See Flags in the Mail::Message manpage

$obj->label(LABEL|PAIRS)

See Flags in the Mail::Message manpage

$obj->labels

See Flags in the Mail::Message manpage

$obj->labelsToStatus

See Flags in the Mail::Message manpage

$obj->modified([BOOLEAN])

See Flags in the Mail::Message manpage

$obj->statusToLabels

See Flags in the Mail::Message manpage

The whole message as text

$obj->file

See The whole message as text in the Mail::Message::Construct::Text manpage

$obj->lines

See The whole message as text in the Mail::Message::Construct::Text manpage

$obj->printStructure([FILEHANDLE|undef],[INDENT])

See The whole message as text in the Mail::Message::Construct::Text manpage

$obj->string

See The whole message as text in the Mail::Message::Construct::Text manpage

Internals

$obj->clonedFrom

See Internals in the Mail::Message manpage

Mail::Box::Mbox::Message->coerce(MESSAGE, OPTIONS)

See Internals in the Mail::Message manpage

$obj->diskDelete

See Internals in the Mail::Box::Message manpage

$obj->fileLocation

See Internals in the Mail::Box::File::Message manpage

$obj->isDelayed

See Internals in the Mail::Message manpage

$obj->loadBody

See Internals in the Mail::Box::File::Message manpage

$obj->moveLocation(DISTANCE)

See Internals in the Mail::Box::File::Message manpage

$obj->readBody(PARSER, HEAD [, BODYTYPE])

See Internals in the Mail::Box::Message manpage

$obj->readFromParser(PARSER)

See Internals in the Mail::Box::File::Message manpage

$obj->readHead(PARSER [,CLASS])

See Internals in the Mail::Message manpage

$obj->recursiveRebuildPart(PART, OPTIONS)

See Internals in the Mail::Message::Construct::Rebuild manpage

$obj->storeBody(BODY)

See Internals in the Mail::Message manpage

$obj->takeMessageId([STRING])

See Internals in the Mail::Message manpage

Error handling

$obj->AUTOLOAD

See METHODS in the Mail::Message::Construct manpage

$obj->addReport(OBJECT)

See Error handling in the Mail::Reporter manpage

$obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

Mail::Box::Mbox::Message->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

See Error handling in the Mail::Reporter manpage

$obj->errors

See Error handling in the Mail::Reporter manpage

$obj->log([LEVEL [,STRINGS]])

Mail::Box::Mbox::Message->log([LEVEL [,STRINGS]])

See Error handling in the Mail::Reporter manpage

$obj->logPriority(LEVEL)

Mail::Box::Mbox::Message->logPriority(LEVEL)

See Error handling in the Mail::Reporter manpage

$obj->logSettings

See Error handling in the Mail::Reporter manpage

$obj->notImplemented

See Error handling in the Mail::Reporter manpage

$obj->report([LEVEL])

See Error handling in the Mail::Reporter manpage

$obj->reportAll([LEVEL])

See Error handling in the Mail::Reporter manpage

$obj->shortSize([VALUE])

Mail::Box::Mbox::Message->shortSize([VALUE])

See Error handling in the Mail::Message manpage

$obj->shortString

See Error handling in the Mail::Message manpage

$obj->trace([LEVEL])

See Error handling in the Mail::Reporter manpage

$obj->warnings

See Error handling in the Mail::Reporter manpage

Cleanup

$obj->DESTROY

See Cleanup in the Mail::Message manpage

$obj->destruct

See Cleanup in the Mail::Box::Message manpage

$obj->inGlobalDestruction

See Cleanup in the Mail::Reporter manpage


DIAGNOSTICS

Error: Cannot include forward source as $include.

Unknown alternative for the forward(include). Valid choices are NO, INLINE, ATTACH, and ENCAPSULATE.

Error: Cannot include reply source as $include.

Unknown alternative for the include option of reply(). Valid choices are NO, INLINE, and ATTACH.

Error: No address to create forwarded to.

If a forward message is created, a destination address must be specified.

Error: No default mailer found to send message.

The message send() mechanism had not enough information to automatically find a mail transfer agent to sent this message. Specify a mailer explicitly using the via options.

Error: Only build() Mail::Message's; they are not in a folder yet

You may wish to construct a message to be stored in a some kind of folder, but you need to do that in two steps. First, create a normal Mail::Message, and then add it to the folder. During this Mail::Box::addMessage() process, the message will get coerce()-d into the right message type, adding storage information and the like.

Error: Package $package does not implement $method.

Fatal error: the specific package (or one of its superclasses) does not implement this method where it should. This message means that some other related classes do implement this method however the class at hand does not. Probably you should investigate this and probably inform the author of the package.

Error: Unable to read delayed body.

Error: forwardAttach requires a preamble object

Error: forwardEncapsulate requires a preamble object

Error: no rebuild rule $name defined.


DETAILS


REFERENCES

See the MailBox website at http://perl.overmeer.net/mailbox/ for more details.


COPYRIGHTS

Distribution version 2.059. Written by Mark Overmeer (mark@overmeer.net) See the ChangeLog for other contributors.

Copyright (c) 2001-2003 by the author(s). All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

 Mail::Box::Mbox::Message - one message in a Mbox folder