NAME

$obj->copyTo(FOLDER, OPTIONS)

$obj->folder([FOLDER])

$obj->isDummy

$obj->isPart

$obj->messageId

$obj->moveTo(FOLDER, OPTIONS)

$obj->print([FILEHANDLE])

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

$obj->seqnr([INTEGER])

$obj->size

Returns the size of this message. If the message is still on the remote server, IMAP is used to ask for the size. When the message is already loaded onto the local system, the size of the parsed message is taken. These sizes can differ because the difference in line-ending representation.

$obj->toplevel

See Mail::Box::Net::Message/"The message"

$obj->unique([STRING|undef])

$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->contentType

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

With only one argument, the value related to LABEL is returned. With more that one argument, the list is interpreted a label-value PAIRS to be set.

The IMAP protocol defines its own names for the labels, which must be set imediately to inform other IMAP clients which may have the same folder open. But that can be changed with new(write_labels). Some labels are translated to the corresponding IMAP system labels.

$obj->labels

Get the names of all labels (LIST context, not efficient in IMAP4), or a reference to a hash with labels. You should only use the returned hash to read the labels, because changes made to it will not be passed to the remote server. See labels() to set values.

$obj->labelsToStatus

$obj->modified([BOOLEAN])

$obj->statusToLabels

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

The whole message as text

$obj->file

$obj->lines

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

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

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

$obj->string

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

Internals

$obj->clonedFrom

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

$obj->diskDelete

See Mail::Box::Message/"Internals"

$obj->fetch([INFO, ...])

Use the IMAP's UID FETCH IMAP command to get some data about this message. The INFO request is passed to Mail::Box::IMAP4::fetch(). Without INFO, ALL information is retreived and returned as a HASH.

$obj->isDelayed

$obj->loadBody

See Mail::Box::Net::Message/"Internals"

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

See Mail::Box::Message/"Internals"

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

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

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

$obj->recursiveRebuildPart(PART, OPTIONS)

$obj->storeBody(BODY)

$obj->takeMessageId([STRING])

$obj->writeDelayed(IMAP)

Write all delayed information, like label changes, to the server. This is done under force, so should even be done for folders opened without write-access. This method is called indirectly by a Mail::Box::write() or Mail::Box::close().

The IMAP argument is a Mail::IMAPClient which has the right folder already selected.

Writing changes to the remote folder is not without hassle: IMAP4 (or is it only Mail::IMAPClient doesn't support replacing header or body. Therefore, when either of them change, the whole message is rewritten to the server (which is supported), and the original flagged for deletion.

Error handling

$obj->AUTOLOAD

See Mail::Message::Construct/"METHODS"

$obj->addReport(OBJECT)

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

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

$obj->errors

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

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

$obj->logPriority(LEVEL)

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

$obj->logSettings

$obj->notImplemented

$obj->report([LEVEL])

$obj->reportAll([LEVEL])

$obj->shortSize([VALUE])

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

See Mail::Message/"Error handling"

$obj->shortString

See Mail::Message/"Error handling"

$obj->trace([LEVEL])

$obj->warnings