GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  MAIL::BOX::MESSAGE::DESTRUCTED (3)

.ds Aq ’

NAME

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

CONTENTS

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.

See documentation in the base class.

METHODS

See documentation in the base class.

    Constructors

See documentation in the base class.
$obj-><B>cloneB>(OPTIONS) See Constructors in Mail::Message
Mail::Box::Message::Destructed-><B>newB>(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

See documentation in the base class.
$obj-><B>bounceB>([RG-OBJECT|OPTIONS]) See Constructing a message in Mail::Message::Construct::Bounce
Mail::Box::Message::Destructed-><B>buildB>([MESSAGE|PART|BODY], CONTENT) See Constructing a message in Mail::Message::Construct::Build
Mail::Box::Message::Destructed-><B>buildFromBodyB>(BODY, [HEAD], HEADERS) See Constructing a message in Mail::Message::Construct::Build
$obj-><B>forwardB>(OPTIONS) See Constructing a message in Mail::Message::Construct::Forward
$obj-><B>forwardAttachB>(OPTIONS) See Constructing a message in Mail::Message::Construct::Forward
$obj-><B>forwardEncapsulateB>(OPTIONS) See Constructing a message in Mail::Message::Construct::Forward
$obj-><B>forwardInlineB>(OPTIONS) See Constructing a message in Mail::Message::Construct::Forward
$obj-><B>forwardNoB>(OPTIONS) See Constructing a message in Mail::Message::Construct::Forward
$obj-><B>forwardPostludeB>() See Constructing a message in Mail::Message::Construct::Forward
$obj-><B>forwardPreludeB>() See Constructing a message in Mail::Message::Construct::Forward
$obj-><B>forwardSubjectB>(STRING) See Constructing a message in Mail::Message::Construct::Forward
Mail::Box::Message::Destructed-><B>readB>(FILEHANDLE|SCALAR|REF-SCALAR|ARRAY-OF-LINES, OPTIONS) See Constructing a message in Mail::Message::Construct::Read
$obj-><B>rebuildB>(OPTIONS) See Constructing a message in Mail::Message::Construct::Rebuild
$obj-><B>replyB>(OPTIONS) See Constructing a message in Mail::Message::Construct::Reply
$obj-><B>replyPreludeB>([STRING|FIELD|ADDRESS|ARRAY-OF-THINGS]) See Constructing a message in Mail::Message::Construct::Reply
$obj-><B>replySubjectB>(STRING)
Mail::Box::Message::Destructed-><B>replySubjectB>(STRING) See Constructing a message in Mail::Message::Construct::Reply

    The message

See documentation in the base class.
$obj-><B>containerB>() See The message in Mail::Message
$obj-><B>copyToB>(FOLDER, OPTIONS) See The message in Mail::Box::Message
$obj-><B>folderB>([FOLDER]) See The message in Mail::Box::Message
$obj-><B>isDummyB>() See The message in Mail::Message
$obj-><B>isPartB>() See The message in Mail::Message
$obj-><B>messageIdB>() See The message in Mail::Message
$obj-><B>moveToB>(FOLDER, OPTIONS) See The message in Mail::Box::Message
$obj-><B>partNumberB>() See The message in Mail::Message
$obj-><B>printB>([FILEHANDLE]) See The message in Mail::Message
$obj-><B>sendB>([MAILER], OPTIONS) See The message in Mail::Message
$obj-><B>seqnrB>([INTEGER]) See The message in Mail::Box::Message
$obj-><B>sizeB>() See The message in Mail::Message
$obj-><B>toplevelB>() See The message in Mail::Message
$obj-><B>writeB>([FILEHANDLE]) See The message in Mail::Message

    The header

See documentation in the base class.
$obj-><B>bccB>() See The header in Mail::Message
$obj-><B>ccB>() See The header in Mail::Message
$obj-><B>dateB>() See The header in Mail::Message
$obj-><B>destinationsB>() See The header in Mail::Message
$obj-><B>fromB>() See The header in Mail::Message
$obj-><B>getB>(FIELDNAME) See The header in Mail::Message
$obj-><B>guessTimestampB>() See The header in Mail::Message
$obj-><B>headB>([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-><B>nrLinesB>() See The header in Mail::Message
$obj-><B>senderB>() See The header in Mail::Message
$obj-><B>studyB>(FIELDNAME) See The header in Mail::Message
$obj-><B>subjectB>() See The header in Mail::Message
$obj-><B>timestampB>() See The header in Mail::Message
$obj-><B>toB>() See The header in Mail::Message

    The body

See documentation in the base class.
$obj-><B>bodyB>([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-><B>contentTypeB>() See The body in Mail::Message
$obj-><B>decodedB>(OPTIONS) See The body in Mail::Message
$obj-><B>encodeB>(OPTIONS) See The body in Mail::Message
$obj-><B>isMultipartB>() See The body in Mail::Message
$obj-><B>isNestedB>() See The body in Mail::Message
$obj-><B>partsB>([’ALL’|’ACTIVE’|’DELETED’|’RECURSE’|FILTER]) See The body in Mail::Message

    Flags

See documentation in the base class.
$obj-><B>deleteB>() See Flags in Mail::Message
$obj-><B>deletedB>([BOOLEAN]) See Flags in Mail::Message
$obj-><B>isDeletedB>() See Flags in Mail::Message
$obj-><B>isModifiedB>() See Flags in Mail::Message
$obj-><B>labelB>(LABEL|PAIRS) It is possible to delete a destructed message, but not to undelete it.
$obj-><B>labelsB>() See Flags in Mail::Message
$obj-><B>labelsToStatusB>() See Flags in Mail::Message
$obj-><B>modifiedB>([BOOLEAN]) See Flags in Mail::Message
$obj-><B>statusToLabelsB>() See Flags in Mail::Message

    The whole message as text

See documentation in the base class.
$obj-><B>fileB>() See The whole message as text in Mail::Message::Construct::Text
$obj-><B>linesB>() See The whole message as text in Mail::Message::Construct::Text
$obj-><B>printStructureB>([FILEHANDLE|undef],[INDENT]) See The whole message as text in Mail::Message::Construct::Text
$obj-><B>stringB>() See The whole message as text in Mail::Message::Construct::Text

    Internals

See documentation in the base class.
$obj-><B>clonedFromB>() See Internals in Mail::Message
Mail::Box::Message::Destructed-><B>coerceB>(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-><B>diskDeleteB>() See Internals in Mail::Box::Message
$obj-><B>isDelayedB>() See Internals in Mail::Message
$obj-><B>readBodyB>(PARSER, HEAD [, BODYTYPE]) See Internals in Mail::Box::Message
$obj-><B>readFromParserB>(PARSER, [BODYTYPE]) See Internals in Mail::Message
$obj-><B>readHeadB>(PARSER [,CLASS]) See Internals in Mail::Message
$obj-><B>recursiveRebuildPartB>(PART, OPTIONS) See Internals in Mail::Message::Construct::Rebuild
$obj-><B>storeBodyB>(BODY) See Internals in Mail::Message
$obj-><B>takeMessageIdB>([STRING]) See Internals in Mail::Message

    Error handling

See documentation in the base class.
$obj-><B>AUTOLOADB>() See METHODS in Mail::Message::Construct
$obj-><B>addReportB>(OBJECT) See Error handling in Mail::Reporter
$obj-><B>defaultTraceB>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
Mail::Box::Message::Destructed-><B>defaultTraceB>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK]) See Error handling in Mail::Reporter
$obj-><B>errorsB>() See Error handling in Mail::Reporter
$obj-><B>logB>([LEVEL [,STRINGS]])
Mail::Box::Message::Destructed-><B>logB>([LEVEL [,STRINGS]]) See Error handling in Mail::Reporter
$obj-><B>logPriorityB>(LEVEL)
Mail::Box::Message::Destructed-><B>logPriorityB>(LEVEL) See Error handling in Mail::Reporter
$obj-><B>logSettingsB>() See Error handling in Mail::Reporter
$obj-><B>notImplementedB>() See Error handling in Mail::Reporter
$obj-><B>reportB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>reportAllB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>shortSizeB>([VALUE])
Mail::Box::Message::Destructed-><B>shortSizeB>([VALUE]) See Error handling in Mail::Message
$obj-><B>shortStringB>() See Error handling in Mail::Message
$obj-><B>traceB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>warningsB>() See Error handling in Mail::Reporter

    Cleanup

See documentation in the base class.
$obj-><B>DESTROYB>() See Cleanup in Mail::Message
$obj-><B>destructB>() See Cleanup in Mail::Box::Message

DETAILS

See documentation in the base class.

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 $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.109, built on August 19, 2013. Website: http://perl.overmeer.net/mailbox/

LICENSE

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

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 MAIL::BOX::MESSAGE::DESTRUCTED (3) 2013-08-19

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.