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

OVERLOADED

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

METHODS

40   Constructors
41       $obj->clone
42           See "Constructors" in Mail::Message::Body
43
44       Mail::Message::Body::Lines->new(OPTIONS)
45            -Option           --Defined in     --Default
46             based_on           Mail::Message::Body  undef
47             charset            Mail::Message::Body  'PERL' or <undef>
48             checked            Mail::Message::Body  <false>
49             data               Mail::Message::Body  undef
50             description        Mail::Message::Body  undef
51             disposition        Mail::Message::Body  undef
52             eol                Mail::Message::Body  'NATIVE'
53             file               Mail::Message::Body  undef
54             log                Mail::Reporter   'WARNINGS'
55             message            Mail::Message::Body  undef
56             mime_type          Mail::Message::Body  'text/plain'
57             modified           Mail::Message::Body  <false>
58             trace              Mail::Reporter   'WARNINGS'
59             transfer_encoding  Mail::Message::Body  'none'
60
61           based_on => BODY
62           charset => CHARSET|'PERL'
63           checked => BOOLEAN
64           data => ARRAY-OF-LINES | STRING
65           description => STRING|FIELD
66           disposition => STRING|FIELD
67           eol => 'CR'|'LF'|'CRLF'|'NATIVE'
68           file => FILENAME|FILEHANDLE|IOHANDLE
69           log => LEVEL
70           message => MESSAGE
71           mime_type => STRING|FIELD|MIME
72           modified => BOOLEAN
73           trace => LEVEL
74           transfer_encoding => STRING|FIELD
75
76   Constructing a body
77       $obj->attach(MESSAGES, OPTIONS)
78           See "Constructing a body" in Mail::Message::Body::Construct
79
80       $obj->check
81           See "Constructing a body" in Mail::Message::Body::Encode
82
83       $obj->concatenate(COMPONENTS)
84           See "Constructing a body" in Mail::Message::Body::Construct
85
86       $obj->decoded(OPTIONS)
87           See "Constructing a body" in Mail::Message::Body
88
89       $obj->encode(OPTIONS)
90           See "Constructing a body" in Mail::Message::Body::Encode
91
92       $obj->encoded
93           See "Constructing a body" in Mail::Message::Body::Encode
94
95       $obj->eol(['CR'|'LF'|'CRLF'|'NATIVE'])
96           See "Constructing a body" in Mail::Message::Body
97
98       $obj->foreachLine(CODE)
99           See "Constructing a body" in Mail::Message::Body::Construct
100
101       $obj->stripSignature(OPTIONS)
102           See "Constructing a body" in Mail::Message::Body::Construct
103
104       $obj->unify(BODY)
105           See "Constructing a body" in Mail::Message::Body::Encode
106
107   The body
108       $obj->isDelayed
109           See "The body" in Mail::Message::Body
110
111       $obj->isMultipart
112           See "The body" in Mail::Message::Body
113
114       $obj->isNested
115           See "The body" in Mail::Message::Body
116
117       $obj->message([MESSAGE])
118           See "The body" in Mail::Message::Body
119
120   About the payload
121       $obj->charset
122           See "About the payload" in Mail::Message::Body
123
124       $obj->checked([BOOLEAN])
125           See "About the payload" in Mail::Message::Body
126
127       $obj->description([STRING|FIELD])
128           See "About the payload" in Mail::Message::Body
129
130       $obj->disposition([STRING|FIELD])
131           See "About the payload" in Mail::Message::Body
132
133       $obj->dispositionFilename([DIRECTORY])
134           See "About the payload" in Mail::Message::Body::Encode
135
136       $obj->isBinary
137           See "About the payload" in Mail::Message::Body::Encode
138
139       $obj->isText
140           See "About the payload" in Mail::Message::Body::Encode
141
142       $obj->mimeType
143           See "About the payload" in Mail::Message::Body
144
145       $obj->nrLines
146           See "About the payload" in Mail::Message::Body
147
148       $obj->size
149           See "About the payload" in Mail::Message::Body
150
151       $obj->transferEncoding([STRING|FIELD])
152           See "About the payload" in Mail::Message::Body
153
154       $obj->type([STRING|FIELD])
155           See "About the payload" in Mail::Message::Body
156
157   Access to the payload
158       $obj->endsOnNewline
159           See "Access to the payload" in Mail::Message::Body
160
161       $obj->file
162           See "Access to the payload" in Mail::Message::Body
163
164       $obj->lines
165           See "Access to the payload" in Mail::Message::Body
166
167       $obj->print([FILEHANDLE])
168           See "Access to the payload" in Mail::Message::Body
169
170       $obj->printEscapedFrom(FILEHANDLE)
171           See "Access to the payload" in Mail::Message::Body
172
173       $obj->string
174           See "Access to the payload" in Mail::Message::Body
175
176       $obj->stripTrailingNewline
177           See "Access to the payload" in Mail::Message::Body
178
179       $obj->write(OPTIONS)
180           See "Access to the payload" in Mail::Message::Body
181
182   Internals
183       $obj->addTransferEncHandler(NAME, CLASS|OBJECT)
184           Mail::Message::Body::Lines->addTransferEncHandler(NAME,
185           CLASS|OBJECT)
186
187           See "Internals" in Mail::Message::Body::Encode
188
189       $obj->contentInfoFrom(HEAD)
190           See "Internals" in Mail::Message::Body
191
192       $obj->contentInfoTo(HEAD)
193           See "Internals" in Mail::Message::Body
194
195       $obj->fileLocation([BEGIN,END])
196           See "Internals" in Mail::Message::Body
197
198       $obj->getTransferEncHandler(TYPE)
199           See "Internals" in Mail::Message::Body::Encode
200
201       $obj->isModified
202           See "Internals" in Mail::Message::Body
203
204       $obj->load
205           See "Internals" in Mail::Message::Body
206
207       $obj->modified([BOOLEAN])
208           See "Internals" in Mail::Message::Body
209
210       $obj->moveLocation([DISTANCE])
211           See "Internals" in Mail::Message::Body
212
213       $obj->read(PARSER, HEAD, BODYTYPE [,CHARS [,LINES]])
214           See "Internals" in Mail::Message::Body
215
216   Error handling
217       $obj->AUTOLOAD
218           See "Error handling" in Mail::Message::Body
219
220       $obj->addReport(OBJECT)
221           See "Error handling" in Mail::Reporter
222
223       $obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
224           Mail::Message::Body::Lines->defaultTrace([LEVEL]|[LOGLEVEL,
225           TRACELEVEL]|[LEVEL, CALLBACK])
226
227           See "Error handling" in Mail::Reporter
228
229       $obj->errors
230           See "Error handling" in Mail::Reporter
231
232       $obj->log([LEVEL [,STRINGS]])
233           Mail::Message::Body::Lines->log([LEVEL [,STRINGS]])
234
235           See "Error handling" in Mail::Reporter
236
237       $obj->logPriority(LEVEL)
238           Mail::Message::Body::Lines->logPriority(LEVEL)
239
240           See "Error handling" in Mail::Reporter
241
242       $obj->logSettings
243           See "Error handling" in Mail::Reporter
244
245       $obj->notImplemented
246           See "Error handling" in Mail::Reporter
247
248       $obj->report([LEVEL])
249           See "Error handling" in Mail::Reporter
250
251       $obj->reportAll([LEVEL])
252           See "Error handling" in Mail::Reporter
253
254       $obj->trace([LEVEL])
255           See "Error handling" in Mail::Reporter
256
257       $obj->warnings
258           See "Error handling" in Mail::Reporter
259
260   Cleanup
261       $obj->DESTROY
262           See "Cleanup" in Mail::Reporter
263
264       $obj->inGlobalDestruction
265           See "Cleanup" in Mail::Reporter
266

