/ 
Mail-Box-2.088
River stage one • 8 direct dependents • 8 total dependents
/ Mail::Box::Dbx::Message

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)

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

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

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

$obj->forward(OPTIONS)

$obj->forwardAttach(OPTIONS)

$obj->forwardEncapsulate(OPTIONS)

$obj->forwardInline(OPTIONS)

$obj->forwardNo(OPTIONS)

$obj->forwardPostlude

$obj->forwardPrelude

$obj->forwardSubject(STRING)

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

$obj->rebuild(OPTIONS)

$obj->reply(OPTIONS)

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

$obj->replySubject(STRING)

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

The message

$obj->container

$obj->copyTo(FOLDER, OPTIONS)

$obj->dbxRecord

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

$obj->escapedBody

$obj->folder([FOLDER])

$obj->fromLine([LINE])

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

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)

$obj->labels

$obj->labelsToStatus

$obj->modified([BOOLEAN])

$obj->statusToLabels

The whole message as text

$obj->file

$obj->lines

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

$obj->string

Internals

$obj->clonedFrom

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

$obj->diskDelete

$obj->fileLocation

$obj->isDelayed

$obj->loadBody

$obj->moveLocation(DISTANCE)

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

$obj->readFromParser(PARSER)

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

$obj->recursiveRebuildPart(PART, OPTIONS)

$obj->storeBody(BODY)

$obj->takeMessageId([STRING])

Error handling

$obj->AUTOLOAD

$obj->addReport(OBJECT)

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

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

$obj->errors

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

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

$obj->logPriority(LEVEL)

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

$obj->logSettings

$obj->notImplemented

$obj->report([LEVEL])

$obj->reportAll([LEVEL])

$obj->shortSize([VALUE])

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

$obj->shortString

$obj->trace([LEVEL])

$obj->warnings

Cleanup

$obj->DESTROY

$obj->destruct

$obj->inGlobalDestruction

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.088, built on March 19, 2009. Website: http://perl.overmeer.net/mailbox/

LICENSE

Copyrights 2001-2009 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