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

1Mail::Message::Body::NeUssteerd(C3o)ntributed Perl DocumMeanitla:t:iMoenssage::Body::Nested(3)
2
3
4

NAME

6       Mail::Message::Body::Nested - body of a message which contains a
7       message
8

INHERITANCE

10        Mail::Message::Body::Nested
11          is a Mail::Message::Body
12          is a Mail::Reporter
13

SYNOPSIS

15        See Mail::Message::Body
16
17        if($body->isNested) {
18           my $nest = $body->nested;
19           $nest->delete;
20        }
21

DESCRIPTION

23       The body (content) of a message can be stored in various ways.  In this
24       manual-page you find the description of extra functionality you have
25       when a message contains a nested message, like "message/rfc822".
26
27       A nested message is different from a multipart message which contains
28       only one element, because a nested message has a full set of message
29       header fields defined by the RFC882, where a part of a multipart has
30       only a few.  But because we do not keep track whether all fields are
31       presented, a "Mail::Message::Part" is used anyway.
32
33       Extends "DESCRIPTION" in Mail::Message::Body.
34

OVERLOADED

36       Extends "OVERLOADED" in Mail::Message::Body.
37
38       overload: ""
39           Inherited, see "OVERLOADED" in Mail::Message::Body
40
41       overload: '==' and '!='
42           Inherited, see "OVERLOADED" in Mail::Message::Body
43
44       overload: @{}
45           Inherited, see "OVERLOADED" in Mail::Message::Body
46
47       overload: bool
48           Inherited, see "OVERLOADED" in Mail::Message::Body
49

METHODS