DIAGNOSTICS

268       Warning: Charset $name is not known
269           The encoding or decoding of a message body encounters a character
270           set which is not understood by Perl's Encode module.
271
272       Warning: No decoder defined for transfer encoding $name.
273           The data (message body) is encoded in a way which is not currently
274           understood, therefore no decoding (or recoding) can take place.
275
276       Warning: No encoder defined for transfer encoding $name.
277           The data (message body) has been decoded, but the required encoding
278           is unknown.  The decoded data is returned.
279
280       Error: Package $package does not implement $method.
281           Fatal error: the specific package (or one of its superclasses) does
282           not implement this method where it should. This message means that
283           some other related classes do implement this method however the
284           class at hand does not.  Probably you should investigate this and
285           probably inform the author of the package.
286
287       Error: Unable to read file $filename for message body lines: $!
288           A Mail::Message::Body::Lines object is to be created from a named
289           file, but it is impossible to read that file to retrieve the lines
290           within.
291
292       Warning: Unknown line terminator $eol ignored
293

LICENSE

299       Copyrights 2001-2011 by Mark Overmeer. For other contributors see
300       ChangeLog.
301
302       This program is free software; you can redistribute it and/or modify it
303       under the same terms as Perl itself.  See
304       http://www.perl.com/perl/misc/Artistic.html
305
306
307
308perl v5.12.3                      2011-01-26     Mail::Message::Body::Lines(3)