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' or <undef>
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'
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->check()
95           Inherited, see "Constructing a body" in Mail::Message::Body::Encode
96
97       $obj->concatenate($components)
98           Inherited, see "Constructing a body" in
99           Mail::Message::Body::Construct
100
101       $obj->decoded(%options)
102           Inherited, see "Constructing a body" in Mail::Message::Body
103
104       $obj->encode(%options)
105           Inherited, see "Constructing a body" in Mail::Message::Body::Encode
106
107       $obj->encoded()
108           Inherited, see "Constructing a body" in Mail::Message::Body::Encode
109
110       $obj->eol( ['CR'|'LF'|'CRLF'|'NATIVE'] )
111           Inherited, see "Constructing a body" in Mail::Message::Body
112
113       $obj->foreachLine(CODE)
114           Inherited, see "Constructing a body" in
115           Mail::Message::Body::Construct
116
117       $obj->stripSignature(%options)
118           Inherited, see "Constructing a body" in
119           Mail::Message::Body::Construct
120
121       $obj->unify($body)
122           Inherited, see "Constructing a body" in Mail::Message::Body::Encode
123
124   The body
125       Extends "The body" in Mail::Message::Body.
126
127       $obj->isDelayed()
128           Inherited, see "The body" in Mail::Message::Body
129
130       $obj->isMultipart()
131           Inherited, see "The body" in Mail::Message::Body
132
133       $obj->isNested()
134           Inherited, see "The body" in Mail::Message::Body
135
136       $obj->message( [$message] )
137           Inherited, see "The body" in Mail::Message::Body
138
139       $obj->partNumberOf($part)
140           Inherited, see "The body" in Mail::Message::Body
141
142   About the payload
143       Extends "About the payload" in Mail::Message::Body.
144
145       $obj->charset()
146           Inherited, see "About the payload" in Mail::Message::Body
147
148       $obj->checked( [BOOLEAN] )
149           Inherited, see "About the payload" in Mail::Message::Body
150
151       $obj->contentId( [STRING|$field] )
152           Inherited, see "About the payload" in Mail::Message::Body
153
154       $obj->description( [STRING|$field] )
155           Inherited, see "About the payload" in Mail::Message::Body
156
157       $obj->disposition( [STRING|$field] )
158           Inherited, see "About the payload" in Mail::Message::Body
159
160       $obj->dispositionFilename( [$directory] )
161           Inherited, see "About the payload" in Mail::Message::Body::Encode
162
163       $obj->isBinary()
164           Inherited, see "About the payload" in Mail::Message::Body::Encode
165
166       $obj->isText()
167           Inherited, see "About the payload" in Mail::Message::Body::Encode
168
169       $obj->mimeType()
170           Inherited, see "About the payload" in Mail::Message::Body
171
172       $obj->nrLines()
173           Inherited, see "About the payload" in Mail::Message::Body
174
175       $obj->size()
176           Inherited, see "About the payload" in Mail::Message::Body
177
178       $obj->transferEncoding( [STRING|$field] )
179           Inherited, see "About the payload" in Mail::Message::Body
180
181       $obj->type( [STRING|$field] )
182           Inherited, see "About the payload" in Mail::Message::Body
183
184   Access to the payload
185       Extends "Access to the payload" in Mail::Message::Body.
186
187       $obj->endsOnNewline()
188           Inherited, see "Access to the payload" in Mail::Message::Body
189
190       $obj->file()
191           Inherited, see "Access to the payload" in Mail::Message::Body
192
193       $obj->lines()
194           Inherited, see "Access to the payload" in Mail::Message::Body
195
196       $obj->print( [$fh] )
197           Inherited, see "Access to the payload" in Mail::Message::Body
198
199       $obj->printEscapedFrom($fh)
200           Inherited, see "Access to the payload" in Mail::Message::Body
201
202       $obj->string()
203           Inherited, see "Access to the payload" in Mail::Message::Body
204
205       $obj->stripTrailingNewline()
206           Inherited, see "Access to the payload" in Mail::Message::Body
207
208       $obj->write(%options)
209           Inherited, see "Access to the payload" in Mail::Message::Body
210
211   Internals
212       Extends "Internals" in Mail::Message::Body.
213
214       $obj->addTransferEncHandler( $name, <$class|$object> )
215       Mail::Message::Body::File->addTransferEncHandler( $name,
216       <$class|$object> )
217           Inherited, see "Internals" in Mail::Message::Body::Encode
218
219       $obj->contentInfoFrom($head)
220           Inherited, see "Internals" in Mail::Message::Body
221
222       $obj->contentInfoTo($head)
223           Inherited, see "Internals" in Mail::Message::Body
224
225       $obj->fileLocation( [$begin, $end] )
226           Inherited, see "Internals" in Mail::Message::Body
227
228       $obj->getTransferEncHandler($type)
229           Inherited, see "Internals" in Mail::Message::Body::Encode
230
231       $obj->isModified()
232           Inherited, see "Internals" in Mail::Message::Body
233
234       $obj->load()
235           Inherited, see "Internals" in Mail::Message::Body
236
237       $obj->modified( [BOOLEAN] )
238           Inherited, see "Internals" in Mail::Message::Body
239
240       $obj->moveLocation( [$distance] )
241           Inherited, see "Internals" in Mail::Message::Body
242
243       $obj->read( $parser, $head, $bodytype, [$chars, [$lines]] )
244           Inherited, see "Internals" in Mail::Message::Body
245
246       $obj->tempFilename( [$filename] )
247           Returns the name of the temporary file which is used to store this
248           body.
249
250   Error handling
251       Extends "Error handling" in Mail::Message::Body.
252
253       $obj->AUTOLOAD()
254           Inherited, see "Error handling" in Mail::Message::Body
255
256       $obj->addReport($object)
257           Inherited, see "Error handling" in Mail::Reporter
258
259       $obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level,
260       $callback] )
261       Mail::Message::Body::File->defaultTrace( [$level]|[$loglevel,
262       $tracelevel]|[$level, $callback] )
263           Inherited, see "Error handling" in Mail::Reporter
264
265       $obj->errors()
266           Inherited, see "Error handling" in Mail::Reporter
267
268       $obj->log( [$level, [$strings]] )
269       Mail::Message::Body::File->log( [$level, [$strings]] )
270           Inherited, see "Error handling" in Mail::Reporter
271
272       $obj->logPriority($level)
273       Mail::Message::Body::File->logPriority($level)
274           Inherited, see "Error handling" in Mail::Reporter
275
276       $obj->logSettings()
277           Inherited, see "Error handling" in Mail::Reporter
278
279       $obj->notImplemented()
280           Inherited, see "Error handling" in Mail::Reporter
281
282       $obj->report( [$level] )
283           Inherited, see "Error handling" in Mail::Reporter
284
285       $obj->reportAll( [$level] )
286           Inherited, see "Error handling" in Mail::Reporter
287
288       $obj->trace( [$level] )
289           Inherited, see "Error handling" in Mail::Reporter
290
291       $obj->warnings()
292           Inherited, see "Error handling" in Mail::Reporter
293
294   Cleanup
295       Extends "Cleanup" in Mail::Message::Body.
296
297       $obj->DESTROY()
298           The temporary file is automatically removed when the body is not
299           required anymore.
300

DETAILS

302       Extends "DETAILS" in Mail::Message::Body.
303

DIAGNOSTICS

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

LICENSE

341       Copyrights 2001-2020 by [Mark Overmeer <markov@cpan.org>]. For other
342       contributors see ChangeLog.
343
344       This program is free software; you can redistribute it and/or modify it
345       under the same terms as Perl itself.  See http://dev.perl.org/licenses/
346
347
348
349perl v5.32.0                      2020-07-28      Mail::Message::Body::File(3)