NAME

$obj->copyTo(FOLDER, OPTIONS)

$obj->folder([FOLDER])

$obj->fromLine([LINE])

Many people detest file-style folders because they store messages all in one file, where a line starting with From leads the header. If we receive a message from a file-based folder, we store that line. If we write to such a file, but there is no such line stored, then we try to generate one.

If LINE is provided, then the starting line is set to this value.

$obj->isDummy

$obj->isPart

$obj->messageId

$obj->moveTo(FOLDER, OPTIONS)

$obj->print([FILEHANDLE])

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

$obj->seqnr([INTEGER])

$obj->size

$obj->toplevel

$obj->write([FILEHANDLE])

Write one message to a file handle. It is the message including the leading 'From ' line and trailing blank. The From-line may interfere with lines in the body: those lines are escaped with an extra '>'.

Example:

 $msg->write(\*FILE);    # print the message with encaps to FILE
 $msg->write;            # message with encaps to selected filehandle
 $msg->print(\*FILE);    # the message without encaps.

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 the Mail::Message::Construct::Text manpage

The whole message as text

$obj->file

$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

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

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

$obj->diskDelete

$obj->fileLocation

Returns the location of the whole message including the from-line. In LIST context, both begin and end are returned. In SCALAR context, only the begin is passed back.

$obj->isDelayed

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

$obj->loadBody

$obj->moveLocation(DISTANCE)

The message is relocated in the file, being moved over DISTANCE bytes. Setting a new location will update the according information in the header and body.

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

$obj->readFromParser(PARSER)

Read one message from a Mail::Box::File based folder, including the message separator.

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

See Internals in the Mail::Message::Construct::Rebuild manpage

$obj->recursiveRebuildPart(PART, OPTIONS)

$obj->storeBody(BODY)

$obj->takeMessageId([STRING])

See METHODS in the Mail::Message::Construct manpage

Error handling

$obj->AUTOLOAD

$obj->addReport(OBJECT)

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

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

$obj->errors

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

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

$obj->logPriority(LEVEL)

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

$obj->logSettings

$obj->notImplemented

$obj->report([LEVEL])

$obj->reportAll([LEVEL])

See Error handling in the Mail::Message manpage

$obj->shortSize([VALUE])

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

$obj->shortString

See Error handling in the Mail::Message manpage

$obj->trace([LEVEL])

$obj->warnings