Mail::Message::Body::File3pm
Body of a message temporarily stored in a file
Usage
See Mail::Message::Body
Inheritance
Mail::Message::Body::Fileis a Mail::Message::Bodyis a Mail::ReporterMail::Message::Body also extends Mail::Reporteris a Mail::Reporter
Overview
The body (content) of a message can be stored in various ways. In this documentation you find the description of extra functionality you have when a message is stored in a file.
Storing a whole message is a file is useful when the body is large. Although access through a file is slower, it is saving a lot of memory.
Extends "DESCRIPTION" in Mail::Message::Body.
Overloaded
Extends "OVERLOADED" in Mail::Message::Body.
overload: '""' stringification
|
Inherited, see "OVERLOADED" in Mail::Message::Body |
|---|---|
overload: '==' numerical comparison
|
Inherited, see "OVERLOADED" in Mail::Message::Body |
overload: '@{}' addressed as array
|
Inherited, see "OVERLOADED" in Mail::Message::Body |
overload:
|
Inherited, see "OVERLOADED" in Mail::Message::Body |
Methods
Extends "METHODS" in Mail::Message::Body.
Constructors
Extends "Constructors" in Mail::Message::Body.
- $obj->
clone() -
Inherited, see "Constructors" in Mail::Message::Body
- $class->
new(%options) -
Inherited, see "Constructors" in Mail::Message::Body
-Option --Defined in --Defaultbased_on Mail::Message::Body undefcharset Mail::Message::Body 'PERL'checked Mail::Message::Body falsecontent_id Mail::Message::Body undefdata Mail::Message::Body undefdescription Mail::Message::Body undefdisposition Mail::Message::Body undefeol Mail::Message::Body 'NATIVE'file Mail::Message::Body undeffilename Mail::Message::Body undeflanguage Mail::Message::Body undefmessage Mail::Message::Body undefmime_type Mail::Message::Body 'text/plain'modified Mail::Message::Body falsetransfer_encoding Mail::Message::Body 'none'- based_on => $body
- charset => $charset|'PERL'|<undef>
- checked => BOOLEAN
- content_id => STRING
- data => \@lines|$text
- description => STRING|$field
- disposition => STRING|$field
- eol => 'CR'|'LF'|'CRLF'|'NATIVE'
- file => $file|$handle|$io
- filename => $file
- language => STRING|\@lang|$field
- message => $message
- mime_type => STRING|$field|$mime
- modified => BOOLEAN
- transfer_encoding => STRING|$field
Attributes
Extends "Attributes" in Mail::Message::Body.
- $obj->
charsetDetectAlgorithm( [CODE|undef|METHOD] ) -
Inherited, see "Attributes" in Mail::Message::Body::Encode
Constructing a body
Extends "Constructing a body" in Mail::Message::Body.
$obj->
|
Inherited, see "Constructing a body" in Mail::Message::Body::Construct |
|---|---|
$obj->
|
Inherited, see "Constructing a body" in Mail::Message::Body::Encode |
$obj->
|
Inherited, see "Constructing a body" in Mail::Message::Body::Encode |
$obj->
|
Inherited, see "Constructing a body" in Mail::Message::Body::Construct |
$obj->
|
Inherited, see "Constructing a body" in Mail::Message::Body |
$obj->
|
Inherited, see "Constructing a body" in Mail::Message::Body::Encode |
$obj->
|
Inherited, see "Constructing a body" in Mail::Message::Body::Encode |
$obj->
|
Inherited, see "Constructing a body" in Mail::Message::Body::Encode |
$obj->
|
Inherited, see "Constructing a body" in Mail::Message::Body::Construct |
$obj->
|
Inherited, see "Constructing a body" in Mail::Message::Body::Construct |
$obj->
|
Inherited, see "Constructing a body" in Mail::Message::Body::Encode |
The body
Extends "The body" in Mail::Message::Body.
$obj->
|
Inherited, see "The body" in Mail::Message::Body |
|---|---|
$obj->
|
Inherited, see "The body" in Mail::Message::Body |
$obj->
|
Inherited, see "The body" in Mail::Message::Body |
$obj->
|
Inherited, see "The body" in Mail::Message::Body |
$obj->
|
Inherited, see "The body" in Mail::Message::Body |
About the payload
Extends "About the payload" in Mail::Message::Body.
$obj->
|
Inherited, see "About the payload" in Mail::Message::Body |
|---|---|
$obj->
|
Inherited, see "About the payload" in Mail::Message::Body |
$obj->
|
Inherited, see "About the payload" in Mail::Message::Body |
$obj->
|
Inherited, see "About the payload" in Mail::Message::Body |
$obj->
|
Inherited, see "About the payload" in Mail::Message::Body |
$obj->
|
Inherited, see "About the payload" in Mail::Message::Body::Encode |
$obj->
|
Inherited, see "About the payload" in Mail::Message::Body::Encode |
$obj->
|
Inherited, see "About the payload" in Mail::Message::Body::Encode |
$obj->
|
Inherited, see "About the payload" in Mail::Message::Body |
$obj->
|
Inherited, see "About the payload" in Mail::Message::Body |
$obj->
|
Inherited, see "About the payload" in Mail::Message::Body |
$obj->
|
Inherited, see "About the payload" in Mail::Message::Body |
$obj->
|
Inherited, see "About the payload" in Mail::Message::Body |
$obj->
|
Inherited, see "About the payload" in Mail::Message::Body |
Access to the payload
Extends "Access to the payload" in Mail::Message::Body.
$obj->
|
Inherited, see "Access to the payload" in Mail::Message::Body |
|---|---|
$obj->
|
Inherited, see "Access to the payload" in Mail::Message::Body |
$obj->
|
Inherited, see "Access to the payload" in Mail::Message::Body |
$obj->
|
Inherited, see "Access to the payload" in Mail::Message::Body |
$obj->
|
Inherited, see "Access to the payload" in Mail::Message::Body |
$obj->
|
Inherited, see "Access to the payload" in Mail::Message::Body |
$obj->
|
Inherited, see "Access to the payload" in Mail::Message::Body |
$obj->
|
Inherited, see "Access to the payload" in Mail::Message::Body |
Internals
Extends "Internals" in Mail::Message::Body.
$any->
|
Inherited, see "Internals" in Mail::Message::Body::Encode |
|---|---|
$obj->
|
Inherited, see "Internals" in Mail::Message::Body |
$obj->
|
Inherited, see "Internals" in Mail::Message::Body |
$obj->
|
Inherited, see "Internals" in Mail::Message::Body |
$obj->
|
Inherited, see "Internals" in Mail::Message::Body::Encode |
$obj->
|
Inherited, see "Internals" in Mail::Message::Body |
$obj->
|
Inherited, see "Internals" in Mail::Message::Body |
$obj->
|
Inherited, see "Internals" in Mail::Message::Body |
$obj->
|
Inherited, see "Internals" in Mail::Message::Body |
$obj->
|
Inherited, see "Internals" in Mail::Message::Body |
$obj->
|
Returns the name of the temporary file which is used to store this body. |
Error handling
Extends "Error handling" in Mail::Message::Body.
$obj->AUTOLOAD()
|
Inherited, see "Error handling" in Mail::Message::Body |
|---|---|
$obj->
|
Inherited, see "Error handling" in Mail::Reporter |
$obj->
|
Inherited, see "Error handling" in Mail::Reporter |
Cleanup
Extends "Cleanup" in Mail::Message::Body.
- $obj->DESTROY()
-
The temporary file is automatically removed when the body is not required anymore. Improves base, see "Cleanup" in Mail::Reporter
Details
Extends "DETAILS" in Mail::Message::Body.
Diagnostics
- Warning: Content-Transfer-Encoding '$te' requires explicit charset, defaulted to utf-8.
-
Cast by
encode()
- Error: cannot concatenate element $which
-
Cast by
concatenate()
- Fault: cannot open $file to write body: $!
-
Cast by
write()
- Fault: cannot read from file $name: $!
-
Cast by
nrLines()
- Fault: cannot read from file $name: $!
-
Cast by
endsOnNewline()
- Fault: cannot read from file $name: $!
-
Cast by
print()
- Fault: cannot read from file $name: $!
-
Cast by
lines()
- Fault: cannot read from file $name: $!
-
Cast by
string()
- Fault: cannot write body to file $name: $!
-
Cast by
new()
- Fault: cannot write to file $name: $!
-
Cast by
read()
- Fault: cannot write to temporary body file $name: $!
-
The message body is to be stored in a temporary file (probably because it is a large body), but for the indicated reason, this file cannot be created. Cast by
new()
- Fault: cannot write to temporary body file $name: $!
-
Cast by
new()
- Warning: charset '$name' is not known.
-
The encoding or decoding of a message body encounters a character set which is not understood by Perl's Encode module. Cast by
encode()
- Error: class $package does not implement method $method.
-
Fatal error: the specific
$package(or one of its superclasses) does not implement this method where it should. This message means that some other related classes do implement this method however the class at hand does not. Probably you should investigate this and probably inform the author of the package. Cast bynotImplemented()
- Error: class $package does not implement method $method.
-
Fatal error: the specific
$package(or one of its superclasses) does not implement this method where it should. This message means that some other related classes do implement this method however the class at hand does not. Probably you should investigate this and probably inform the author of the package. Cast bynotImplemented()
- Fault: error closing $file after write body: $!
-
Cast by
write()
- Warning: no decoder defined for transfer encoding '$encoding'.
-
The data (message body) is encoded in a way which is not currently understood, therefore no decoding (or recoding) can take place. Cast by
encode()
- Warning: no encoder defined for transfer encoding '$encoding'.
-
The data (message body) has been decoded, but the required encoding is unknown. The decoded data is returned. Cast by
encode()
- Error: no filename parameter for
write()body. -
Cast by
write()
- Error: part number needs multi-part or nested.
-
Cast by
partNumberOf()
- Fault: unable to read file $name for message body file: $!
-
A Mail::Message::Body::File object is to be created from a named file, but it is impossible to read that file to retrieve the lines within. Therefore, no copy to a temporary file can be made. Cast by
new()
- Error: unknown line terminator '$eol'.
-
Cast by
eol()
Releases
13 releases since Debian 3.0 (Woody); the text changed 12 times.