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

1Mail::Message::Body::FiUlsee(r3)Contributed Perl DocumenMtaaitli:o:nMessage::Body::File(3)
2
3
4

NAME

6       Mail::Message::Body::File - body of a message temporarily stored in a
7       file
8

INHERITANCE

10        Mail::Message::Body::File
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 a file.
21
22       Storing a whole message is a file is useful when the body is large.
23       Although access through a file is slower, it is saving a lot of memory.
24

OVERLOADED

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

METHODS

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

DETAILS

DIAGNOSTICS

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

LICENSE

393       Copyrights 2001-2007 by Mark Overmeer.For other contributors see
394       ChangeLog.
395
396       This program is free software; you can redistribute it and/or modify it
397       under the same terms as Perl itself.  See
398       http://www.perl.com/perl/misc/Artistic.html
399
400
401
402perl v5.8.8                       2007-03-25      Mail::Message::Body::File(3)