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           See "OVERLOADED" in Mail::Message::Body
28
29       overload: '==' and '!='
30           See "OVERLOADED" in Mail::Message::Body
31
32       overload: @{}
33           See "OVERLOADED" in Mail::Message::Body
34
35       overload: bool
36           See "OVERLOADED" in Mail::Message::Body
37

METHODS

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

DIAGNOSTICS

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

LICENSE

308       Copyrights 2001-2011 by Mark Overmeer. For other contributors see
309       ChangeLog.
310
311       This program is free software; you can redistribute it and/or modify it
312       under the same terms as Perl itself.  See
313       http://www.perl.com/perl/misc/Artistic.html
314
315
316
317perl v5.12.3                      2011-01-26      Mail::Message::Body::File(3)