man Mail::Box::Message::Destructed () - a destructed message
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
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) See Constructors in Mail::Message
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 L<Mail::Message> undef body_type L<Mail::Box::Message> <from folder> deleted L<Mail::Message> <false> field_type L<Mail::Message> undef folder L<Mail::Box::Message> <required> head L<Mail::Message> undef head_type L<Mail::Message> L<Mail::Message::Head::Complete|Mail::Message::Head::Complete> labels L<Mail::Message> {} log L<Mail::Reporter> C<'WARNINGS'> messageId L<Mail::Message> undef modified L<Mail::Message> <false> size L<Mail::Box::Message> undef trace L<Mail::Reporter> C<'WARNINGS'> trusted L<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]) See Constructing a message in Mail::Message::Construct::Bounce
Mail::Box::Message::Destructed->build([MESSAGE|PART|BODY], CONTENT) See Constructing a message in Mail::Message::Construct::Build
Mail::Box::Message::Destructed->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::Message::Destructed->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::Message::Destructed->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->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]) When CWundef 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 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]) When CWundef 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->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) It is possible to delete a destructed message, but not to undelete it.
$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::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 See Internals in Mail::Box::Message
$obj->isDelayed See Internals in Mail::Message
$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::Message::Destructed->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::Message::Destructed->log([LEVEL [,STRINGS]]) See Error handling in Mail::Reporter
$obj->logPriority(LEVEL)
Mail::Box::Message::Destructed->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::Message::Destructed->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) into destruction
Only real Mail::Box::Message objects can get destructed into Mail::Box::Message::Destructed objects. Mail::Message free their memory immediately when the last reference is lost.
Error: Cannot include forward source as CW$include.
Unknown alternative for the forward(include). Valid choices are CWNO, CWINLINE, CWATTACH, and CWENCAPSULATE.
Error: Cannot include reply source as CW$include.
Unknown alternative for the CWinclude option of reply(). Valid choices are CWNO, CWINLINE, and CWATTACH.
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: 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 CWvia options.
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 CW$package does not implement CW$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.
Error: 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: forwardAttach requires a preamble object
Error: forwardEncapsulate requires a preamble object
Error: no rebuild rule CW$name defined.
DETAILS
REFERENCES
See the MailBox website at <http://perl.overmeer.net/mailbox/> for more details.
COPYRIGHTS
Distribution version 2.063. Written by Mark Overmeer (mark@overmeer.net). See the ChangeLog for other contributors.
Copyright (c) 2001-2003 by the author(s). All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.