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 com‐
24       mon practice for inspecting message bodies).
25

OVERLOADED

27       overload: ""
28
29           See "OVERLOADED" in Mail::Message::Body
30
31       overload: '==' and '!='
32
33           See "OVERLOADED" in Mail::Message::Body
34
35       overload: @{}
36
37           See "OVERLOADED" in Mail::Message::Body
38
39       overload: bool
40
41           See "OVERLOADED" in Mail::Message::Body
42

METHODS

44       Constructors
45
46       $obj->clone
47
48           See "Constructors" in Mail::Message::Body
49
50       Mail::Message::Body::Lines->new(OPTIONS)
51
52        Option           --Defined in     --Default
53        based_on           Mail::Message::Body  undef
54        charset            Mail::Message::Body  'us-ascii'
55        checked            Mail::Message::Body  <false>
56        data               Mail::Message::Body  undef
57        description        Mail::Message::Body  undef
58        disposition        Mail::Message::Body  undef
59        eol                Mail::Message::Body  'NATIVE'
60        file               Mail::Message::Body  undef
61        log                Mail::Reporter   'WARNINGS'
62        message            Mail::Message::Body  undef
63        mime_type          Mail::Message::Body  'text/plain'
64        modified           Mail::Message::Body  <false>
65        trace              Mail::Reporter   'WARNINGS'
66        transfer_encoding  Mail::Message::Body  'none'
67
68           . based_on BODY
69
70           . charset STRING
71
72           . checked BOOLEAN
73
74           . data ARRAY-OF-LINES ⎪ STRING
75
76           . description STRING⎪FIELD
77
78           . disposition STRING⎪FIELD
79
80           . eol 'CR'⎪'LF'⎪'CRLF'⎪'NATIVE'
81
82           . file FILENAME⎪FILEHANDLE⎪IOHANDLE
83
84           . log LEVEL
85
86           . message MESSAGE
87
88           . mime_type STRING⎪FIELD⎪MIME
89
90           . modified BOOLEAN
91
92           . trace LEVEL
93
94           . transfer_encoding STRING⎪FIELD
95
96       Constructing a body
97
98       $obj->attach(MESSAGES, OPTIONS)
99
100           See "Constructing a body" in Mail::Message::Body::Construct
101
102       $obj->check
103
104           See "Constructing a body" in Mail::Message::Body::Encode
105
106       $obj->concatenate(COMPONENTS)
107
108           See "Constructing a body" in Mail::Message::Body::Construct
109
110       $obj->decoded(OPTIONS)
111
112           See "Constructing a body" in Mail::Message::Body
113
114       $obj->encode(OPTIONS)
115
116           See "Constructing a body" in Mail::Message::Body::Encode
117
118       $obj->encoded
119
120           See "Constructing a body" in Mail::Message::Body::Encode
121
122       $obj->eol(['CR'⎪'LF'⎪'CRLF'⎪'NATIVE'])
123
124           See "Constructing a body" in Mail::Message::Body
125
126       $obj->foreachLine(CODE)
127
128           See "Constructing a body" in Mail::Message::Body::Construct
129
130       $obj->stripSignature(OPTIONS)
131
132           See "Constructing a body" in Mail::Message::Body::Construct
133
134       $obj->unify(BODY)
135
136           See "Constructing a body" in Mail::Message::Body::Encode
137
138       The body
139
140       $obj->isDelayed
141
142           See "The body" in Mail::Message::Body
143
144       $obj->isMultipart
145
146           See "The body" in Mail::Message::Body
147
148       $obj->isNested
149
150           See "The body" in Mail::Message::Body
151
152       $obj->message([MESSAGE])
153
154           See "The body" in Mail::Message::Body
155
156       About the payload
157
158       $obj->charset
159
160           See "About the payload" in Mail::Message::Body
161
162       $obj->checked([BOOLEAN])
163
164           See "About the payload" in Mail::Message::Body
165
166       $obj->description([STRING⎪FIELD])
167
168           See "About the payload" in Mail::Message::Body
169
170       $obj->disposition([STRING⎪FIELD])
171
172           See "About the payload" in Mail::Message::Body
173
174       $obj->dispositionFilename([DIRECTORY])
175
176           See "About the payload" in Mail::Message::Body::Encode
177
178       $obj->isBinary
179
180           See "About the payload" in Mail::Message::Body::Encode
181
182       $obj->isText
183
184           See "About the payload" in Mail::Message::Body::Encode
185
186       $obj->mimeType
187
188           See "About the payload" in Mail::Message::Body
189
190       $obj->nrLines
191
192           See "About the payload" in Mail::Message::Body
193
194       $obj->size
195
196           See "About the payload" in Mail::Message::Body
197
198       $obj->transferEncoding([STRING⎪FIELD])
199
200           See "About the payload" in Mail::Message::Body
201
202       $obj->type([STRING⎪FIELD])
203
204           See "About the payload" in Mail::Message::Body
205
206       Access to the payload
207
208       $obj->endsOnNewline
209
210           See "Access to the payload" in Mail::Message::Body
211
212       $obj->file
213
214           See "Access to the payload" in Mail::Message::Body
215
216       $obj->lines
217
218           See "Access to the payload" in Mail::Message::Body
219
220       $obj->print([FILEHANDLE])
221
222           See "Access to the payload" in Mail::Message::Body
223
224       $obj->printEscapedFrom(FILEHANDLE)
225
226           See "Access to the payload" in Mail::Message::Body
227
228       $obj->string
229
230           See "Access to the payload" in Mail::Message::Body
231
232       $obj->stripTrailingNewline
233
234           See "Access to the payload" in Mail::Message::Body
235
236       $obj->write(OPTIONS)
237
238           See "Access to the payload" in Mail::Message::Body
239
240       Internals
241
242       $obj->addTransferEncHandler(NAME, CLASS⎪OBJECT)
243
244       Mail::Message::Body::Lines->addTransferEncHandler(NAME, CLASS⎪OBJECT)
245
246           See "Internals" in Mail::Message::Body::Encode
247
248       $obj->contentInfoFrom(HEAD)
249
250           See "Internals" in Mail::Message::Body
251
252       $obj->contentInfoTo(HEAD)
253
254           See "Internals" in Mail::Message::Body
255
256       $obj->fileLocation([BEGIN,END])
257
258           See "Internals" in Mail::Message::Body
259
260       $obj->getTransferEncHandler(TYPE)
261
262           See "Internals" in Mail::Message::Body::Encode
263
264       $obj->isModified
265
266           See "Internals" in Mail::Message::Body
267
268       $obj->load
269
270           See "Internals" in Mail::Message::Body
271
272       $obj->modified([BOOLEAN])
273
274           See "Internals" in Mail::Message::Body
275
276       $obj->moveLocation([DISTANCE])
277
278           See "Internals" in Mail::Message::Body
279
280       $obj->read(PARSER, HEAD, BODYTYPE [,CHARS [,LINES]])
281
282           See "Internals" in Mail::Message::Body
283
284       Error handling
285
286       $obj->AUTOLOAD
287
288           See "Error handling" in Mail::Message::Body
289
290       $obj->addReport(OBJECT)
291
292           See "Error handling" in Mail::Reporter
293
294       $obj->defaultTrace([LEVEL]⎪[LOGLEVEL, TRACELEVEL]⎪[LEVEL, CALLBACK])
295
296       Mail::Message::Body::Lines->defaultTrace([LEVEL]⎪[LOGLEVEL,
297       TRACELEVEL]⎪[LEVEL, CALLBACK])
298
299           See "Error handling" in Mail::Reporter
300
301       $obj->errors
302
303           See "Error handling" in Mail::Reporter
304
305       $obj->log([LEVEL [,STRINGS]])
306
307       Mail::Message::Body::Lines->log([LEVEL [,STRINGS]])
308
309           See "Error handling" in Mail::Reporter
310
311       $obj->logPriority(LEVEL)
312
313       Mail::Message::Body::Lines->logPriority(LEVEL)
314
315           See "Error handling" in Mail::Reporter
316
317       $obj->logSettings
318
319           See "Error handling" in Mail::Reporter
320
321       $obj->notImplemented
322
323           See "Error handling" in Mail::Reporter
324
325       $obj->report([LEVEL])
326
327           See "Error handling" in Mail::Reporter
328
329       $obj->reportAll([LEVEL])
330
331           See "Error handling" in Mail::Reporter
332
333       $obj->trace([LEVEL])
334
335           See "Error handling" in Mail::Reporter
336
337       $obj->warnings
338
339           See "Error handling" in Mail::Reporter
340
341       Cleanup
342
343       $obj->DESTROY
344
345           See "Cleanup" in Mail::Reporter
346
347       $obj->inGlobalDestruction
348
349           See "Cleanup" in Mail::Reporter
350

DETAILS

DIAGNOSTICS

353       Warning: No decoder defined for transfer encoding $name.
354
355       The data (message body) is encoded in a way which is not currently
356       understood, therefore no decoding (or recoding) can take place.
357
358       Warning: No encoder defined for transfer encoding $name.
359
360       The data (message body) has been decoded, but the required encoding is
361       unknown.  The decoded data is returned.
362
363       Error: Package $package does not implement $method.
364
365       Fatal error: the specific package (or one of its superclasses) does not
366       implement this method where it should. This message means that some
367       other related classes do implement this method however the class at
368       hand does not.  Probably you should investigate this and probably
369       inform the author of the package.
370
371       Error: Unable to read file $filename for message body lines: $!
372
373       A Mail::Message::Body::Lines object is to be created from a named file,
374       but it is impossible to read that file to retrieve the lines within.
375

LICENSE

381       Copyrights 2001-2007 by Mark Overmeer.For other contributors see
382       ChangeLog.
383
384       This program is free software; you can redistribute it and/or modify it
385       under the same terms as Perl itself.  See
386       http://www.perl.com/perl/misc/Artistic.html
387
388
389
390perl v5.8.8                       2007-03-25     Mail::Message::Body::Lines(3)