Mail::Message::Body::File - body of a message temporarily stored in a file
Mail::Message::Body::File is a Mail::Message::Body is a Mail::Reporter
See Mail::Message::Body
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.
overload: ""
See "OVERLOADED" in Mail::Message::Body
overload: '==' and '!='
overload: @{}
overload: bool
$obj->clone
See "Constructors" in Mail::Message::Body
Mail::Message::Body::File->new(OPTIONS)
-Option --Defined in --Default based_on Mail::Message::Body undef charset Mail::Message::Body 'us-ascii' checked Mail::Message::Body <false> data Mail::Message::Body undef description Mail::Message::Body undef disposition Mail::Message::Body undef eol Mail::Message::Body 'NATIVE' file Mail::Message::Body undef log Mail::Reporter 'WARNINGS' message Mail::Message::Body undef mime_type Mail::Message::Body 'text/plain' modified Mail::Message::Body <false> trace Mail::Reporter 'WARNINGS' transfer_encoding Mail::Message::Body 'none'
'us-ascii'
'NATIVE'
'WARNINGS'
'text/plain'
'none'
. based_on BODY
. charset STRING
. checked BOOLEAN
. data ARRAY-OF-LINES | STRING
. description STRING|FIELD
. disposition STRING|FIELD
. eol 'CR'|'LF'|'CRLF'|'NATIVE'
. file FILENAME|FILEHANDLE|IOHANDLE
. log LEVEL
. message MESSAGE
. mime_type STRING|FIELD|MIME
. modified BOOLEAN
. trace LEVEL
. transfer_encoding STRING|FIELD
$obj->attach(MESSAGES, OPTIONS)
See "Constructing a body" in Mail::Message::Body::Construct
$obj->check
See "Constructing a body" in Mail::Message::Body::Encode
$obj->concatenate(COMPONENTS)
$obj->decoded(OPTIONS)
See "Constructing a body" in Mail::Message::Body
$obj->encode(OPTIONS)
$obj->encoded
$obj->eol(['CR'|'LF'|'CRLF'|'NATIVE'])
$obj->foreachLine(CODE)
$obj->stripSignature(OPTIONS)
$obj->unify(BODY)
$obj->isDelayed
See "The body" in Mail::Message::Body
$obj->isMultipart
$obj->isNested
$obj->message([MESSAGE])
$obj->charset
See "About the payload" in Mail::Message::Body
$obj->checked([BOOLEAN])
$obj->description([STRING|FIELD])
$obj->disposition([STRING|FIELD])
$obj->dispositionFilename([DIRECTORY])
See "About the payload" in Mail::Message::Body::Encode
$obj->isBinary
$obj->isText
$obj->mimeType
$obj->nrLines
$obj->size
$obj->transferEncoding([STRING|FIELD])
$obj->type([STRING|FIELD])
$obj->endsOnNewline
See "Access to the payload" in Mail::Message::Body
$obj->file
$obj->lines
$obj->print([FILEHANDLE])
$obj->printEscapedFrom(FILEHANDLE)
$obj->string
$obj->stripTrailingNewline
$obj->write(OPTIONS)
$obj->addTransferEncHandler(NAME, CLASS|OBJECT)
Mail::Message::Body::File->addTransferEncHandler(NAME, CLASS|OBJECT)
See "Internals" in Mail::Message::Body::Encode
$obj->contentInfoFrom(HEAD)
See "Internals" in Mail::Message::Body
$obj->contentInfoTo(HEAD)
$obj->fileLocation([BEGIN,END])
$obj->getTransferEncHandler(TYPE)
$obj->isModified
$obj->load
$obj->modified([BOOLEAN])
$obj->moveLocation([DISTANCE])
$obj->read(PARSER, HEAD, BODYTYPE [,CHARS [,LINES]])
$obj->tempFilename([FILENAME])
Returns the name of the temporary file which is used to store this body.
$obj->AUTOLOAD
See "Error handling" in Mail::Message::Body
$obj->addReport(OBJECT)
See "Error handling" in Mail::Reporter
$obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
Mail::Message::Body::File->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
$obj->errors
$obj->log([LEVEL [,STRINGS]])
Mail::Message::Body::File->log([LEVEL [,STRINGS]])
$obj->logPriority(LEVEL)
Mail::Message::Body::File->logPriority(LEVEL)
$obj->logSettings
$obj->notImplemented
$obj->report([LEVEL])
$obj->reportAll([LEVEL])
$obj->trace([LEVEL])
$obj->warnings
$obj->DESTROY
The temporary file is automatically removed when the body is not required anymore.
$obj->inGlobalDestruction
See "Cleanup" in Mail::Reporter
Error: Cannot write to temporary body file $filename: $!
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.
Warning: No decoder defined for transfer encoding $name.
The data (message body) is encoded in a way which is not currently understood, therefore no decoding (or recoding) can take place.
Warning: No encoder defined for transfer encoding $name.
The data (message body) has been decoded, but the required encoding is unknown. The decoded data is returned.
Error: Package $package does not implement $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.
Error: Unable to read file $filename 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.
See the MailBox website at http://perl.overmeer.net/mailbox/ for more details.
Distribution version 2.066. Written by Mark Overmeer (mark@overmeer.net). See the ChangeLog for other contributors.
Copyright (c) 2001-2003 by the author(s). All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
To install Mail::Box, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Mail::Box
CPAN shell
perl -MCPAN -e shell install Mail::Box
For more information on module installation, please visit the detailed CPAN module installation guide.