METHODS

See METHODS in Mail::Reporter

Constructors

$obj->clone( %options )
See clone in Mail::Message.
$class->new( %options )
See new in Mail::Box::Dir::Message.

Constructing a message

$obj->bounce( [<$rg_object|%options>] )
See bounce in Mail::Message::Construct::Bounce.
$class->build( [$message|$part|$body], $content )
See build in Mail::Message::Construct::Build.
$class->buildFromBody( $body, [$head], $headers )
See buildFromBody in Mail::Message::Construct::Build.
$obj->forward( %options )
See forward in Mail::Message::Construct::Forward.
$obj->forwardAttach( %options )
See forwardAttach in Mail::Message::Construct::Forward.
$obj->forwardEncapsulate( %options )
See forwardEncapsulate in Mail::Message::Construct::Forward.
$obj->forwardInline( %options )
See forwardInline in Mail::Message::Construct::Forward.
$obj->forwardNo( %options )
See forwardNo in Mail::Message::Construct::Forward.
$obj->forwardPostlude
See forwardPostlude in Mail::Message::Construct::Forward.
$obj->forwardPrelude
See forwardPrelude in Mail::Message::Construct::Forward.
$obj->forwardSubject( STRING )
See forwardSubject in Mail::Message::Construct::Forward.
$class->read( $fh|STRING|SCALAR|ARRAY, %options )
See read in Mail::Message::Construct::Read.
$obj->rebuild( %options )
See rebuild in Mail::Message::Construct::Rebuild.
$obj->reply( %options )
See reply in Mail::Message::Construct::Reply.
$obj->replyPrelude( [STRING|$field|$address|ARRAY-$of-$things] )
See replyPrelude in Mail::Message::Construct::Reply.
$obj->replySubject( STRING )
$class->replySubject( STRING )
See replySubject in Mail::Message::Construct::Reply.

The message

$obj->container
See container in Mail::Message.
$obj->copyTo( $folder, %options )
See copyTo in Mail::Box::Message.
$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 folder in Mail::Box::Message.
$obj->isDummy
See isDummy in Mail::Message.
$obj->isPart
See isPart in Mail::Message.
$obj->messageId
See messageId in Mail::Message.
$obj->moveTo( $folder, %options )
See moveTo in Mail::Box::Message.
$obj->partNumber
See partNumber in Mail::Message.
$obj->print( [$fh] )
See print in Mail::Message.
$obj->send( [$mailer], %options )
See send in Mail::Message.
$obj->seqnr( [$integer] )
See seqnr in Mail::Box::Message.
$obj->size
See size in Mail::Message.
$obj->toplevel
See toplevel in Mail::Message.
$obj->write( [$fh] )
See write in Mail::Message.

The header

$obj->bcc
See bcc in Mail::Message.
$obj->cc
See cc in Mail::Message.
$obj->date
See date in Mail::Message.
$obj->destinations
See destinations in Mail::Message.
$obj->from
See from in Mail::Message.
$obj->get( $fieldname )
See get in Mail::Message.
$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->nrLines
See nrLines in Mail::Message.
$obj->sender
See sender in Mail::Message.
$obj->study( $fieldname )
See study in Mail::Message.
$obj->subject
See subject in Mail::Message.
$obj->timestamp
See timestamp in Mail::Message.
$obj->to
See to in Mail::Message.

The body

$obj->body( [$body] )
See body in Mail::Message.
$obj->contentType
See contentType in Mail::Message.
$obj->decoded( %options )
See decoded in Mail::Message.
$obj->encode( %options )
See encode in Mail::Message.
$obj->isMultipart
See isMultipart in Mail::Message.
$obj->isNested
See isNested in Mail::Message.
$obj->parts( [<'ALL'|'ACTIVE'|'DELETED'|'RECURSE'|$filter>] )
See parts in Mail::Message.

Flags

$obj->delete
See delete in Mail::Message.
$obj->deleted( [BOOLEAN] )
See deleted in Mail::Message.
$obj->isDeleted
See isDeleted in Mail::Message.
$obj->isModified
See isModified in Mail::Message.
$obj->label( $label|PAIRS )
See label in Mail::Message.
$obj->labels
See labels in Mail::Message.
$obj->labelsToStatus
See labelsToStatus in Mail::Message.
$obj->modified( [BOOLEAN] )
See modified in Mail::Message.
$obj->statusToLabels
See statusToLabels in Mail::Message.

The whole message as text

$obj->file
See file in Mail::Message::Construct::Text.
$obj->lines
See lines in Mail::Message::Construct::Text.
$obj->printStructure( [$fh|undef],[$indent] )
See printStructure in Mail::Message::Construct::Text.
$obj->string
See string in Mail::Message::Construct::Text.

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 clonedFrom in Mail::Message.
$class->coerce( $message, %options )
See coerce in Mail::Message.
$obj->create( $filename )
See create in Mail::Box::Dir::Message.
$obj->diskDelete
See diskDelete in Mail::Box::Message.
$obj->isDelayed
See isDelayed in Mail::Message.
$obj->loadBody
See loadBody in Mail::Box::Dir::Message.
$obj->loadHead
See loadHead in Mail::Box::Dir::Message.
$obj->parser
See parser in Mail::Box::Dir::Message.
$obj->readBody( $parser, $head, [$bodytype] )
See readBody in Mail::Box::Message.
$obj->readFromParser( $parser, [$bodytype] )
See readFromParser in Mail::Message.
$obj->readHead( $parser, [$class] )
See readHead in Mail::Message.
$obj->recursiveRebuildPart( $part, %options )
See recursiveRebuildPart in Mail::Message::Construct::Rebuild.
$obj->storeBody( $body )
See storeBody in Mail::Message.
$obj->takeMessageId( [STRING] )
See takeMessageId in Mail::Message.

Error handling

$obj->AUTOLOAD
See AUTOLOAD in Mail::Message::Construct.
$obj->addReport( $object )
See addReport in Mail::Reporter.
$obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
$class->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
See defaultTrace in Mail::Reporter.
$obj->errors
See errors in Mail::Reporter.
$obj->log( [$level, [$strings]] )
$class->log( [$level, [$strings]] )
See log in Mail::Reporter.
$obj->logPriority( $level )
$class->logPriority( $level )
See logPriority in Mail::Reporter.
$obj->logSettings
See logSettings in Mail::Reporter.
$obj->notImplemented
See notImplemented in Mail::Reporter.
$obj->report( [$level] )
See report in Mail::Reporter.
$obj->reportAll( [$level] )
See reportAll in Mail::Reporter.
$obj->shortSize( [$value] )
$class->shortSize( [$value] )
See shortSize in Mail::Message.
$obj->shortString
See shortString in Mail::Message.
$obj->trace( [$level] )
See trace in Mail::Reporter.
$obj->warnings
See warnings in Mail::Reporter.

Cleanup

$obj->DESTROY
See DESTROY in Mail::Reporter.
$obj->destruct
See destruct in Mail::Box::Message.