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

METHODS

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

DIAGNOSTICS

165       Error: Package $package does not implement $method.
166
167       Fatal error: the specific package (or one of its superclasses) does not
168       implement this method where it should. This message means that some
169       other related classes do implement this method however the class at
170       hand does not.  Probably you should investigate this and probably
171       inform the author of the package.
172

LICENSE

178       Copyrights 2001-2007 by Mark Overmeer.For other contributors see
179       ChangeLog.
180
181       This program is free software; you can redistribute it and/or modify it
182       under the same terms as Perl itself.  See
183       http://www.perl.com/perl/misc/Artistic.html
184
185
186
187perl v5.8.8                       2007-03-25   Mail::Message::Body::Delayed(3)