Index

NAME
INHERITANCE
SYNOPSIS
METHODS
DIAGNOSTICS
SEE ALSO
LICENSE

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

METHODS

Constructors

$obj->clone(OPTIONS)

See "Constructors" in Mail::Message

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 "Constructing a message" in Mail::Message::Construct::Bounce
Mail::Box::Dbx::Message->build([MESSAGE|PART|BODY], CONTENT): See "Constructing a message" in Mail::Message::Construct::Build
Mail::Box::Dbx::Message->buildFromBody(BODY, [HEAD], HEADERS): See "Constructing a message" in Mail::Message::Construct::Build
$obj->forward(OPTIONS): See "Constructing a message" in Mail::Message::Construct::Forward
$obj->forwardAttach(OPTIONS): See "Constructing a message" in Mail::Message::Construct::Forward
$obj->forwardEncapsulate(OPTIONS): See "Constructing a message" in Mail::Message::Construct::Forward
$obj->forwardInline(OPTIONS): See "Constructing a message" in Mail::Message::Construct::Forward
$obj->forwardNo(OPTIONS): See "Constructing a message" in Mail::Message::Construct::Forward
$obj->forwardPostlude: See "Constructing a message" in Mail::Message::Construct::Forward
$obj->forwardPrelude: See "Constructing a message" in Mail::Message::Construct::Forward
$obj->forwardSubject(STRING): See "Constructing a message" in Mail::Message::Construct::Forward
Mail::Box::Dbx::Message->read(FILEHANDLE|SCALAR|REF-SCALAR|ARRAY-OF-LINES, OPTIONS): See "Constructing a message" in Mail::Message::Construct::Read
$obj->rebuild(OPTIONS): See "Constructing a message" in Mail::Message::Construct::Rebuild
$obj->reply(OPTIONS): See "Constructing a message" in Mail::Message::Construct::Reply
$obj->replyPrelude([STRING|FIELD|ADDRESS|ARRAY-OF-THINGS]): See "Constructing a message" in Mail::Message::Construct::Reply
$obj->replySubject(STRING)
Mail::Box::Dbx::Message->replySubject(STRING): See "Constructing a message" in Mail::Message::Construct::Reply

The message

$obj->container: See "The message" in Mail::Message
$obj->copyTo(FOLDER, OPTIONS): See "The message" in Mail::Box::Message
$obj->dbxRecord: Returns the Mail::Transport::Dbx::Email record of the message.
$obj->escapedBody: See "The message" in Mail::Box::File::Message
$obj->folder([FOLDER]): See "The message" in Mail::Box::Message
$obj->fromLine([LINE]): See "The message" in Mail::Box::File::Message
$obj->isDummy: See "The message" in Mail::Message
$obj->isPart: See "The message" in Mail::Message
$obj->messageId: See "The message" in Mail::Message
$obj->moveTo(FOLDER, OPTIONS): See "The message" in Mail::Box::Message
$obj->print([FILEHANDLE]): See "The message" in Mail::Message
$obj->send([MAILER], OPTIONS): See "The message" in Mail::Message
$obj->seqnr([INTEGER]): See "The message" in Mail::Box::Message
$obj->size: See "The message" in Mail::Message
$obj->toplevel: See "The message" in Mail::Message
$obj->write([FILEHANDLE]): See "METHODS" in Mail::Box::File::Message

The header

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

The body

$obj->body([BODY]): See "The body" in Mail::Message
$obj->contentType: See "The body" in Mail::Message
$obj->decoded(OPTIONS): See "The body" in Mail::Message
$obj->encode(OPTIONS): See "The body" in Mail::Message
$obj->isMultipart: See "The body" in Mail::Message
$obj->isNested: See "The body" in Mail::Message
$obj->parts(['ALL'|'ACTIVE'|'DELETED'|'RECURSE'|FILTER]): See "The body" in Mail::Message

Flags

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

The whole message as text

$obj->file: See "The whole message as text" in Mail::Message::Construct::Text
$obj->lines: See "The whole message as text" in Mail::Message::Construct::Text
$obj->printStructure([FILEHANDLE|undef],[INDENT]): See "The whole message as text" in Mail::Message::Construct::Text
$obj->string: See "The whole message as text" in Mail::Message::Construct::Text

Internals

$obj->clonedFrom: See "Internals" in Mail::Message
Mail::Box::Dbx::Message->coerce(MESSAGE, OPTIONS): See "Internals" in Mail::Message
$obj->diskDelete: See "Internals" in Mail::Box::Message
$obj->fileLocation: See "Internals" in Mail::Box::File::Message
$obj->isDelayed: See "Internals" in Mail::Message
$obj->loadBody: See "Internals" in Mail::Box::File::Message
$obj->moveLocation(DISTANCE): See "Internals" in Mail::Box::File::Message
$obj->readBody(PARSER, HEAD [, BODYTYPE]): See "Internals" in Mail::Box::Message
$obj->readFromParser(PARSER): See "Internals" in Mail::Box::File::Message
$obj->readHead(PARSER [,CLASS]): See "Internals" in Mail::Message
$obj->recursiveRebuildPart(PART, OPTIONS): See "Internals" in Mail::Message::Construct::Rebuild
$obj->storeBody(BODY): See "Internals" in Mail::Message
$obj->takeMessageId([STRING]): See "Internals" in Mail::Message

Error handling

$obj->AUTOLOAD: See "METHODS" in Mail::Message::Construct
$obj->addReport(OBJECT): See "Error handling" in Mail::Reporter
$obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
Mail::Box::Dbx::Message->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK]): See "Error handling" in Mail::Reporter
$obj->errors: See "Error handling" in Mail::Reporter
$obj->log([LEVEL [,STRINGS]])
Mail::Box::Dbx::Message->log([LEVEL [,STRINGS]]): See "Error handling" in Mail::Reporter
$obj->logPriority(LEVEL)
Mail::Box::Dbx::Message->logPriority(LEVEL): See "Error handling" in Mail::Reporter
$obj->logSettings: See "Error handling" in Mail::Reporter
$obj->notImplemented: See "Error handling" in Mail::Reporter
$obj->report([LEVEL]): See "Error handling" in Mail::Reporter
$obj->reportAll([LEVEL]): See "Error handling" in Mail::Reporter
$obj->shortSize([VALUE])
Mail::Box::Dbx::Message->shortSize([VALUE]): See "Error handling" in Mail::Message
$obj->shortString: See "Error handling" in Mail::Message
$obj->trace([LEVEL]): See "Error handling" in Mail::Reporter
$obj->warnings: See "Error handling" in Mail::Reporter

Cleanup

$obj->DESTROY: See "Cleanup" in Mail::Message
$obj->destruct: See "Cleanup" in Mail::Box::Message
$obj->inGlobalDestruction: See "Cleanup" in Mail::Reporter

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.

DIAGNOSTICS

Error: Cannot coerce a $class object into a $class object
Error: Cannot include forward source as $include.: Unknown alternative for the forward(include) ("Constructing a message" in Mail::Message::Construct::Forward). Valid choices are NO, INLINE, ATTACH, and ENCAPSULATE.
Error: Cannot include reply source as $include.: Unknown alternative for the include option of reply() ("Constructing a message" in Mail::Message::Construct::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() ("Constructing a message" in Mail::Message::Construct::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() ("Constructing a message" in Mail::Message::Construct::Reply). When you wish to modify the content, use forward() ("Constructing a message" in Mail::Message::Construct::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

LICENSE

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