51       Extends "METHODS" in Mail::Message::Body.
52
53   Constructors
54       Extends "Constructors" in Mail::Message::Body.
55
56       $obj->clone()
57           Inherited, see "Constructors" in Mail::Message::Body
58
59       Mail::Message::Body::Nested->new(%options)
60            -Option           --Defined in         --Default
61             based_on           Mail::Message::Body  undef
62             charset            Mail::Message::Body  'PERL' or <undef>
63             checked            Mail::Message::Body  <false>
64             content_id         Mail::Message::Body  undef
65             data               Mail::Message::Body  undef
66             description        Mail::Message::Body  undef
67             disposition        Mail::Message::Body  undef
68             eol                Mail::Message::Body  'NATIVE'
69             file               Mail::Message::Body  undef
70             filename           Mail::Message::Body  undef
71             log                Mail::Reporter       'WARNINGS'
72             message            Mail::Message::Body  undef
73             mime_type          Mail::Message::Body  'message/rfc822'
74             modified           Mail::Message::Body  <false>
75             nested                                  undef
76             trace              Mail::Reporter       'WARNINGS'
77             transfer_encoding  Mail::Message::Body  'none'
78
79           based_on => BODY
80           charset => CHARSET|'PERL'
81           checked => BOOLEAN
82           content_id => STRING
83           data => ARRAY-OF-LINES | STRING
84           description => STRING|FIELD
85           disposition => STRING|FIELD
86           eol => 'CR'|'LF'|'CRLF'|'NATIVE'
87           file => FILENAME|FILEHANDLE|IOHANDLE
88           filename => FILENAME
89           log => LEVEL
90           message => MESSAGE
91           mime_type => STRING|FIELD|MIME
92           modified => BOOLEAN
93           nested => MESSAGE
94             The message which is encapsulated within this body.
95
96           trace => LEVEL
97           transfer_encoding => STRING|FIELD
98
99           example:
100
101            my $msg   = $folder->message(3);
102            my $encaps= Mail::Message::Body::Nested->new(nested => $msg);
103
104            # The body will be coerced into a message, which lacks a few
105            # lines but we do not bother.
106            my $intro = Mail::Message::Body->new(data => ...);
107            my $body  = Mail::Message::Body::Nested->new(nested  => $intro);
108
109   Constructing a body
110       Extends "Constructing a body" in Mail::Message::Body.
111
112       $obj->attach($messages, %options)
113           Inherited, see "Constructing a body" in
114           Mail::Message::Body::Construct
115
116       $obj->check()
117           Inherited, see "Constructing a body" in Mail::Message::Body::Encode
118
119       $obj->concatenate($components)
120           Inherited, see "Constructing a body" in
121           Mail::Message::Body::Construct
122
123       $obj->decoded(%options)
124           Inherited, see "Constructing a body" in Mail::Message::Body
125
126       $obj->encode(%options)
127           Inherited, see "Constructing a body" in Mail::Message::Body::Encode
128
129       $obj->encoded()
130           Inherited, see "Constructing a body" in Mail::Message::Body::Encode
131
132       $obj->eol( ['CR'|'LF'|'CRLF'|'NATIVE'] )
133           Inherited, see "Constructing a body" in Mail::Message::Body
134
135       $obj->foreachLine((CODE))
136           It is NOT possible to call some code for each line of a nested
137           because that would damage the header of the encapsulated message
138
139       $obj->stripSignature(%options)
140           Inherited, see "Constructing a body" in
141           Mail::Message::Body::Construct
142
143       $obj->unify($body)
144           Inherited, see "Constructing a body" in Mail::Message::Body::Encode
145
146   The body
147       Extends "The body" in Mail::Message::Body.
148
149       $obj->isDelayed()
150           Inherited, see "The body" in Mail::Message::Body
151
152       $obj->isMultipart()
153           Inherited, see "The body" in Mail::Message::Body
154
155       $obj->isNested()
156           Inherited, see "The body" in Mail::Message::Body
157
158       $obj->message( [$message] )
159           Inherited, see "The body" in Mail::Message::Body
160
161       $obj->partNumberOf($part)
162           Inherited, see "The body" in Mail::Message::Body
163
164   About the payload
165       Extends "About the payload" in Mail::Message::Body.
166
167       $obj->charset()
168           Inherited, see "About the payload" in Mail::Message::Body
169
170       $obj->checked( [BOOLEAN] )
171           Inherited, see "About the payload" in Mail::Message::Body
172
173       $obj->contentId( [STRING|$field] )
174           Inherited, see "About the payload" in Mail::Message::Body
175
176       $obj->description( [STRING|$field] )
177           Inherited, see "About the payload" in Mail::Message::Body
178
179       $obj->disposition( [STRING|$field] )
180           Inherited, see "About the payload" in Mail::Message::Body
181
182       $obj->dispositionFilename( [$directory] )
183           Inherited, see "About the payload" in Mail::Message::Body::Encode
184
185       $obj->isBinary()
186           Inherited, see "About the payload" in Mail::Message::Body::Encode
187
188       $obj->isText()
189           Inherited, see "About the payload" in Mail::Message::Body::Encode
190
191       $obj->mimeType()
192           Inherited, see "About the payload" in Mail::Message::Body
193
194       $obj->nrLines()
195           Inherited, see "About the payload" in Mail::Message::Body
196
197       $obj->size()
198           Inherited, see "About the payload" in Mail::Message::Body
199
200       $obj->transferEncoding( [STRING|$field] )
201           Inherited, see "About the payload" in Mail::Message::Body
202
203       $obj->type( [STRING|$field] )
204           Inherited, see "About the payload" in Mail::Message::Body
205
206   Access to the payload
207       Extends "Access to the payload" in Mail::Message::Body.
208
209       $obj->endsOnNewline()
210           Inherited, see "Access to the payload" in Mail::Message::Body
211
212       $obj->file()
213           Inherited, see "Access to the payload" in Mail::Message::Body
214
215       $obj->forNested(CODE)
216           Execute the CODE for the nested message.  This returns a new nested
217           body object.  Returns "undef" when the CODE returns "undef".
218
219       $obj->lines()
220           Inherited, see "Access to the payload" in Mail::Message::Body
221
222       $obj->nested()
223           Returns the Mail::Message::Part message which is enclosed within
224           this body.
225
226       $obj->print( [$fh] )
227           Inherited, see "Access to the payload" in Mail::Message::Body
228
229       $obj->printEscapedFrom($fh)
230           Inherited, see "Access to the payload" in Mail::Message::Body
231
232       $obj->string()
233           Inherited, see "Access to the payload" in Mail::Message::Body
234
235       $obj->stripTrailingNewline()
236           Inherited, see "Access to the payload" in Mail::Message::Body
237
238       $obj->write(%options)
239           Inherited, see "Access to the payload" in Mail::Message::Body
240
241   Internals
242       Extends "Internals" in Mail::Message::Body.
243
244       $obj->addTransferEncHandler( $name, <$class|$object> )
245       Mail::Message::Body::Nested->addTransferEncHandler( $name,
246       <$class|$object> )
247           Inherited, see "Internals" in Mail::Message::Body::Encode
248
249       $obj->contentInfoFrom($head)
250           Inherited, see "Internals" in Mail::Message::Body
251
252       $obj->contentInfoTo($head)
253           Inherited, see "Internals" in Mail::Message::Body
254
255       $obj->fileLocation( [$begin, $end] )
256           Inherited, see "Internals" in Mail::Message::Body
257
258       $obj->getTransferEncHandler($type)
259           Inherited, see "Internals" in Mail::Message::Body::Encode
260
261       $obj->isModified()
262           Inherited, see "Internals" in Mail::Message::Body
263
264       $obj->load()
265           Inherited, see "Internals" in Mail::Message::Body
266
267       $obj->modified( [BOOLEAN] )
268           Inherited, see "Internals" in Mail::Message::Body
269
270       $obj->moveLocation( [$distance] )
271           Inherited, see "Internals" in Mail::Message::Body
272
273       $obj->read( $parser, $head, $bodytype, [$chars, [$lines]] )
274           Inherited, see "Internals" in Mail::Message::Body
275
276   Error handling
277       Extends "Error handling" in Mail::Message::Body.
278
279       $obj->AUTOLOAD()
280           Inherited, see "Error handling" in Mail::Message::Body
281
282       $obj->addReport($object)
283           Inherited, see "Error handling" in Mail::Reporter
284
285       $obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level,
286       $callback] )
287       Mail::Message::Body::Nested->defaultTrace( [$level]|[$loglevel,
288       $tracelevel]|[$level, $callback] )
289           Inherited, see "Error handling" in Mail::Reporter
290
291       $obj->errors()
292           Inherited, see "Error handling" in Mail::Reporter
293
294       $obj->log( [$level, [$strings]] )
295       Mail::Message::Body::Nested->log( [$level, [$strings]] )
296           Inherited, see "Error handling" in Mail::Reporter
297
298       $obj->logPriority($level)
299       Mail::Message::Body::Nested->logPriority($level)
300           Inherited, see "Error handling" in Mail::Reporter
301
302       $obj->logSettings()
303           Inherited, see "Error handling" in Mail::Reporter
304
305       $obj->notImplemented()
306           Inherited, see "Error handling" in Mail::Reporter
307
308       $obj->report( [$level] )
309           Inherited, see "Error handling" in Mail::Reporter
310
311       $obj->reportAll( [$level] )
312           Inherited, see "Error handling" in Mail::Reporter
313
314       $obj->trace( [$level] )
315           Inherited, see "Error handling" in Mail::Reporter
316
317       $obj->warnings()
318           Inherited, see "Error handling" in Mail::Reporter
319
320   Cleanup
321       Extends "Cleanup" in Mail::Message::Body.
322
323       $obj->DESTROY()
324           Inherited, see "Cleanup" in Mail::Reporter
325

