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
25       Extends "DESCRIPTION" in Mail::Message::Body.
26

OVERLOADED

28       Extends "OVERLOADED" in Mail::Message::Body.
29
30       overload: ""
31           Inherited, see "OVERLOADED" in Mail::Message::Body
32
33       overload: '==' and '!='
34           Inherited, see "OVERLOADED" in Mail::Message::Body
35
36       overload: @{}
37           Inherited, see "OVERLOADED" in Mail::Message::Body
38
39       overload: bool
40           Inherited, see "OVERLOADED" in Mail::Message::Body
41

METHODS

43       Extends "METHODS" in Mail::Message::Body.
44
45   Constructors
46       Extends "Constructors" in Mail::Message::Body.
47
48       $obj->clone()
49           Inherited, see "Constructors" in Mail::Message::Body
50
51       Mail::Message::Body::File->new(%options)
52            -Option           --Defined in         --Default
53             based_on           Mail::Message::Body  undef
54             charset            Mail::Message::Body  'PERL'
55             checked            Mail::Message::Body  <false>
56             content_id         Mail::Message::Body  undef
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             filename           Mail::Message::Body  undef
63             log                Mail::Reporter       'WARNINGS'
64             message            Mail::Message::Body  undef
65             mime_type          Mail::Message::Body  'text/plain'
66             modified           Mail::Message::Body  <false>
67             trace              Mail::Reporter       'WARNINGS'
68             transfer_encoding  Mail::Message::Body  'none'
69
70           based_on => BODY
71           charset => CHARSET|'PERL'|<undef>
72           checked => BOOLEAN
73           content_id => STRING
74           data => ARRAY-OF-LINES | STRING
75           description => STRING|FIELD
76           disposition => STRING|FIELD
77           eol => 'CR'|'LF'|'CRLF'|'NATIVE'
78           file => FILENAME|FILEHANDLE|IOHANDLE
79           filename => FILENAME
80           log => LEVEL
81           message => MESSAGE
82           mime_type => STRING|FIELD|MIME
83           modified => BOOLEAN
84           trace => LEVEL
85           transfer_encoding => STRING|FIELD
86
87   Constructing a body
88       Extends "Constructing a body" in Mail::Message::Body.
89
90       $obj->attach($messages, %options)
91           Inherited, see "Constructing a body" in
92           Mail::Message::Body::Construct
93
94       $obj->charsetDetect(%options)
95           Inherited, see "Constructing a body" in Mail::Message::Body::Encode
96
97       Mail::Message::Body::File->charsetDetectAlgorithm( [CODE|undef|METHOD]
98       )
99           Inherited, see "Constructing a body" in Mail::Message::Body::Encode
100
101       $obj->check()
102           Inherited, see "Constructing a body" in Mail::Message::Body::Encode
103
104       $obj->concatenate($components)
105           Inherited, see "Constructing a body" in
106           Mail::Message::Body::Construct
107
108       $obj->decoded(%options)
109           Inherited, see "Constructing a body" in Mail::Message::Body
110
111       $obj->encode(%options)
112           Inherited, see "Constructing a body" in Mail::Message::Body::Encode
113
114       $obj->encoded(%options)
115           Inherited, see "Constructing a body" in Mail::Message::Body::Encode
116
117       $obj->eol( ['CR'|'LF'|'CRLF'|'NATIVE'] )
118           Inherited, see "Constructing a body" in Mail::Message::Body
119
120       $obj->foreachLine(CODE)
121           Inherited, see "Constructing a body" in
122           Mail::Message::Body::Construct
123
124       $obj->stripSignature(%options)
125           Inherited, see "Constructing a body" in
126           Mail::Message::Body::Construct
127
128       $obj->unify($body)
129           Inherited, see "Constructing a body" in Mail::Message::Body::Encode
130
131   The body
132       Extends "The body" in Mail::Message::Body.
133
134       $obj->isDelayed()
135           Inherited, see "The body" in Mail::Message::Body
136
137       $obj->isMultipart()
138           Inherited, see "The body" in Mail::Message::Body
139
140       $obj->isNested()
141           Inherited, see "The body" in Mail::Message::Body
142
143       $obj->message( [$message] )
144           Inherited, see "The body" in Mail::Message::Body
145
146       $obj->partNumberOf($part)
147           Inherited, see "The body" in Mail::Message::Body
148
149   About the payload
150       Extends "About the payload" in Mail::Message::Body.
151
152       $obj->charset()
153           Inherited, see "About the payload" in Mail::Message::Body
154
155       $obj->checked( [BOOLEAN] )
156           Inherited, see "About the payload" in Mail::Message::Body
157
158       $obj->contentId( [STRING|$field] )
159           Inherited, see "About the payload" in Mail::Message::Body
160
161       $obj->description( [STRING|$field] )
162           Inherited, see "About the payload" in Mail::Message::Body
163
164       $obj->disposition( [STRING|$field] )
165           Inherited, see "About the payload" in Mail::Message::Body
166
167       $obj->dispositionFilename( [$directory] )
168           Inherited, see "About the payload" in Mail::Message::Body::Encode
169
170       $obj->isBinary()
171           Inherited, see "About the payload" in Mail::Message::Body::Encode
172
173       $obj->isText()
174           Inherited, see "About the payload" in Mail::Message::Body::Encode
175
176       $obj->mimeType()
177           Inherited, see "About the payload" in Mail::Message::Body
178
179       $obj->nrLines()
180           Inherited, see "About the payload" in Mail::Message::Body
181
182       $obj->size()
183           Inherited, see "About the payload" in Mail::Message::Body
184
185       $obj->transferEncoding( [STRING|$field] )
186           Inherited, see "About the payload" in Mail::Message::Body
187
188       $obj->type( [STRING|$field] )
189           Inherited, see "About the payload" in Mail::Message::Body
190
191   Access to the payload
192       Extends "Access to the payload" in Mail::Message::Body.
193
194       $obj->endsOnNewline()
195           Inherited, see "Access to the payload" in Mail::Message::Body
196
197       $obj->file()
198           Inherited, see "Access to the payload" in Mail::Message::Body
199
200       $obj->lines()
201           Inherited, see "Access to the payload" in Mail::Message::Body
202
203       $obj->print( [$fh] )
204           Inherited, see "Access to the payload" in Mail::Message::Body
205
206       $obj->printEscapedFrom($fh)
207           Inherited, see "Access to the payload" in Mail::Message::Body
208
209       $obj->string()
210           Inherited, see "Access to the payload" in Mail::Message::Body
211
212       $obj->stripTrailingNewline()
213           Inherited, see "Access to the payload" in Mail::Message::Body
214
215       $obj->write(%options)
216           Inherited, see "Access to the payload" in Mail::Message::Body
217
218   Internals
219       Extends "Internals" in Mail::Message::Body.
220
221       $obj->addTransferEncHandler( $name, <$class|$object> )
222       Mail::Message::Body::File->addTransferEncHandler( $name,
223       <$class|$object> )
224           Inherited, see "Internals" in Mail::Message::Body::Encode
225
226       $obj->contentInfoFrom($head)
227           Inherited, see "Internals" in Mail::Message::Body
228
229       $obj->contentInfoTo($head)
230           Inherited, see "Internals" in Mail::Message::Body
231
232       $obj->fileLocation( [$begin, $end] )
233           Inherited, see "Internals" in Mail::Message::Body
234
235       $obj->getTransferEncHandler($type)
236           Inherited, see "Internals" in Mail::Message::Body::Encode
237
238       $obj->isModified()
239           Inherited, see "Internals" in Mail::Message::Body
240
241       $obj->load()
242           Inherited, see "Internals" in Mail::Message::Body
243
244       $obj->modified( [BOOLEAN] )
245           Inherited, see "Internals" in Mail::Message::Body
246
247       $obj->moveLocation( [$distance] )
248           Inherited, see "Internals" in Mail::Message::Body
249
250       $obj->read( $parser, $head, $bodytype, [$chars, [$lines]] )
251           Inherited, see "Internals" in Mail::Message::Body
252
253       $obj->tempFilename( [$filename] )
254           Returns the name of the temporary file which is used to store this
255           body.
256
257   Error handling
258       Extends "Error handling" in Mail::Message::Body.
259
260       $obj->AUTOLOAD()
261           Inherited, see "Error handling" in Mail::Message::Body
262
263       $obj->addReport($object)
264           Inherited, see "Error handling" in Mail::Reporter
265
266       $obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level,
267       $callback] )
268       Mail::Message::Body::File->defaultTrace( [$level]|[$loglevel,
269       $tracelevel]|[$level, $callback] )
270           Inherited, see "Error handling" in Mail::Reporter
271
272       $obj->errors()
273           Inherited, see "Error handling" in Mail::Reporter
274
275       $obj->log( [$level, [$strings]] )
276       Mail::Message::Body::File->log( [$level, [$strings]] )
277           Inherited, see "Error handling" in Mail::Reporter
278
279       $obj->logPriority($level)
280       Mail::Message::Body::File->logPriority($level)
281           Inherited, see "Error handling" in Mail::Reporter
282
283       $obj->logSettings()
284           Inherited, see "Error handling" in Mail::Reporter
285
286       $obj->notImplemented()
287           Inherited, see "Error handling" in Mail::Reporter
288
289       $obj->report( [$level] )
290           Inherited, see "Error handling" in Mail::Reporter
291
292       $obj->reportAll( [$level] )
293           Inherited, see "Error handling" in Mail::Reporter
294
295       $obj->trace( [$level] )
296           Inherited, see "Error handling" in Mail::Reporter
297
298       $obj->warnings()
299           Inherited, see "Error handling" in Mail::Reporter
300
301   Cleanup
302       Extends "Cleanup" in Mail::Message::Body.
303
304       $obj->DESTROY()
305           The temporary file is automatically removed when the body is not
306           required anymore.
307

