NAME

Mail::Box::Dbx::Message - one message in a Dbx folder

INHERITANCE 

 Mail::Box::Dbx::Message
   is a Mail::Box::File::Message
   is a Mail::Box::Message
   is a Mail::Message
   is a Mail::Reporter

SYNOPSIS 

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

DESCRIPTION

METHODS

Constructors

$obj->clone(OPTIONS)

See Mail::Message/"Constructors"

Mail::Box::Dbx::Message->new(OPTIONS) 

 Option      --Defined in     --Default
 account_name                   <from dbx_record>
 account_nr                     <from dbx_record>
 body          Mail::Message    undef
 body_type     Mail::Box::Message  <from folder>
 dbx_record                     <required>
 deleted       Mail::Message    <false>
 field_type    Mail::Message    undef
 folder        Mail::Box::Message  <required>
 from_line     Mail::Box::File::Message  undef
 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>
 seen                           <from dbx_record>
 size          Mail::Box::Message  undef
 trace         Mail::Reporter   'WARNINGS'
 trusted       Mail::Message    <false>

. account_name => STRING

The string representation of the account which was used to retreive the message.

. account_nr => INTEGER

The numeric representation of the account which was used to retrieve the message.

. body => OBJECT

. body_type => CODE|CLASS

. dbx_record => Mail::Transport::Dbx::Email

. deleted => BOOLEAN

. field_type => CLASS

. folder => FOLDER

. from_line => STRING

. head => OBJECT

. head_type => CLASS

. labels => ARRAY|HASH

. log => LEVEL

. messageId => STRING

. modified => BOOLEAN

. seen => BOOLEAN

A flag (see label()) which tells wether this message has been read by the user. If read, them message is old, which is the same as seen. Folders store this flag in different ways.

. size => INTEGER

. trace => LEVEL

. trusted => BOOLEAN

Constructing a message

$obj->bounce([RG-OBJECT|OPTIONS])

See Mail::Message::Construct::Bounce/"Constructing a message"

Mail::Box::Dbx::Message->build([MESSAGE|PART|BODY], CONTENT)

See Mail::Message::Construct::Build/"Constructing a message"

Mail::Box::Dbx::Message->buildFromBody(BODY, [HEAD], HEADERS)

See Mail::Message::Construct::Build/"Constructing a message"

$obj->forward(OPTIONS)

See Mail::Message::Construct::Forward/"Constructing a message"

$obj->forwardAttach(OPTIONS)

See Mail::Message::Construct::Forward/"Constructing a message"

$obj->forwardEncapsulate(OPTIONS)

See Mail::Message::Construct::Forward/"Constructing a message"

$obj->forwardInline(OPTIONS)

See Mail::Message::Construct::Forward/"Constructing a message"

$obj->forwardNo(OPTIONS)

See Mail::Message::Construct::Forward/"Constructing a message"

$obj->forwardPostlude

See Mail::Message::Construct::Forward/"Constructing a message"

$obj->forwardPrelude

See Mail::Message::Construct::Forward/"Constructing a message"

$obj->forwardSubject(STRING)

See Mail::Message::Construct::Forward/"Constructing a message"

Mail::Box::Dbx::Message->read(FILEHANDLE|SCALAR|REF-SCALAR|ARRAY-OF-LINES, OPTIONS)

See Mail::Message::Construct::Read/"Constructing a message"

$obj->rebuild(OPTIONS)

See Mail::Message::Construct::Rebuild/"Constructing a message"

$obj->reply(OPTIONS)

See Mail::Message::Construct::Reply/"Constructing a message"

$obj->replyPrelude([STRING|FIELD|ADDRESS|ARRAY-OF-THINGS])

See Mail::Message::Construct::Reply/"Constructing a message"

$obj->replySubject(STRING)

Mail::Box::Dbx::Message->replySubject(STRING)

See Mail::Message::Construct::Reply/"Constructing a message"

The message

$obj->container

See Mail::Message/"The message"

$obj->copyTo(FOLDER, OPTIONS)

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

$obj->dbxRecord

Returns the Mail::Transport::Dbx::Email record of the message.

$obj->escapedBody

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

$obj->folder([FOLDER])

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

$obj->fromLine([LINE])

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

$obj->isDummy

See Mail::Message/"The message"

$obj->isPart

See Mail::Message/"The message"

$obj->messageId

See Mail::Message/"The message"

$obj->moveTo(FOLDER, OPTIONS)

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

$obj->print([FILEHANDLE])

See Mail::Message/"The message"

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

See Mail::Message/"The message"

$obj->seqnr([INTEGER])

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

$obj->size

See Mail::Message/"The message"

$obj->toplevel

See Mail::Message/"The message"

$obj->write([FILEHANDLE])

See Mail::Box::File::Message/"METHODS"

The header

$obj->bcc

See Mail::Message/"The header"

$obj->cc

See Mail::Message/"The header"

$obj->date

See Mail::Message/"The header"

$obj->destinations

See Mail::Message/"The header"

$obj->from

See Mail::Message/"The header"

$obj->get(FIELDNAME)

See Mail::Message/"The header"

$obj->guessTimestamp

See Mail::Message/"The header"

$obj->head([HEAD])

See Mail::Message/"The header"

$obj->nrLines

See Mail::Message/"The header"

$obj->sender

See Mail::Message/"The header"

$obj->study(FIELDNAME)

