/ 
Mail-Box-2.092
River stage one • 8 direct dependents • 8 total dependents
/ Mail::Box::Message::Destructed

NAME

Mail::Box::Message::Destructed - a destructed message

INHERITANCE

Mail::Box::Message::Destructed
  is a Mail::Box::Message
  is a Mail::Message
  is a Mail::Reporter

SYNOPSIS

$folder->message(3)->destruct;

DESCRIPTION

When a message folder is read, each message will be parsed into Perl structures. Especially the header structure can consume a huge amount of memory (message bodies can be moved to external temporary files). Destructed messages have forcefully cleaned-up all header and body information, and are therefore much smaller. Some useful information is still in the object.

BE WARNED: once a message is destructed, it cannot be revived. Destructing enforces irreversable deletion from the folder. If you have a folder opened for read-only, the message will stay in that folder, but otherwise it may be deleted.

METHODS

Constructors

$obj->clone(OPTIONS)

Mail::Box::Message::Destructed->new(MESSAGE-ID, OPTIONS)

    You cannot instantiate a destructed message object. Destruction is done by calling Mail::Box::Message::destruct().

    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>

    . 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

Constructing a message

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

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

Mail::Box::Message::Destructed->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::Message::Destructed->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::Message::Destructed->replySubject(STRING)

The message

$obj->container

$obj->copyTo(FOLDER, OPTIONS)

$obj->folder([FOLDER])

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

    When undef is specified for HEAD, no change has to take place and the method returns silently. In all other cases, this method will complain that the header has been removed.

$obj->nrLines

$obj->sender

$obj->study(FIELDNAME)

$obj->subject

$obj->timestamp

$obj->to

The body

$obj->body([BODY])

    When undef is specified for BODY, no change has to take place and the method returns silently. In all other cases, this method will complain that the body data has been removed.

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

    It is possible to delete a destructed message, but not to undelete it.

$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::Message::Destructed->coerce(MESSAGE)

    Coerce a Mail::Box::Message into destruction.

    example: of coercion to death

    Mail::Box::Message::Destructed->coerce($folder->message(1));
$folder->message(1)->destruct;  # same

my $msg = $folder->message(1);
Mail::Box::Message::Destructed->coerce($msg);
$msg->destruct;                 # same

$obj->diskDelete

$obj->isDelayed

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

$obj->readFromParser(PARSER, [BODYTYPE])

$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::Message::Destructed->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

$obj->errors

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

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

$obj->logPriority(LEVEL)

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

$obj->logSettings

$obj->notImplemented

$obj->report([LEVEL])

$obj->reportAll([LEVEL])

$obj->shortSize([VALUE])

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

$obj->shortString

$obj->trace([LEVEL])

$obj->warnings

Cleanup

$obj->DESTROY

$obj->destruct

$obj->inGlobalDestruction

DETAILS

DIAGNOSTICS

Error: Cannot coerce a (class) into destruction

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: Destructed message has no labels except 'deleted'

Error: Destructed messages can not be undeleted

    Once a message is destructed, it can not be revived. Destruction is an optimization in memory usage: if you need an undelete functionality, then you can not use Mail::Box::Message::destruct().

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: You cannot instantiate a destructed message

    You cannot instantiate a destructed message object directly. Destruction is done by calling Mail::Box::Message::destruct() on any existing folder message.

Error: You cannot take the head/body of a destructed message

    The message originated from a folder, but its memory has been freed-up forcefully by means of Mail::Box::Message::destruct(). Apparently, your program still tries to get to the header or body data after this destruction, which is not possible.

SEE ALSO

This module is part of Mail-Box distribution version 2.092, built on November 20, 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