• NAME
• INHERITANCE
• SYNOPSIS
• DESCRIPTION
• METHODS
• Constructors
• Constructing a message
• The message
• The header
• The body
• Flags
• The whole message as text
• Labels
• Internals
• Error handling
• Cleanup
• DIAGNOSTICS
• DETAILS
• Labels
• Flags in filename
• REFERENCES
• COPYRIGHTS

NAME

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

INHERITANCE

 Mail::Box::Maildir::Message
   is a Mail::Box::Dir::Message
   is a Mail::Box::Message
   is a Mail::Message
   is a Mail::Reporter

SYNOPSIS

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

DESCRIPTION

A Mail::Box::Maildir::Message represents one message in an Mail::Box::Maildir folder. Each message is stored in a separate file.

METHODS

Constructors

$obj->clone(OPTIONS)

See Constructors in the Mail::Message manpage

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

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

Constructing a message

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

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

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

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

Mail::Box::Maildir::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::Maildir::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::Maildir::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 current filename for this message. If the FILENAME argument is specified, a new filename will be set. For maildir messages this means that modifications are immediately performed: there will be a rename (move) from the old name to the new name. Labels may change within in the message object as well.

$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

The filename of a Mail::Box::Maildir::Message contains a timestamp. This is a wild guess about the actual time of sending of the message: it is the time of receipt which may be seconds to hours off. But is still a good guess... When the message header is not parsed, then this date is used.

$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

Labels

$obj->labelsToFilename

When the labels on a message change, this may implicate a change in the message's filename. The change will take place immediately. The new filename (which may be the same as the old filename) is returned. undef is returned when the rename is required but fails.

Internals

$obj->accept([BOOLEAN])

Accept a message for the folder. This will move it from the new or tmp sub-directories into the cur sub-directory (or back when the BOOLEAN is false). When you accept an already accepted message, nothing will happen.

$obj->clonedFrom

See Internals in the Mail::Message manpage

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

See Internals in the Mail::Message manpage

$obj->create(FILENAME)

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

$obj->diskDelete

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

$obj->isDelayed

See Internals in the Mail::Message manpage

$obj->loadBody

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

$obj->loadHead

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

$obj->parser

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

$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::Maildir::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::Maildir::Message->log([LEVEL [,STRINGS]])

See Error handling in the Mail::Reporter manpage

$obj->logPriority(LEVEL)

Mail::Box::Maildir::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::Maildir::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

Labels

Flags in filename

When new messages arrive on system and have to be stored in a maildir folder, they are put in the new sub-directory of the folder (first created in the tmp sub-directory and then immediately moved to new). The following information was found at http://cr.yp.to/proto/maildir.html.

Each message is written in a separate file. The filename is constructed from the time-of-arrival, a hostname, an unique component, a syntax marker, and flags. For example 1014220791.meteor.42:2,DF. The filename must match:

 my ($time, $unique, $hostname, $info)
    = $filename =~ m!^(\d+)\.(.*)\.(\w+)(\:.*)?$!;
 my ($semantics, $flags)
    = $info =~ m!([12])\,([DFPRST]*)$!;
 my @flags = split //, $flags;

When an application opens the folder, there may be messages in new which are new arival, and messages in cur. The latter are labeled accepted. To move a message from new to cur, you have two options with the same effect:

  $msg->accept;
  $msg->label(accept => 1);

See accept(), label(), Mail::Box::Maildir::new(accept_new), and Mail::Box::Maildir::acceptMessages()

The messages are moved, and their name is immediately extended with flags. An example:

 new/897979431.meteor.42      may become
 cur/897979431.meteor.42:2,FS

The added characters ':2,' refer to the ``second state of processing'', where the message has been inspected. And the characters (which should be in alphabetic order) mean

 D      => draft
 F      => flagged
 R      => replied  (answered)
 S      => seen
 T      => deleted  (tagged for deletion)

Some maildir clients support P => passed (resent/forwarded/bounced to someone else)

The flags will immediately change when label() or delete() is used, which differs from other message implementations: maildir is stateless, and should not break when applications crash.

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.