Mail::Message::Body::Delayed(3pm)

1Mail::Message::Body::DeUlsaeyredC(o3n)tributed Perl DocuMmaeinlt:a:tMieosnsage::Body::Delayed(3)
2
3
4

NAME

6       Mail::Message::Body::Delayed - body of a Mail::Message but not read
7       yet.
8

INHERITANCE

10        Mail::Message::Body::Delayed realizes a Mail::Message::Body
11
12        Mail::Message::Body::Delayed
13          is a Mail::Reporter
14

SYNOPSIS

16        See Mail::Message::Body
17

DESCRIPTION

19       Message bodies of this type will be replaced by another type the moment
20       you access the content.  In this documentation you will find the
21       description of how a message body gets delay loaded.
22

OVERLOADED

24       overload: ""
25           (stringification) Returns the body as string --which will trigger
26           completion-- unless called to produce a string for "Carp".  The
27           latter to avoid deep recursions.
28
29           example: stringification of delayed body
30
31            print $msg->body;   # implicit by print
32
33            my $body = $msg->body;
34            my $x    = "$body"; # explicit by interpolation
35
36       overload: @{}
37           When a body object is used as being an array reference, the lines
38           of the body are returned.  This is the same as using the "lines"
39           method.
40
41       overload: bool
42           Always returns a true value, which is needed to have overloaded
43           objects to be used as in "if($body)".  Otherwise, "if(defined
44           $body)" would be needed to avoid a runtime error.
45

METHODS

47   Constructors
48       Mail::Message::Body::Delayed->new(OPTIONS)
49            -Option --Defined in     --Default
50             log      Mail::Reporter   'WARNINGS'
51             message                   <required>
52             trace    Mail::Reporter   'WARNINGS'
53
54           log => LEVEL
55           message => MESSAGE
56             The MESSAGE object which contains this delayed body.
57
58           trace => LEVEL
59
60   The body
61       $obj->message
62
63   About to the payload
64       $obj->guessSize
65       $obj->isDelayed
66       $obj->isModified
67       $obj->isMultipart
68       $obj->modified
69       $obj->nrLines
70
71   Internals
72       $obj->fileLocation([BEGIN, END])
73       $obj->load
74           Returns the loaded version of this body.
75
76       $obj->moveLocation(DISTANCE)
77       $obj->read(PARSER, HEAD, BODYTYPE)
78
79   Error handling
80       $obj->AUTOLOAD
81           See "Error handling" in Mail::Reporter
82
83       $obj->addReport(OBJECT)
84           See "Error handling" in Mail::Reporter
85
86       $obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
87           Mail::Message::Body::Delayed->defaultTrace([LEVEL]|[LOGLEVEL,
88           TRACELEVEL]|[LEVEL, CALLBACK])
89
90           See "Error handling" in Mail::Reporter
91
92       $obj->errors
93           See "Error handling" in Mail::Reporter
94
95       $obj->log([LEVEL [,STRINGS]])
96           Mail::Message::Body::Delayed->log([LEVEL [,STRINGS]])
97
98           See "Error handling" in Mail::Reporter
99
100       $obj->logPriority(LEVEL)
101           Mail::Message::Body::Delayed->logPriority(LEVEL)
102
103           See "Error handling" in Mail::Reporter
104
105       $obj->logSettings
106           See "Error handling" in Mail::Reporter
107
108       $obj->notImplemented
109           See "Error handling" in Mail::Reporter
110
111       $obj->report([LEVEL])
112           See "Error handling" in Mail::Reporter
113
114       $obj->reportAll([LEVEL])
115           See "Error handling" in Mail::Reporter
116
117       $obj->trace([LEVEL])
118           See "Error handling" in Mail::Reporter
119
120       $obj->warnings
121           See "Error handling" in Mail::Reporter
122
123   Cleanup
124       $obj->DESTROY
125           See "Cleanup" in Mail::Reporter
126
127       $obj->inGlobalDestruction
128           See "Cleanup" in Mail::Reporter
129

DIAGNOSTICS

131       Error: Package $package does not implement $method.
132           Fatal error: the specific package (or one of its superclasses) does
133           not implement this method where it should. This message means that
134           some other related classes do implement this method however the
135           class at hand does not.  Probably you should investigate this and
136           probably inform the author of the package.
137

LICENSE

143       Copyrights 2001-2011 by Mark Overmeer. For other contributors see
144       ChangeLog.
145
146       This program is free software; you can redistribute it and/or modify it
147       under the same terms as Perl itself.  See
148       http://www.perl.com/perl/misc/Artistic.html
149
150
151
152perl v5.12.3                      2011-01-26   Mail::Message::Body::Delayed(3)