/usr/share/perl5/Mail/Box/Message/Destructed.pod is in libmail-box-perl 2.099-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 | =head1 NAME
Mail::Box::Message::Destructed - a destructed message
=head1 INHERITANCE
Mail::Box::Message::Destructed
is a Mail::Box::Message
is a Mail::Message
is a Mail::Reporter
=head1 SYNOPSIS
$folder->message(3)->destruct;
=head1 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.
=head1 METHODS
=head2 Constructors
=over 4
=item $obj-E<gt>B<clone>(OPTIONS)
See L<Mail::Message/"Constructors">
=item Mail::Box::Message::Destructed-E<gt>B<new>(MESSAGE-ID, OPTIONS)
You cannot instantiate a destructed message object. Destruction is
done by calling L<Mail::Box::Message::destruct()|Mail::Box::Message/"Cleanup">.
-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>
=over 2
=item body => OBJECT
=item body_type => CODE|CLASS
=item deleted => BOOLEAN
=item field_type => CLASS
=item folder => FOLDER
=item head => OBJECT
=item head_type => CLASS
=item labels => ARRAY|HASH
=item log => LEVEL
=item messageId => STRING
=item modified => BOOLEAN
=item size => INTEGER
=item trace => LEVEL
=item trusted => BOOLEAN
=back
=back
=head2 Constructing a message
=over 4
=item $obj-E<gt>B<bounce>([RG-OBJECT|OPTIONS])
See L<Mail::Message::Construct::Bounce/"Constructing a message">
=item Mail::Box::Message::Destructed-E<gt>B<build>([MESSAGE|PART|BODY], CONTENT)
See L<Mail::Message::Construct::Build/"Constructing a message">
=item Mail::Box::Message::Destructed-E<gt>B<buildFromBody>(BODY, [HEAD], HEADERS)
See L<Mail::Message::Construct::Build/"Constructing a message">
=item $obj-E<gt>B<forward>(OPTIONS)
See L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardAttach>(OPTIONS)
See L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardEncapsulate>(OPTIONS)
See L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardInline>(OPTIONS)
See L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardNo>(OPTIONS)
See L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardPostlude>
See L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardPrelude>
See L<Mail::Message::Construct::Forward/"Constructing a message">
=item $obj-E<gt>B<forwardSubject>(STRING)
See L<Mail::Message::Construct::Forward/"Constructing a message">
=item Mail::Box::Message::Destructed-E<gt>B<read>( FILEHANDLE | SCALAR | REF-SCALAR | ARRAY-OF-LINES, OPTIONS)
See L<Mail::Message::Construct::Read/"Constructing a message">
=item $obj-E<gt>B<rebuild>(OPTIONS)
See L<Mail::Message::Construct::Rebuild/"Constructing a message">
=item $obj-E<gt>B<reply>(OPTIONS)
See L<Mail::Message::Construct::Reply/"Constructing a message">
=item $obj-E<gt>B<replyPrelude>([STRING|FIELD|ADDRESS|ARRAY-OF-THINGS])
See L<Mail::Message::Construct::Reply/"Constructing a message">
=item $obj-E<gt>B<replySubject>(STRING)
=item Mail::Box::Message::Destructed-E<gt>B<replySubject>(STRING)
See L<Mail::Message::Construct::Reply/"Constructing a message">
=back
=head2 The message
=over 4
=item $obj-E<gt>B<container>
See L<Mail::Message/"The message">
=item $obj-E<gt>B<copyTo>(FOLDER, OPTIONS)
See L<Mail::Box::Message/"The message">
=item $obj-E<gt>B<folder>([FOLDER])
See L<Mail::Box::Message/"The message">
=item $obj-E<gt>B<isDummy>
See L<Mail::Message/"The message">
=item $obj-E<gt>B<isPart>
See L<Mail::Message/"The message">
=item $obj-E<gt>B<messageId>
See L<Mail::Message/"The message">
=item $obj-E<gt>B<moveTo>(FOLDER, OPTIONS)
See L<Mail::Box::Message/"The message">
=item $obj-E<gt>B<print>([FILEHANDLE])
See L<Mail::Message/"The message">
=item $obj-E<gt>B<send>([MAILER], OPTIONS)
See L<Mail::Message/"The message">
=item $obj-E<gt>B<seqnr>([INTEGER])
See L<Mail::Box::Message/"The message">
=item $obj-E<gt>B<size>
See L<Mail::Message/"The message">
=item $obj-E<gt>B<toplevel>
See L<Mail::Message/"The message">
=item $obj-E<gt>B<write>([FILEHANDLE])
See L<Mail::Message/"The message">
=back
=head2 The header
=over 4
=item $obj-E<gt>B<bcc>
See L<Mail::Message/"The header">
=item $obj-E<gt>B<cc>
See L<Mail::Message/"The header">
=item $obj-E<gt>B<date>
See L<Mail::Message/"The header">
=item $obj-E<gt>B<destinations>
See L<Mail::Message/"The header">
=item $obj-E<gt>B<from>
See L<Mail::Message/"The header">
=item $obj-E<gt>B<get>(FIELDNAME)
See L<Mail::Message/"The header">
=item $obj-E<gt>B<guessTimestamp>
See L<Mail::Message/"The header">
=item $obj-E<gt>B<head>([HEAD])
When C<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.
=item $obj-E<gt>B<nrLines>
See L<Mail::Message/"The header">
=item $obj-E<gt>B<sender>
See L<Mail::Message/"The header">
=item $obj-E<gt>B<study>(FIELDNAME)
See L<Mail::Message/"The header">
=item $obj-E<gt>B<subject>
See L<Mail::Message/"The header">
=item $obj-E<gt>B<timestamp>
See L<Mail::Message/"The header">
=item $obj-E<gt>B<to>
See L<Mail::Message/"The header">
=back
=head2 The body
=over 4
=item $obj-E<gt>B<body>([BODY])
When C<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.
=item $obj-E<gt>B<contentType>
See L<Mail::Message/"The body">
=item $obj-E<gt>B<decoded>(OPTIONS)
See L<Mail::Message/"The body">
=item $obj-E<gt>B<encode>(OPTIONS)
See L<Mail::Message/"The body">
=item $obj-E<gt>B<isMultipart>
See L<Mail::Message/"The body">
=item $obj-E<gt>B<isNested>
See L<Mail::Message/"The body">
=item $obj-E<gt>B<parts>(['ALL'|'ACTIVE'|'DELETED'|'RECURSE'|FILTER])
See L<Mail::Message/"The body">
=back
=head2 Flags
=over 4
=item $obj-E<gt>B<delete>
See L<Mail::Message/"Flags">
=item $obj-E<gt>B<deleted>([BOOLEAN])
See L<Mail::Message/"Flags">
=item $obj-E<gt>B<isDeleted>
See L<Mail::Message/"Flags">
=item $obj-E<gt>B<isModified>
See L<Mail::Message/"Flags">
=item $obj-E<gt>B<label>(LABEL|PAIRS)
It is possible to delete a destructed message, but not to undelete it.
=item $obj-E<gt>B<labels>
See L<Mail::Message/"Flags">
=item $obj-E<gt>B<labelsToStatus>
See L<Mail::Message/"Flags">
=item $obj-E<gt>B<modified>([BOOLEAN])
See L<Mail::Message/"Flags">
=item $obj-E<gt>B<statusToLabels>
See L<Mail::Message/"Flags">
=back
=head2 The whole message as text
=over 4
=item $obj-E<gt>B<file>
See L<Mail::Message::Construct::Text/"The whole message as text">
=item $obj-E<gt>B<lines>
See L<Mail::Message::Construct::Text/"The whole message as text">
=item $obj-E<gt>B<printStructure>([FILEHANDLE|undef],[INDENT])
See L<Mail::Message::Construct::Text/"The whole message as text">
=item $obj-E<gt>B<string>
See L<Mail::Message::Construct::Text/"The whole message as text">
=back
=head2 Internals
=over 4
=item $obj-E<gt>B<clonedFrom>
See L<Mail::Message/"Internals">
=item Mail::Box::Message::Destructed-E<gt>B<coerce>(MESSAGE)
Coerce a L<Mail::Box::Message|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
=item $obj-E<gt>B<diskDelete>
See L<Mail::Box::Message/"Internals">
=item $obj-E<gt>B<isDelayed>
See L<Mail::Message/"Internals">
=item $obj-E<gt>B<readBody>(PARSER, HEAD [, BODYTYPE])
See L<Mail::Box::Message/"Internals">
=item $obj-E<gt>B<readFromParser>(PARSER, [BODYTYPE])
See L<Mail::Message/"Internals">
=item $obj-E<gt>B<readHead>(PARSER [,CLASS])
See L<Mail::Message/"Internals">
=item $obj-E<gt>B<recursiveRebuildPart>(PART, OPTIONS)
See L<Mail::Message::Construct::Rebuild/"Internals">
=item $obj-E<gt>B<storeBody>(BODY)
See L<Mail::Message/"Internals">
=item $obj-E<gt>B<takeMessageId>([STRING])
See L<Mail::Message/"Internals">
=back
=head2 Error handling
=over 4
=item $obj-E<gt>B<AUTOLOAD>
See L<Mail::Message::Construct/"METHODS">
=item $obj-E<gt>B<addReport>(OBJECT)
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
=item Mail::Box::Message::Destructed-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
=item Mail::Box::Message::Destructed-E<gt>B<log>([LEVEL [,STRINGS]])
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logPriority>(LEVEL)
=item Mail::Box::Message::Destructed-E<gt>B<logPriority>(LEVEL)
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<report>([LEVEL])
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<reportAll>([LEVEL])
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<shortSize>([VALUE])
=item Mail::Box::Message::Destructed-E<gt>B<shortSize>([VALUE])
See L<Mail::Message/"Error handling">
=item $obj-E<gt>B<shortString>
See L<Mail::Message/"Error handling">
=item $obj-E<gt>B<trace>([LEVEL])
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>
See L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
=over 4
=item $obj-E<gt>B<DESTROY>
See L<Mail::Message/"Cleanup">
=item $obj-E<gt>B<destruct>
See L<Mail::Box::Message/"Cleanup">
=item $obj-E<gt>B<inGlobalDestruction>
See L<Mail::Reporter/"Cleanup">
=back
=head1 DIAGNOSTICS
=over 4
=item Error: Cannot coerce a (class) into destruction
Only real L<Mail::Box::Message|Mail::Box::Message> objects can get destructed into
L<Mail::Box::Message::Destructed|Mail::Box::Message::Destructed> objects. L<Mail::Message|Mail::Message> free
their memory immediately when the last reference is lost.
=item Error: Cannot include forward source as $include.
Unknown alternative for the L<forward(include)|Mail::Message::Construct::Forward/"Constructing a message">. Valid choices are
C<NO>, C<INLINE>, C<ATTACH>, and C<ENCAPSULATE>.
=item Error: Cannot include reply source as $include.
Unknown alternative for the C<include> option of L<reply()|Mail::Message::Construct::Reply/"Constructing a message">. Valid
choices are C<NO>, C<INLINE>, and C<ATTACH>.
=item Error: Destructed message has no labels except 'deleted'
=item 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 L<Mail::Box::Message::destruct()|Mail::Box::Message/"Cleanup">.
=item Error: Method bounce requires To, Cc, or Bcc
The message L<bounce()|Mail::Message::Construct::Bounce/"Constructing a message"> 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 L<reply()|Mail::Message::Construct::Reply/"Constructing a message">. When you wish to modify the content, use
L<forward()|Mail::Message::Construct::Forward/"Constructing a message">.
=item Error: Method forwardAttach requires a preamble
=item Error: Method forwardEncapsulate requires a preamble
=item Error: No address to create forwarded to.
If a forward message is created, a destination address must be specified.
=item Error: No default mailer found to send message.
The message L<send()|Mail::Message/"The message"> mechanism had not enough information to automatically
find a mail transfer agent to sent this message. Specify a mailer
explicitly using the C<via> options.
=item Error: No rebuild rule $name defined.
=item 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 L<Mail::Message|Mail::Message>, and then add it to the folder. During this
L<Mail::Box::addMessage()|Mail::Box/"The folder"> process, the message will get L<coerce()|Mail::Box::Message::Destructed/"METHODS">-d
into the right message type, adding storage information and the like.
=item 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.
=item Error: You cannot instantiate a destructed message
You cannot instantiate a destructed message object directly. Destruction
is done by calling L<Mail::Box::Message::destruct()|Mail::Box::Message/"Cleanup"> on any existing
folder message.
=item 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 L<Mail::Box::Message::destruct()|Mail::Box::Message/"Cleanup">. Apparently,
your program still tries to get to the header or body data after this
destruction, which is not possible.
=back
=head1 SEE ALSO
This module is part of Mail-Box distribution version 2.099,
built on July 07, 2011. Website: F<http://perl.overmeer.net/mailbox/>
=head1 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 F<http://www.perl.com/perl/misc/Artistic.html>
|