Mail::Box::File::Message.3pm

Langue: en

Autres versions - même langue

Version: 2010-07-02 (fedora - 01/12/10)

Section: 3 (Bibliothèques de fonctions)

Sommaire

NAME

Mail::Box::File::Message - one message in a Mbox folder

INHERITANCE

  Mail::Box::File::Message
    is a Mail::Box::Message
    is a Mail::Message
    is a Mail::Reporter
 
  Mail::Box::File::Message is extended by
    Mail::Box::Dbx::Message
    Mail::Box::Mbox::Message

SYNOPSIS

  my $folder  = new Mail::Box::File folder => $ENV{MAIL}, ...;
  my $message = $folder->message(0);

DESCRIPTION

Maintain one message in an file based folder, any Mail::Box::File extension.

METHODS

Constructors

$obj->clone(OPTIONS)
See ``Constructors'' in Mail::Message

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

Messages in file-based folders use the following options for creation:
  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>
  from_line                    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>
  size        Mail::Box::Message  undef
  trace       Mail::Reporter   'WARNINGS'
  trusted     Mail::Message    <false>

. body => OBJECT

. body_type => CODE|CLASS

. deleted => BOOLEAN

. field_type => CLASS

. folder => FOLDER

. from_line => STRING

The line which begins each message in the file. Some people detest this line, but this is just how things were invented...

. head => OBJECT
. head_type => CLASS
. labels => ARRAY|HASH
. log => LEVEL
. messageId => STRING
. modified => BOOLEAN
. 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::File::Message->build([MESSAGE|PART|BODY], CONTENT)

See ``Constructing a message'' in Mail::Message::Construct::Build

Mail::Box::File::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::File::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::File::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->escapedBody

Mbox folders contain multiple messages in one file, using a separator line to keep them apart. Typically, these lines start with ``From ''. Lines within the message could interfere with this separator, and should therefore be translated.
This method will return the escaped text of the body as reference.

$obj->folder([FOLDER])

See ``The message'' in Mail::Box::Message

$obj->fromLine([LINE])

Many people detest file-style folders because they store messages all in one file, where a line starting with "From " leads the header. If we receive a message from a file-based folder, we store that line. If we write to such a file, but there is no such line stored, then we try to generate one.
If LINE is provided, then the starting line is set to this value.

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

Write one message to a file handle. It is the message including the leading 'From ' line and trailing blank. The From-line may interfere with lines in the body: those lines are escaped with an extra '>'.
example:
  $msg->write(\*FILE);    # print the message with encaps to FILE
  $msg->write;            # message with encaps to selected filehandle
  $msg->print(\*FILE);    # the message without encaps.

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::File::Message->coerce(MESSAGE, OPTIONS)

See ``Internals'' in Mail::Message

$obj->diskDelete

See ``Internals'' in Mail::Box::Message

$obj->fileLocation

Returns the location of the whole message including the from-line. In LIST context, both begin and end are returned. In SCALAR context, only the begin is passed back.

$obj->isDelayed

See ``Internals'' in Mail::Message

$obj->loadBody

$obj->moveLocation(DISTANCE)

The message is relocated in the file, being moved over DISTANCE bytes. Setting a new location will update the according information in the header and body.

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

See ``Internals'' in Mail::Box::Message

$obj->readFromParser(PARSER)

Read one message from a Mail::Box::File based folder, including the leading message separator.

$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::File::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::File::Message->log([LEVEL [,STRINGS]])

See ``Error handling'' in Mail::Reporter

$obj->logPriority(LEVEL)

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

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: 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.095, built on July 02, 2010. Website: http://perl.overmeer.net/mailbox/

LICENSE

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