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

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

NAME

6       Mail::Message::Body::String - body of a Mail::Message stored as single
7       string
8

INHERITANCE

10        Mail::Message::Body::String
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 will find the description of extra functionality you
20       have when a message is stored as a single scalar.
21
22       Storing a whole message in one string is only a smart choice when the
23       content is small or encoded. Even when stored as a scalar, you can
24       still treat the body as if the data is stored in lines or an external
25       file, but this will be slower.
26

OVERLOADED

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

METHODS

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

DETAILS

DIAGNOSTICS

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

LICENSE

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