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
|
=encoding utf8
=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
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.
Extends L<"DESCRIPTION" in Mail::Reporter|Mail::Reporter/"DESCRIPTION">.
=head1 OVERLOADED
=over 4
=item overload: B<""> 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.
ยป example: stringification of delayed body
print $msg->body; # implicit by print
my $body = $msg->body;
my $x = "$body"; # explicit by interpolation
=item overload: B<@{}> access as ARRAY
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.
=item overload: B<bool> existence
Always returns a C<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
Extends L<"METHODS" in Mail::Reporter|Mail::Reporter/"METHODS">.
=head2 Constructors
Extends L<"Constructors" in Mail::Reporter|Mail::Reporter/"Constructors">.
=over 4
=item $class-E<gt>B<new>(%options)
Inherited, see L<Mail::Reporter/"Constructors">
-Option --Default
message <required>
=over 2
=item message => MESSAGE
The MESSAGE object which contains this delayed body.
=back
=back
=head2 Attributes
Extends L<"Attributes" in Mail::Reporter|Mail::Reporter/"Attributes">.
=head2 Error handling
Extends L<"Error handling" in Mail::Reporter|Mail::Reporter/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
Extends L<"Cleanup" in Mail::Reporter|Mail::Reporter/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
Inherited, see L<Mail::Reporter/"Cleanup">
=back
=head2 The body
=over 4
=item $obj-E<gt>B<message>()
Z<>
=back
=head2 About to the payload
=over 4
=item $obj-E<gt>B<guessSize>()
Z<>
=item $obj-E<gt>B<isDelayed>()
Z<>
=item $obj-E<gt>B<isModified>()
Z<>
=item $obj-E<gt>B<isMultipart>()
Z<>
=item $obj-E<gt>B<modified>()
Z<>
=item $obj-E<gt>B<nrLines>()
Z<>
=back
=head2 Internals
=over 4
=item $obj-E<gt>B<fileLocation>( [$begin, $end] )
Z<>
=item $obj-E<gt>B<load>()
Returns the loaded version of this body.
=item $obj-E<gt>B<moveLocation>($distance)
Z<>
=item $obj-E<gt>B<read>($parser, $head, $bodytype)
Z<>
=back
=head1 DIAGNOSTICS
=over 4
=item Error: a message must be specified to a delayed body.
Cast by C<new()>
=item Error: class $package does not implement method $method.
Fatal error: the specific C<$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.
Cast by C<notImplemented()>
=back
=head1 SEE ALSO
This module is part of Mail-Box version 4.01,
built on December 13, 2025. Website: F<http://perl.overmeer.net/CPAN/>
=head1 LICENSE
For contributors see file ChangeLog.
This software is copyright (c) 2001-2025 by Mark Overmeer.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
|