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
|
=head1 NAME
Mail::Message::Body::Delayed - body of a Mail::Message but not read yet.
=head1 INHERITANCE
Mail::Message::Body::Delayed realizes a Mail::Message::Body
Mail::Message::Body::Delayed
is a Mail::Reporter
=head1 SYNOPSIS
See Mail::Message::Body
=head1 DESCRIPTION
Message bodies of this type will be replaced by another type the moment you
access the content. In this documentation you will find the description of
how a message body gets delay loaded.
=head1 OVERLOADED
overload: B<"">
=over 4
(stringification) Returns the body as string --which will trigger
completion-- unless called to produce a string for C<Carp>. The latter
to avoid deep recursions.
I<Example:> stringification of delayed body
print $msg->body; # implicit by print
my $body = $msg->body;
my $x = "$body"; # explicit by interpolation
=back
overload: B<@{}>
=over 4
When a body object is used as being an array reference, the lines of
the body are returned. This is the same as using the C<lines> method.
=back
overload: B<bool>
=over 4
Always returns a true value, which is needed to have overloaded
objects to be used as in C<if($body)>. Otherwise, C<if(defined $body)>
would be needed to avoid a runtime error.
=back
=head1 METHODS
=head2 Constructors
Mail::Message::Body::Delayed-E<gt>B<new>(OPTIONS)
=over 4
Option --Defined in --Default
log Mail::Reporter 'WARNINGS'
message <required>
trace Mail::Reporter 'WARNINGS'
. log LEVEL
. message MESSAGE
=over 4
The MESSAGE object which contains this delayed body.
=back
. trace LEVEL
=back
=head2 The body
$obj-E<gt>B<message>
=over 4
=back
=head2 About to the payload
$obj-E<gt>B<guessSize>
=over 4
=back
$obj-E<gt>B<isDelayed>
=over 4
=back
$obj-E<gt>B<isModified>
=over 4
=back
$obj-E<gt>B<isMultipart>
=over 4
=back
$obj-E<gt>B<modified>
=over 4
=back
$obj-E<gt>B<nrLines>
=over 4
=back
=head2 Internals
$obj-E<gt>B<fileLocation>([BEGIN, END])
=over 4
=back
$obj-E<gt>B<load>
=over 4
Returns the loaded version of this body.
=back
$obj-E<gt>B<moveLocation>(DISTANCE)
=over 4
=back
$obj-E<gt>B<read>(PARSER, HEAD, BODYTYPE)
=over 4
=back
=head2 Error handling
$obj-E<gt>B<AUTOLOAD>
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<addReport>(OBJECT)
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
Mail::Message::Body::Delayed-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<errors>
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<log>([LEVEL [,STRINGS]])
Mail::Message::Body::Delayed-E<gt>B<log>([LEVEL [,STRINGS]])
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<logPriority>(LEVEL)
Mail::Message::Body::Delayed-E<gt>B<logPriority>(LEVEL)
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<logSettings>
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<notImplemented>
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<report>([LEVEL])
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<reportAll>([LEVEL])
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<trace>([LEVEL])
=over 4
See L<Mail::Reporter/"Error handling">
=back
$obj-E<gt>B<warnings>
=over 4
See L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
$obj-E<gt>B<DESTROY>
=over 4
See L<Mail::Reporter/"Cleanup">
=back
$obj-E<gt>B<inGlobalDestruction>
=over 4
See L<Mail::Reporter/"Cleanup">
=back
=head1 DIAGNOSTICS
I<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.
=head1 REFERENCES
See the MailBox website at L<http://perl.overmeer.net/mailbox/> for more details.
=head1 COPYRIGHTS
Distribution version 2.068.
Written by Mark Overmeer (mark@overmeer.net). See the ChangeLog for
other contributors.
Copyright (c) 2001-2006 by the author(s). All rights reserved.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
|