Mail::Box::Dir::Message - one message in a directory organized folder

NAME

Mail::Box::Dir::Message - one message in a directory organized folder

INHERITANCE

 Mail::Box::Dir::Message
   is a Mail::Box::Message
   is a Mail::Message
   is a Mail::Reporter
 Mail::Box::Dir::Message is extended by
   Mail::Box::MH::Message
   Mail::Box::Maildir::Message

SYNOPSIS

 my $folder = new Mail::Box::MH ...
 my $message = $folder->message(10);

DESCRIPTION

A Mail::Box::Dir::Message is a base class for one message in a directory organized folder; each message is stored in a separate file. There are no objects of type Mail::Box::Dir::Message, only extensions are allowed to be created.

At the moment, three of these extended message types are implemented:

METHODS

Constructors

$obj->clone(OPTIONS)

See Constructors in the Mail::Message manpage

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

Create a messages in a directory organized folder.

 Option      Defined in       Default                                                       
 body        L<Mail::Message>  undef                                                         
 body_type   L<Mail::Box::Message>  <from folder>                                                 
 deleted     L<Mail::Message>  <false>                                                       
 field_type  L<Mail::Message>  undef                                                         
 filename                     undef                                                         
 fix_header                   C<false>                                                      
 folder      L<Mail::Box::Message>  <required>                                                    
 head        L<Mail::Message>  undef                                                         
 head_type   L<Mail::Message>  L<Mail::Message::Head::Complete|Mail::Message::Head::Complete>
 labels      L<Mail::Message>  {}                                                            
 log         L<Mail::Reporter>  C<'WARNINGS'>                                                 
 messageId   L<Mail::Message>  undef                                                         
 modified    L<Mail::Message>  <false>                                                       
 size        L<Mail::Box::Message>  undef                                                         
 trace       L<Mail::Reporter>  C<'WARNINGS'>                                                 
 trusted     L<Mail::Message>  <false>

. body OBJECT

. body_type CODE|CLASS

. deleted BOOLEAN

. field_type CLASS

. filename FILENAME

The file where the message is stored in.

. fix_header BOOLEAN

See Mail::Box::new(fix_headers).

. folder FOLDER

. head OBJECT

. head_type CLASS

. labels ARRAY|HASH

. log LEVEL

. messageId STRING

. modified BOOLEAN

. size INTEGER

. trace LEVEL

. trusted BOOLEAN

Constructing a message

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

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

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

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

Mail::Box::Dir::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::Dir::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::Dir::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->filename([FILENAME])

Returns the name of the file in which this message is actually stored. This will return undef when the message is not stored in a file.

$obj->folder([FOLDER])

See The message in the Mail::Box::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 The message in the Mail::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::Dir::Message->coerce(MESSAGE, OPTIONS)

See Internals in the Mail::Message manpage

$obj->create(FILENAME)

Create the message in the specified file. If the message already has a filename and is not modified, then a move is tried. Otherwise the message is printed to the file. If the FILENAME already exists for this message, nothing is done. In any case, the new FILENAME is set as well.

$obj->diskDelete

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

$obj->isDelayed

See Internals in the Mail::Message manpage

$obj->loadBody

This method is called by the autoloader when the body of the message is needed.

$obj->loadHead

This method is called by the autoloader when the header of the message is needed.

$obj->parser

Create and return a parser for this message (-file).

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

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

$obj->readFromParser(PARSER, [BODYTYPE])

See Internals in the Mail::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::Dir::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::Dir::Message->log([LEVEL [,STRINGS]])

See Error handling in the Mail::Reporter manpage

$obj->logPriority(LEVEL)

Mail::Box::Dir::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::Dir::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 create parser for $filename.

For some reason (the previous message have told you already) it was not possible to create a message parser for the specified filename.

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: Cannot write message to $filename: $!

When a modified or new message is written to disk, it is first written to a temporary file in the folder directory. For some reason, it is impossible to create this file.

Error: Failed to move $new to $filename: $!

When a modified or new message is written to disk, it is first written to a temporary file in the folder directory. Then, the new file is moved to replace the existing file. Apparently, the latter fails.

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.

For some reason, the header of the message could be read, but the body cannot. Probably the file has disappeared or the permissions were changed during the progress of the program.

Error: Unable to read delayed head.

Mail::Box tries to be lazy with respect to parsing messages. When a directory organized folder is opened, only the filenames of messages are collected. At first use, the messages are read from their file. Apperently, a message is used for the first time here, but has disappeared or is unreadible for some other reason.

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::Dir::Message - one message in a directory organized folder