See Mail::Message/"The header"

$obj->subject

See Mail::Message/"The header"

$obj->timestamp

See Mail::Message/"The header"

$obj->to

See Mail::Message/"The header"

The body

$obj->body([BODY])

See Mail::Message/"The body"

$obj->contentType

See Mail::Message/"The body"

$obj->decoded(OPTIONS)

See Mail::Message/"The body"

$obj->encode(OPTIONS)

See Mail::Message/"The body"

$obj->isMultipart

See Mail::Message/"The body"

$obj->isNested

See Mail::Message/"The body"

$obj->parts(['ALL'|'ACTIVE'|'DELETED'|'RECURSE'|FILTER])

See Mail::Message/"The body"

Flags

$obj->delete

See Mail::Message/"Flags"

$obj->deleted([BOOLEAN])

See Mail::Message/"Flags"

$obj->isDeleted

See Mail::Message/"Flags"

$obj->isModified

See Mail::Message/"Flags"

$obj->label(LABEL|PAIRS)

See Mail::Message/"Flags"

$obj->labels

See Mail::Message/"Flags"

$obj->labelsToStatus

See Mail::Message/"Flags"

$obj->modified([BOOLEAN])

See Mail::Message/"Flags"

$obj->statusToLabels

See Mail::Message/"Flags"

The whole message as text

$obj->file

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

$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

See Mail::Message/"Internals"

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

See Mail::Message/"Internals"

$obj->diskDelete

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

$obj->fileLocation

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

$obj->isDelayed

See Mail::Message/"Internals"

$obj->loadBody

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

$obj->moveLocation(DISTANCE)

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

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

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

$obj->readFromParser(PARSER)

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

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

See Mail::Message/"Internals"

$obj->recursiveRebuildPart(PART, OPTIONS)

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

$obj->storeBody(BODY)

See Mail::Message/"Internals"

$obj->takeMessageId([STRING])

See Mail::Message/"Internals"

Error handling

$obj->AUTOLOAD

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

$obj->addReport(OBJECT)

See Mail::Reporter/"Error handling"

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

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

See Mail::Reporter/"Error handling"

$obj->errors

See Mail::Reporter/"Error handling"

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

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

See Mail::Reporter/"Error handling"

$obj->logPriority(LEVEL)

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

See Mail::Reporter/"Error handling"

$obj->logSettings

See Mail::Reporter/"Error handling"

$obj->notImplemented

See Mail::Reporter/"Error handling"

$obj->report([LEVEL])

See Mail::Reporter/"Error handling"

$obj->reportAll([LEVEL])

See Mail::Reporter/"Error handling"

$obj->shortSize([VALUE])

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

See Mail::Message/"Error handling"

$obj->shortString

See Mail::Message/"Error handling"

$obj->trace([LEVEL])

See Mail::Reporter/"Error handling"

$obj->warnings

See Mail::Reporter/"Error handling"

Cleanup

$obj->DESTROY

See Mail::Message/"Cleanup"

$obj->destruct

See Mail::Box::Message/"Cleanup"

$obj->inGlobalDestruction

See Mail::Reporter/"Cleanup"

The flags

$obj->accountName

Returns the Outlook Express account name which was used to retreive this message, represented as a string. The accountNr() returns a numerical representation of the same fact.

$obj->accountNr

Returns the Outlook Express account name which was used to retreive this message, represented as a number. The accountName() returns a string representation of the same fact.

DETAILS

DIAGNOSTICS

Error: Cannot coerce a $class object into a $class object

Error: Cannot include forward source as $include.

Unknown alternative for the forward(include). Valid choices are NO, INLINE, ATTACH, and ENCAPSULATE.

Error: Cannot include reply source as $include.

Unknown alternative for the include option of reply(). Valid choices are NO, INLINE, and ATTACH.

Error: Dbx record required to create the message.

Error: Method bounce requires To, Cc, or Bcc

The message bounce() method forwards a received message off to someone else without modification; you must specified it's new destination. If you have the urge not to specify any destination, you probably are looking for reply(). When you wish to modify the content, use forward().

Error: Method forwardAttach requires a preamble

Error: Method forwardEncapsulate requires a preamble

Error: No address to create forwarded to.

If a forward message is created, a destination address must be specified.

Error: No default mailer found to send message.

The message send() mechanism had not enough information to automatically find a mail transfer agent to sent this message. Specify a mailer explicitly using the via options.

Error: No rebuild rule $name defined.

Error: Only build() Mail::Message's; they are not in a folder yet

You may wish to construct a message to be stored in a some kind of folder, but you need to do that in two steps. First, create a normal Mail::Message, and then add it to the folder. During this Mail::Box::addMessage() process, the message will get coerce()-d into the right message type, adding storage information and the like.

Error: Package $package does not implement $method.

Fatal error: the specific package (or one of its superclasses) does not implement this method where it should. This message means that some other related classes do implement this method however the class at hand does not. Probably you should investigate this and probably inform the author of the package.

Error: Unable to read delayed body.

Error: coercion starts with some object

SEE ALSO

This module is part of Mail-Box distribution version 2.082, built on April 28, 2008. Website: http://perl.overmeer.net/mailbox/

LICENSE

Copyrights 2001-2008 by Mark Overmeer. For other contributors see ChangeLog.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See http://www.perl.com/perl/misc/Artistic.html