NAME

$obj->isDummy

$obj->isPart

$obj->messageId

$obj->print([FILEHANDLE])

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

$obj->size

$obj->toplevel

$obj->write([FILEHANDLE])

The header

$obj->bcc

$obj->cc

$obj->date

$obj->destinations

$obj->from

$obj->get(FIELD)

$obj->guessTimestamp

$obj->head([HEAD])

$obj->nrLines

$obj->sender

$obj->subject

$obj->timestamp

$obj->to

The body

$obj->body([BODY])

$obj->decoded(OPTIONS)

$obj->encode(OPTIONS)

$obj->isMultipart

$obj->isNested

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

The message

$obj->copyTo(FOLDER)

Copy the message to the indicated opened FOLDER, without deleting the original. The coerced message (the copy in the desitnation folder) is returned.

Example:

 my $draft = $mgr->open(folder => 'Draft');
 $message->copyTo($draft);

$obj->folder([FOLDER])

In with folder did we detect this message/dummy? This is a reference to the folder-object.

$obj->moveTo(FOLDER)

Move the message from this folder to the FOLDER specified. This will create a copy using clone() first, and flag this original message to be deleted. So until the source folder is closed, two copies of the message stay in memory. The newly created message (part of the destination folder) is returned.

$obj->seqnr([INTEGER])

Get the number of this message is the current folder. It starts counting from zero. Do not change the number.

Flags

$obj->delete

Flag the message to be deleted. The real deletion only takes place on a synchronization of the folder. See deleted() as well.

The time stamp of the moment of deletion is stored as value. When the same message is deleted more than once, the first time stamp will stay.

Example:

 $message->delete;
 $message->deleted(1);  # exactly the same
 delete $message;

$obj->deleted([BOOLEAN])

Set the delete flag for this message. Without argument, the method returns the same as isDeleted(), which is prefered. When a true value is given, delete() is called.

Example:

 $message->deleted(1);          # delete
 $message->delete;              # delete (prefered)

 $message->deleted(0);          # undelete

 if($message->deleted) {...}    # check
 if($message->isDeleted) {...}  # check (prefered)

$obj->isDeleted

Returns the moment (as the time function returns) when the message was flagged for deletion, or undef when the message is not deleted.

Example:

 next if $message->isDeleted;

 if(my $when = $message->isDeleted) {
    print scalar localtime $when;
 }

$obj->isModified

$obj->label(LABEL [,VALUE [LABEL, VALUE] ])

$obj->labels

$obj->labelsToStatus

$obj->modified([BOOLEAN])

$obj->statusToLabels

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

The whole message as text

$obj->file

$obj->lines

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

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

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

$obj->string

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

Internals

$obj->diskDelete

Remove a message from disk. This is not from the folder, but everything else, like parts of the message which are stored externally from the folder.

$obj->isDelayed

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

Read the body of one message. The PARSER gives access to the folder file. The HEAD has been read with readHead(). The optional BODYTYPE supplies the class name of the body to be created, or a code reference to a routine which can produce a body type based on the head (passed as first argument).

By default, the BODYTYPE will call Mail::Box::determineBodyType() where the message will be added to.

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

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

See "Internals" in Mail::Message::Construct::Rebuild

$obj->recursiveRebuildPart(PART, OPTIONS)

$obj->storeBody(BODY)

$obj->takeMessageId([STRING])

See "METHODS" in Mail::Message::Construct

Error handling

$obj->AUTOLOAD

$obj->defaultTrace([LEVEL, [LEVEL])

Mail::Box::Message->defaultTrace([LEVEL, [LEVEL])

$obj->errors

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

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

$obj->logPriority(LEVEL)

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

$obj->logSettings

$obj->notImplemented

$obj->report([LEVEL])

$obj->reportAll([LEVEL])

$obj->shortString

Convert the message header to a short string, representing the most important facts (for debugging purposes only).

$obj->trace([LEVEL])

$obj->warnings