NAME

Mail::Box::Net::Message - one message from a distant folder

INHERITANCE

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

 Mail::Box::Net::Message is extended by
   Mail::Box::IMAP4::Message
   Mail::Box::POP3::Message

SYNOPSIS

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

DESCRIPTION

A Mail::Box::Net::Message represents one message in a folder which can only be accessed via some kind of protocol. On this moment, only a POP3 client is available. IMAP, DBI, and NNTP are other candidates.

METHODS

Constructors

$obj->clone(OPTIONS)

See "Constructors" in Mail::Message

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

 -Option    --Defined in     --Default
  body        Mail::Message    undef
  body_type   Mail::Box::Message  <from folder>
  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                       <unique string>

body => OBJECT
body_type => CODE|CLASS
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: The unique keys which identifies this message on the remote server.

Constructing a message

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

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

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

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

Mail::Box::Net::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::Net::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::Net::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->folder([FOLDER]): See "The message" in Mail::Box::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->unique([STRING|undef]): Returns the name of the file in which this message is actually stored. This will return undef when the message is not stored in a file. When a STRING is specified, a new identifier is stored first.
$obj->write([FILEHANDLE]): See "The message" in Mail::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::Net::Message->coerce(MESSAGE, OPTIONS): See "Internals" in Mail::Message
$obj->diskDelete: See "Internals" in Mail::Box::Message
$obj->isDelayed: See "Internals" in Mail::Message
$obj->loadBody
$obj->readBody(PARSER, HEAD [, BODYTYPE]): See "Internals" in Mail::Box::Message
$obj->readFromParser(PARSER, [BODYTYPE]): See "Internals" in Mail::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::Net::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::Net::Message->log([LEVEL [,STRINGS]])

See "Error handling" in Mail::Reporter

$obj->logPriority(LEVEL)

Mail::Box::Net::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::Net::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

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: 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: Unable to read delayed head.
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

To install Mail::Box, copy and paste the appropriate command in to your terminal.

cpanm

cpanm Mail::Box

CPAN shell

perl -MCPAN -e shell
install Mail::Box

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

INHERITANCE

SYNOPSIS

DESCRIPTION

METHODS

Constructors

Constructing a message

The message

The header

The body

Flags

The whole message as text

Internals

Error handling

Cleanup

DIAGNOSTICS

SEE ALSO

LICENSE

Module Install Instructions