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

1Mail::Message::Body::LiUnseesr(3C)ontributed Perl DocumeMnatialt:i:oMnessage::Body::Lines(3)
2
3
4

NAME

6       Mail::Message::Body::Lines - body of a Mail::Message stored as array of
7       lines
8

INHERITANCE

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

SYNOPSIS

15        See Mail::Message::Body
16

DESCRIPTION

18       The body (content) of a message can be stored in various ways.  In this
19       documentation you find the description of extra functionality you have
20       when a message is stored in an array of lines.
21
22       Storing a whole message as an array of lines is useful when the data is
23       not encoded, and you want to process it on a line-by-line basis (a
24       common practice for inspecting message bodies).
25
26       Extends "DESCRIPTION" in Mail::Message::Body.
27

OVERLOADED

29       Extends "OVERLOADED" in Mail::Message::Body.
30
31       overload: ""
32           Inherited, see "OVERLOADED" in Mail::Message::Body
33
34       overload: '==' and '!='
35           Inherited, see "OVERLOADED" in Mail::Message::Body
36
37       overload: @{}
38           Inherited, see "OVERLOADED" in Mail::Message::Body
39
40       overload: bool
41           Inherited, see "OVERLOADED" in Mail::Message::Body
42

METHODS

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

DETAILS

305       Extends "DETAILS" in Mail::Message::Body.
306

DIAGNOSTICS

308       Warning: Charset $name is not known
309           The encoding or decoding of a message body encounters a character
310           set which is not understood by Perl's Encode module.
311
312       Warning: No decoder defined for transfer encoding $name.
313           The data (message body) is encoded in a way which is not currently
314           understood, therefore no decoding (or recoding) can take place.
315
316       Warning: No encoder defined for transfer encoding $name.
317           The data (message body) has been decoded, but the required encoding
318           is unknown.  The decoded data is returned.
319
320       Error: Package $package does not implement $method.
321           Fatal error: the specific package (or one of its superclasses) does
322           not implement this method where it should. This message means that
323           some other related classes do implement this method however the
324           class at hand does not.  Probably you should investigate this and
325           probably inform the author of the package.
326
327       Error: Unable to read file $filename for message body lines: $!
328           A Mail::Message::Body::Lines object is to be created from a named
329           file, but it is impossible to read that file to retrieve the lines
330           within.
331
332       Warning: Unknown line terminator $eol ignored
333

LICENSE

339       Copyrights 2001-2023 by [Mark Overmeer <markov@cpan.org>]. For other
340       contributors see ChangeLog.
341
342       This program is free software; you can redistribute it and/or modify it
343       under the same terms as Perl itself.  See http://dev.perl.org/licenses/
344
345
346
347perl v5.38.0                      2023-07-20     Mail::Message::Body::Lines(3)