NAME

$obj->copyTo(FOLDER, OPTIONS)

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

Option        Defined in       Default
shallow                        <false>
shallow_body                   <false>
shallow_head                   <false>
share                          <false>

. shallow BOOLEAN

Used for clone(shallow).

. shallow_body BOOLEAN

Used for clone(shallow_body).

. shallow_head BOOLEAN

Used for clone(shallow_head).

. share BOOLEAN

Try to share the physical storage of the message between the two folders. Sometimes, they even may be of different types. When not possible, this options will be silently ignored.

Example:

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

$obj->folder([FOLDER])

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

$obj->isDummy

$obj->isPart

$obj->messageId

$obj->moveTo(FOLDER, OPTIONS)

Move the message from this folder to the FOLDER specified. This will create a copy using clone() first. Then, this original message is flagged to get deleted. So until the source folder is closed, two copies of the message may stay in memory.

The newly created message clone (part of the destination folder) is returned. All OPTIONS are passed to copyTo()

Option        Defined in       Default                          
shallow_body                   <undef>                          
share                          <true unless shallow_body exists>

. shallow_body BOOLEAN

Only create a shallow body, which means that the header can not be reused. A message can therefore not be shared in storage unless explicitly stated.

. share BOOLEAN

When there is a chance that the original message can be undeleted, then this must be set to false. Otherwise a shallow clone will be made, which will share the header which can be modified in the undeleted message.

Example: of moving a message

my $t = $msg->moveTo('trash');

is equivalent to

my $t = $msg->copyTo('trash', share => 1);
$msg->delete;

$obj->print([FILEHANDLE])

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

$obj->seqnr([INTEGER])

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

$obj->size

$obj->toplevel

$obj->write([FILEHANDLE])

The header

$obj->bcc

$obj->cc

$obj->date

$obj->destinations

$obj->from

$obj->get(FIELDNAME)

$obj->guessTimestamp

$obj->head([HEAD])

$obj->nrLines

$obj->sender

$obj->study(FIELDNAME)

$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])

Flags

$obj->delete

$obj->deleted([BOOLEAN])

$obj->isDeleted

$obj->isModified

$obj->label(LABEL|PAIRS)

$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|undef],[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->clonedFrom

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

$obj->diskDelete

Remove a message from disk. This is not from the folder, but everything else, like parts of the message which are stored outside 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->addReport(OBJECT)

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

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

$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->shortSize([VALUE])

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

See "Error handling" in Mail::Message

$obj->shortString

See "Error handling" in Mail::Message

$obj->trace([LEVEL])

$obj->warnings