NAME

Mail::Box::IMAP4::Message - one message on a IMAP4 server

INHERITANCE

 Mail::Box::IMAP4::Message
   is a Mail::Box::Net::Message
   is a Mail::Box::Message
   is a Mail::Message
   is a Mail::Reporter

SYNOPSIS

 my $folder = new Mail::Box::IMAP4 ...
 my $message = $folder->message(10);

DESCRIPTION

A "Mail::Box::IMAP4::Message" represents one message on a IMAP4 server, maintained by a Mail::Box::IMAP4 folder. Each message is stored as separate entity on the server, and maybe temporarily in your program as well.

Extends "DESCRIPTION" in Mail::Box::Net::Message.

METHODS

Extends "METHODS" in Mail::Box::Net::Message.

Constructors

Extends "Constructors" in Mail::Box::Net::Message.

$obj->clone(%options)

Inherited, see "Constructors" in Mail::Message

Mail::Box::IMAP4::Message->new(%options)

 -Option      --Defined in             --Default
  body          Mail::Message            undef
  body_type     Mail::Box::Message       Mail::Message::Body::Lines
  cache_body                             <false>
  cache_head                             <false>
  cache_labels                           <false>
  deleted       Mail::Message            <false>
  field_type    Mail::Message            undef
  folder        Mail::Box::Message       <required>
  head          Mail::Message            undef
  head_type     Mail::Message            Mail::Message::Head::Complete
  labels        Mail::Message            {}
  log           Mail::Reporter           'WARNINGS'
  messageId     Mail::Message            undef
  modified      Mail::Message            <false>
  size          Mail::Box::Message       undef
  trace         Mail::Reporter           'WARNINGS'
  trusted       Mail::Message            <false>
  unique        Mail::Box::Net::Message  <unique string>
  write_labels                           <true>

body => OBJECT
body_type => CODE|CLASS
cache_body => BOOLEAN
cache_head => BOOLEAN
cache_labels => BOOLEAN: All standard IMAP labels can be cached on the local server to improve speed. This has the same dangers as setting "write_labels" to false. The caching starts when the first label of the message was read.
deleted => BOOLEAN
field_type => CLASS
folder => FOLDER
head => OBJECT
head_type => CLASS
labels => ARRAY|HASH
log => LEVEL
messageId => STRING
modified => BOOLEAN
size => INTEGER
trace => LEVEL
trusted => BOOLEAN
unique => STRING
write_labels => BOOLEAN: When a label is changed or its value read, using label(), that info should be sent to the IMAP server. But, this action could be superfluous, for instance because the label was already set or clear, and communication is expensive. On the other hand, someone else may use IMAP to make changes in the same folder, and will get the updates too late or never...

Constructing a message

Extends "Constructing a message" in Mail::Box::Net::Message.

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

The message

Extends "The message" in Mail::Box::Net::Message.

$obj->container(): Inherited, see "The message" in Mail::Message
$obj->copyTo($folder, %options): Inherited, see "The message" in Mail::Box::Message
$obj->folder( [$folder] ): Inherited, see "The message" in Mail::Box::Message
$obj->isDummy(): Inherited, see "The message" in Mail::Message
$obj->isPart(): Inherited, see "The message" in Mail::Message
$obj->messageId(): Inherited, see "The message" in Mail::Message
$obj->moveTo($folder, %options): Inherited, see "The message" in Mail::Box::Message
$obj->partNumber(): Inherited, see "The message" in Mail::Message
$obj->print( [$fh] ): Inherited, see "The message" in Mail::Message
$obj->send( [$mailer], %options ): Inherited, see "The message" in Mail::Message
$obj->seqnr( [$integer] ): Inherited, see "The message" in Mail::Box::Message
$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(): Inherited, see "The message" in Mail::Message
$obj->unique( [STRING|undef] ): Inherited, see "The message" in Mail::Box::Net::Message
$obj->write( [$fh] ): Inherited, see "The message" in Mail::Message

The header

Extends "The header" in Mail::Box::Net::Message.

$obj->bcc(): Inherited, see "The header" in Mail::Message
$obj->cc(): Inherited, see "The header" in Mail::Message
$obj->date(): Inherited, see "The header" in Mail::Message
$obj->destinations(): Inherited, see "The header" in Mail::Message
$obj->from(): Inherited, see "The header" in Mail::Message
$obj->get($fieldname): Inherited, see "The header" in Mail::Message
$obj->guessTimestamp(): Inherited, see "The header" in Mail::Message
$obj->head( [$head] ): Inherited, see "The header" in Mail::Message
$obj->nrLines(): Inherited, see "The header" in Mail::Message
$obj->sender(): Inherited, see "The header" in Mail::Message
$obj->study($fieldname): Inherited, see "The header" in Mail::Message
$obj->subject(): Inherited, see "The header" in Mail::Message
$obj->timestamp(): Inherited, see "The header" in Mail::Message
$obj->to(): Inherited, see "The header" in Mail::Message

The body

Extends "The body" in Mail::Box::Net::Message.

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

Flags

Extends "Flags" in Mail::Box::Net::Message.

$obj->delete(): Inherited, see "Flags" in Mail::Message
$obj->deleted( [BOOLEAN] ): Inherited, see "Flags" in Mail::Message
$obj->isDeleted(): Inherited, see "Flags" in Mail::Message
$obj->isModified(): Inherited, see "Flags" in Mail::Message
$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 immediately 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(): Inherited, see "Flags" in Mail::Message
$obj->modified( [BOOLEAN] ): Inherited, see "Flags" in Mail::Message
$obj->statusToLabels(): Inherited, see "Flags" in Mail::Message

The whole message as text

Extends "The whole message as text" in Mail::Box::Net::Message.

$obj->file(): Inherited, see "The whole message as text" in Mail::Message::Construct::Text
$obj->lines(): Inherited, see "The whole message as text" in Mail::Message::Construct::Text
$obj->printStructure( [$fh|undef],[$indent] ): Inherited, see "The whole message as text" in Mail::Message::Construct::Text
$obj->string(): Inherited, see "The whole message as text" in Mail::Message::Construct::Text