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' or <undef>
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'
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->check()
96           Inherited, see "Constructing a body" in Mail::Message::Body::Encode
97
98       $obj->concatenate($components)
99           Inherited, see "Constructing a body" in
100           Mail::Message::Body::Construct
101
102       $obj->decoded(%options)
103           Inherited, see "Constructing a body" in Mail::Message::Body
104
105       $obj->encode(%options)
106           Inherited, see "Constructing a body" in Mail::Message::Body::Encode
107
108       $obj->encoded()
109           Inherited, see "Constructing a body" in Mail::Message::Body::Encode
110
111       $obj->eol( ['CR'|'LF'|'CRLF'|'NATIVE'] )
112           Inherited, see "Constructing a body" in Mail::Message::Body
113
114       $obj->foreachLine(CODE)
115           Inherited, see "Constructing a body" in
116           Mail::Message::Body::Construct
117
118       $obj->stripSignature(%options)
119           Inherited, see "Constructing a body" in
120           Mail::Message::Body::Construct
121
122       $obj->unify($body)
123           Inherited, see "Constructing a body" in Mail::Message::Body::Encode
124
125   The body
126       Extends "The body" in Mail::Message::Body.
127
128       $obj->isDelayed()
129           Inherited, see "The body" in Mail::Message::Body
130
131       $obj->isMultipart()
132           Inherited, see "The body" in Mail::Message::Body
133
134       $obj->isNested()
135           Inherited, see "The body" in Mail::Message::Body
136
137       $obj->message( [$message] )
138           Inherited, see "The body" in Mail::Message::Body
139
140       $obj->partNumberOf($part)
141           Inherited, see "The body" in Mail::Message::Body
142
143   About the payload
144       Extends "About the payload" in Mail::Message::Body.
145
146       $obj->charset()
147           Inherited, see "About the payload" in Mail::Message::Body
148
149       $obj->checked( [BOOLEAN] )
150           Inherited, see "About the payload" in Mail::Message::Body
151
152       $obj->contentId( [STRING|$field] )
153           Inherited, see "About the payload" in Mail::Message::Body
154
155       $obj->description( [STRING|$field] )
156           Inherited, see "About the payload" in Mail::Message::Body
157
158       $obj->disposition( [STRING|$field] )
159           Inherited, see "About the payload" in Mail::Message::Body
160
161       $obj->dispositionFilename( [$directory] )
162           Inherited, see "About the payload" in Mail::Message::Body::Encode
163
164       $obj->isBinary()
165           Inherited, see "About the payload" in Mail::Message::Body::Encode
166
167       $obj->isText()
168           Inherited, see "About the payload" in Mail::Message::Body::Encode
169
170       $obj->mimeType()
171           Inherited, see "About the payload" in Mail::Message::Body
172
173       $obj->nrLines()
174           Inherited, see "About the payload" in Mail::Message::Body
175
176       $obj->size()
177           Inherited, see "About the payload" in Mail::Message::Body
178
179       $obj->transferEncoding( [STRING|$field] )
180           Inherited, see "About the payload" in Mail::Message::Body
181
182       $obj->type( [STRING|$field] )
183           Inherited, see "About the payload" in Mail::Message::Body
184
185   Access to the payload
186       Extends "Access to the payload" in Mail::Message::Body.
187
188       $obj->endsOnNewline()
189           Inherited, see "Access to the payload" in Mail::Message::Body
190
191       $obj->file()
192           Inherited, see "Access to the payload" in Mail::Message::Body
193
194       $obj->lines()
195           Inherited, see "Access to the payload" in Mail::Message::Body
196
197       $obj->print( [$fh] )
198           Inherited, see "Access to the payload" in Mail::Message::Body
199
200       $obj->printEscapedFrom($fh)
201           Inherited, see "Access to the payload" in Mail::Message::Body
202
203       $obj->string()
204           Inherited, see "Access to the payload" in Mail::Message::Body
205
206       $obj->stripTrailingNewline()
207           Inherited, see "Access to the payload" in Mail::Message::Body
208
209       $obj->write(%options)
210           Inherited, see "Access to the payload" in Mail::Message::Body
211
212   Internals
213       Extends "Internals" in Mail::Message::Body.
214
215       $obj->addTransferEncHandler( $name, <$class|$object> )
216       Mail::Message::Body::Lines->addTransferEncHandler( $name,
217       <$class|$object> )
218           Inherited, see "Internals" in Mail::Message::Body::Encode
219
220       $obj->contentInfoFrom($head)
221           Inherited, see "Internals" in Mail::Message::Body
222
223       $obj->contentInfoTo($head)
224           Inherited, see "Internals" in Mail::Message::Body
225
226       $obj->fileLocation( [$begin, $end] )
227           Inherited, see "Internals" in Mail::Message::Body
228
229       $obj->getTransferEncHandler($type)
230           Inherited, see "Internals" in Mail::Message::Body::Encode
231
232       $obj->isModified()
233           Inherited, see "Internals" in Mail::Message::Body
234
235       $obj->load()
236           Inherited, see "Internals" in Mail::Message::Body
237
238       $obj->modified( [BOOLEAN] )
239           Inherited, see "Internals" in Mail::Message::Body
240
241       $obj->moveLocation( [$distance] )
242           Inherited, see "Internals" in Mail::Message::Body
243
244       $obj->read( $parser, $head, $bodytype, [$chars, [$lines]] )
245           Inherited, see "Internals" in Mail::Message::Body
246
247   Error handling
248       Extends "Error handling" in Mail::Message::Body.
249
250       $obj->AUTOLOAD()
251           Inherited, see "Error handling" in Mail::Message::Body
252
253       $obj->addReport($object)
254           Inherited, see "Error handling" in Mail::Reporter
255
256       $obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level,
257       $callback] )
258       Mail::Message::Body::Lines->defaultTrace( [$level]|[$loglevel,
259       $tracelevel]|[$level, $callback] )
260           Inherited, see "Error handling" in Mail::Reporter
261
262       $obj->errors()
263           Inherited, see "Error handling" in Mail::Reporter
264
265       $obj->log( [$level, [$strings]] )
266       Mail::Message::Body::Lines->log( [$level, [$strings]] )
267           Inherited, see "Error handling" in Mail::Reporter
268
269       $obj->logPriority($level)
270       Mail::Message::Body::Lines->logPriority($level)
271           Inherited, see "Error handling" in Mail::Reporter
272
273       $obj->logSettings()
274           Inherited, see "Error handling" in Mail::Reporter
275
276       $obj->notImplemented()
277           Inherited, see "Error handling" in Mail::Reporter
278
279       $obj->report( [$level] )
280           Inherited, see "Error handling" in Mail::Reporter
281
282       $obj->reportAll( [$level] )
283           Inherited, see "Error handling" in Mail::Reporter
284
285       $obj->trace( [$level] )
286           Inherited, see "Error handling" in Mail::Reporter
287
288       $obj->warnings()
289           Inherited, see "Error handling" in Mail::Reporter
290
291   Cleanup
292       Extends "Cleanup" in Mail::Message::Body.
293
294       $obj->DESTROY()
295           Inherited, see "Cleanup" in Mail::Reporter
296

DETAILS

298       Extends "DETAILS" in Mail::Message::Body.
299

DIAGNOSTICS

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

LICENSE

332       Copyrights 2001-2019 by [Mark Overmeer <markov@cpan.org>]. For other
333       contributors see ChangeLog.
334
335       This program is free software; you can redistribute it and/or modify it
336       under the same terms as Perl itself.  See http://dev.perl.org/licenses/
337
338
339
340perl v5.30.0                      2019-07-26     Mail::Message::Body::Lines(3)