DETAILS

327       Extends "DETAILS" in Mail::Message::Body.
328

DIAGNOSTICS

330       Warning: Charset $name is not known
331           The encoding or decoding of a message body encounters a character
332           set which is not understood by Perl's Encode module.
333
334       Warning: No decoder defined for transfer encoding $name.
335           The data (message body) is encoded in a way which is not currently
336           understood, therefore no decoding (or recoding) can take place.
337
338       Warning: No encoder defined for transfer encoding $name.
339           The data (message body) has been decoded, but the required encoding
340           is unknown.  The decoded data is returned.
341
342       Error: Package $package does not implement $method.
343           Fatal error: the specific package (or one of its superclasses) does
344           not implement this method where it should. This message means that
345           some other related classes do implement this method however the
346           class at hand does not.  Probably you should investigate this and
347           probably inform the author of the package.
348
349       Warning: Unknown line terminator $eol ignored
350       Error: You cannot use foreachLine on a nested
351           foreachLine() should be used on decoded message bodies only,
352           because it would modify the header of the encapsulated message.
353           which is clearly not acceptable.
354

LICENSE

360       Copyrights 2001-2020 by [Mark Overmeer <markov@cpan.org>]. For other
361       contributors see ChangeLog.
362
363       This program is free software; you can redistribute it and/or modify it
364       under the same terms as Perl itself.  See http://dev.perl.org/licenses/
365
366
367
368perl v5.32.0                      2020-07-28    Mail::Message::Body::Nested(3)