.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{ . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Mail::Box::Mbox::Message 3pm" .TH Mail::Box::Mbox::Message 3pm "2014-08-24" "perl v5.20.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Mail::Box::Mbox::Message \- one message in a Mbox folder .SH "INHERITANCE" .IX Header "INHERITANCE" .Vb 5 \& Mail::Box::Mbox::Message \& is a Mail::Box::File::Message \& is a Mail::Box::Message \& is a Mail::Message \& is a Mail::Reporter .Ve .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& my $folder = new Mail::Box::Mbox folder => $ENV{MAIL}, ...; \& my $message = $folder\->message(0); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Maintain one message in an Mail::Box::Mbox folder. .PP Extends \*(L"\s-1DESCRIPTION\*(R"\s0 in Mail::Box::File::Message. .SH "METHODS" .IX Header "METHODS" Extends \*(L"\s-1METHODS\*(R"\s0 in Mail::Box::File::Message. .SH "DETAILS" .IX Header "DETAILS" Extends \*(L"\s-1DETAILS\*(R"\s0 in Mail::Box::File::Message. .SH "DIAGNOSTICS" .IX Header "DIAGNOSTICS" .ie n .IP "Error: Cannot coerce a $class object into a $class object" 4 .el .IP "Error: Cannot coerce a \f(CW$class\fR object into a \f(CW$class\fR object" 4 .IX Item "Error: Cannot coerce a $class object into a $class object" .PD 0 .ie n .IP "Error: Cannot include forward source as $include." 4 .el .IP "Error: Cannot include forward source as \f(CW$include\fR." 4 .IX Item "Error: Cannot include forward source as $include." .PD Unknown alternative for the forward(include). Valid choices are \&\f(CW\*(C`NO\*(C'\fR, \f(CW\*(C`INLINE\*(C'\fR, \f(CW\*(C`ATTACH\*(C'\fR, and \f(CW\*(C`ENCAPSULATE\*(C'\fR. .ie n .IP "Error: Cannot include reply source as $include." 4 .el .IP "Error: Cannot include reply source as \f(CW$include\fR." 4 .IX Item "Error: Cannot include reply source as $include." Unknown alternative for the \f(CW\*(C`include\*(C'\fR option of \fIreply()\fR. Valid choices are \f(CW\*(C`NO\*(C'\fR, \f(CW\*(C`INLINE\*(C'\fR, and \f(CW\*(C`ATTACH\*(C'\fR. .IP "Error: Method bounce requires To, Cc, or Bcc" 4 .IX Item "Error: Method bounce requires To, Cc, or Bcc" The message \fIbounce()\fR 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 \fIreply()\fR. When you wish to modify the content, use \&\fIforward()\fR. .IP "Error: Method forwardAttach requires a preamble" 4 .IX Item "Error: Method forwardAttach requires a preamble" .PD 0 .IP "Error: Method forwardEncapsulate requires a preamble" 4 .IX Item "Error: Method forwardEncapsulate requires a preamble" .IP "Error: No address to create forwarded to." 4 .IX Item "Error: No address to create forwarded to." .PD If a forward message is created, a destination address must be specified. .IP "Error: No default mailer found to send message." 4 .IX Item "Error: No default mailer found to send message." The message \fIsend()\fR mechanism had not enough information to automatically find a mail transfer agent to sent this message. Specify a mailer explicitly using the \f(CW\*(C`via\*(C'\fR options. .ie n .IP "Error: No rebuild rule $name defined." 4 .el .IP "Error: No rebuild rule \f(CW$name\fR defined." 4 .IX Item "Error: No rebuild rule $name defined." .PD 0 .IP "Error: Only \fIbuild()\fR Mail::Message's; they are not in a folder yet" 4 .IX Item "Error: Only build() Mail::Message's; they are not in a folder yet" .PD 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 \&\fIMail::Box::addMessage()\fR process, the message will get \fIcoerce()\fR\-d into the right message type, adding storage information and the like. .ie n .IP "Error: Package $package does not implement $method." 4 .el .IP "Error: Package \f(CW$package\fR does not implement \f(CW$method\fR." 4 .IX 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. .IP "Error: Unable to read delayed body." 4 .IX Item "Error: Unable to read delayed body." .PD 0 .IP "Error: coercion starts with some object" 4 .IX Item "Error: coercion starts with some object" .PD .SH "SEE ALSO" .IX Header "SEE ALSO" This module is part of Mail-Box distribution version 2.117, built on August 24, 2014. Website: \fIhttp://perl.overmeer.net/mailbox/\fR .SH "LICENSE" .IX Header "LICENSE" Copyrights 2001\-2014 by [Mark Overmeer]. For other contributors see ChangeLog. .PP This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See \fIhttp://www.perl.com/perl/misc/Artistic.html\fR