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 '!=' See OVERLOADED in Mail::Message::Body

overload: @{} See OVERLOADED in Mail::Message::Body

overload: bool See OVERLOADED in Mail::Message::Body

$obj->clone See Constructors in Mail::Message::Body

Mail::Message::Body::File->new(OPTIONS)

 Option             Defined in       Default        
 based_on           L<Mail::Message::Body>  undef          
 charset            L<Mail::Message::Body>  C<'us-ascii'>  
 checked            L<Mail::Message::Body>  <false>        
 data               L<Mail::Message::Body>  undef          
 description        L<Mail::Message::Body>  undef          
 disposition        L<Mail::Message::Body>  undef          
 eol                L<Mail::Message::Body>  C<'NATIVE'>    
 file               L<Mail::Message::Body>  undef          
 log                L<Mail::Reporter>  C<'WARNINGS'>  
 message            L<Mail::Message::Body>  undef          
 mime_type          L<Mail::Message::Body>  C<'text/plain'>
 modified           L<Mail::Message::Body>  <false>        
 trace              L<Mail::Reporter>  C<'WARNINGS'>  
 transfer_encoding  L<Mail::Message::Body>  C<'none'>

$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) See Constructing a body in Mail::Message::Body::Construct

$obj->decoded(OPTIONS) See Constructing a body in Mail::Message::Body

$obj->encode(OPTIONS) See Constructing a body in Mail::Message::Body::Encode

$obj->encoded See Constructing a body in Mail::Message::Body::Encode

$obj->eol(['CR'|'LF'|'CRLF'|'NATIVE']) See Constructing a body in Mail::Message::Body

$obj->foreachLine(CODE) See Constructing a body in Mail::Message::Body::Construct

$obj->stripSignature(OPTIONS) See Constructing a body in Mail::Message::Body::Construct

$obj->unify(BODY) See Constructing a body in Mail::Message::Body::Encode

$obj->isDelayed See The body in Mail::Message::Body

$obj->isMultipart See The body in Mail::Message::Body

$obj->isNested See The body in Mail::Message::Body

$obj->message([MESSAGE]) See The body in Mail::Message::Body

$obj->charset See About the payload in Mail::Message::Body

$obj->checked([BOOLEAN]) See About the payload in Mail::Message::Body

$obj->description([STRING|FIELD]) See About the payload in Mail::Message::Body

$obj->disposition([STRING|FIELD]) See About the payload in Mail::Message::Body

$obj->dispositionFilename([DIRECTORY]) See About the payload in Mail::Message::Body::Encode

$obj->isBinary See About the payload in Mail::Message::Body::Encode

$obj->isText See About the payload in Mail::Message::Body::Encode

$obj->mimeType See About the payload in Mail::Message::Body

$obj->nrLines See About the payload in Mail::Message::Body

$obj->size See About the payload in Mail::Message::Body

$obj->transferEncoding([STRING|FIELD]) See About the payload in Mail::Message::Body

$obj->type([STRING|FIELD]) See About the payload in Mail::Message::Body

$obj->file See Access to the payload in Mail::Message::Body

$obj->lines See Access to the payload in Mail::Message::Body

$obj->print([FILEHANDLE]) See Access to the payload in Mail::Message::Body

$obj->printEscapedFrom(FILEHANDLE) See Access to the payload in Mail::Message::Body

$obj->string See Access to the payload in Mail::Message::Body

$obj->write(OPTIONS) See Access to the payload in Mail::Message::Body

$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) See Internals in Mail::Message::Body

$obj->fileLocation([BEGIN,END]) See Internals in Mail::Message::Body

$obj->getTransferEncHandler(TYPE) See Internals in Mail::Message::Body::Encode

$obj->isModified See Internals in Mail::Message::Body

$obj->load See Internals in Mail::Message::Body

$obj->modified([BOOLEAN]) See Internals in Mail::Message::Body

$obj->moveLocation([DISTANCE]) See Internals in Mail::Message::Body

$obj->read(PARSER, HEAD, BODYTYPE [,CHARS [,LINES]]) See Internals in Mail::Message::Body

$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]) See Error handling in Mail::Reporter

$obj->errors See Error handling in Mail::Reporter

$obj->log([LEVEL [,STRINGS]])

Mail::Message::Body::File->log([LEVEL [,STRINGS]]) See Error handling in Mail::Reporter

$obj->logPriority(LEVEL)

Mail::Message::Body::File->logPriority(LEVEL) See Error handling in Mail::Reporter

$obj->logSettings See Error handling in Mail::Reporter

$obj->notImplemented See Error handling in Mail::Reporter

$obj->report([LEVEL]) See Error handling in Mail::Reporter

$obj->reportAll([LEVEL]) See Error handling in Mail::Reporter

$obj->trace([LEVEL]) See Error handling in Mail::Reporter

$obj->warnings See Error handling in Mail::Reporter

$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 CW$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 CW$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 CW$name.

The data (message body) has been decoded, but the required encoding is unknown. The decoded data is returned.

Error: Package CW$package does not implement CW$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 CW$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.063. 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.