DETAILS

309       Extends "DETAILS" in Mail::Message::Body.
310

DIAGNOSTICS

312       Error: Cannot write to temporary body file $filename: $!
313           The message body is to be stored in a temporary file (probably
314           because it is a large body), but for the indicated reason, this
315           file cannot be created.
316
317       Warning: Charset $name is not known
318           The encoding or decoding of a message body encounters a character
319           set which is not understood by Perl's Encode module.
320
321       Warning: No decoder defined for transfer encoding $name.
322           The data (message body) is encoded in a way which is not currently
323           understood, therefore no decoding (or recoding) can take place.
324
325       Warning: No encoder defined for transfer encoding $name.
326           The data (message body) has been decoded, but the required encoding
327           is unknown.  The decoded data is returned.
328
329       Error: Package $package does not implement $method.
330           Fatal error: the specific package (or one of its superclasses) does
331           not implement this method where it should. This message means that
332           some other related classes do implement this method however the
333           class at hand does not.  Probably you should investigate this and
334           probably inform the author of the package.
335
336       Error: Unable to read file $filename for message body file: $!
337           A Mail::Message::Body::File object is to be created from a named
338           file, but it is impossible to read that file to retrieve the lines
339           within.  Therefore, no copy to a temporary file can be made.
340
341       Warning: Unknown line terminator $eol ignored
342

LICENSE

348       Copyrights 2001-2023 by [Mark Overmeer <markov@cpan.org>]. For other
349       contributors see ChangeLog.
350
351       This program is free software; you can redistribute it and/or modify it
352       under the same terms as Perl itself.  See http://dev.perl.org/licenses/
353
354
355
356perl v5.38.0                      2023-07-20      Mail::Message::Body::File(3)