/ 
Mail-Box-2.063
River stage one • 8 direct dependents • 8 total dependents
/ Mail::Message::Body::File

NAME

Mail::Message::Body::File - body of a message temporarily stored in a file

INHERITANCE

Mail::Message::Body::File
  is a Mail::Message::Body
  is a Mail::Reporter

SYNOPSIS

See Mail::Message::Body

DESCRIPTION

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.

OVERLOADED

overload: ""

overload: '==' and '!='

overload: @{}

overload: bool

METHODS

Constructors

$obj->clone

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'>

    . 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

Constructing a body

$obj->attach(MESSAGES, OPTIONS)

$obj->check

$obj->concatenate(COMPONENTS)

$obj->decoded(OPTIONS)

$obj->encode(OPTIONS)

$obj->encoded

$obj->eol(['CR'|'LF'|'CRLF'|'NATIVE'])

$obj->foreachLine(CODE)

$obj->stripSignature(OPTIONS)

$obj->unify(BODY)

The body

$obj->isDelayed

$obj->isMultipart

$obj->isNested

$obj->message([MESSAGE])

About the payload

$obj->charset

$obj->checked([BOOLEAN])

$obj->description([STRING|FIELD])

$obj->disposition([STRING|FIELD])

$obj->dispositionFilename([DIRECTORY])

$obj->isBinary

$obj->isText

$obj->mimeType

$obj->nrLines

$obj->size

$obj->transferEncoding([STRING|FIELD])

$obj->type([STRING|FIELD])

Access to the payload

$obj->file

$obj->lines

$obj->print([FILEHANDLE])

$obj->printEscapedFrom(FILEHANDLE)

$obj->string

$obj->write(OPTIONS)

Internals

$obj->addTransferEncHandler(NAME, CLASS|OBJECT)

Mail::Message::Body::File->addTransferEncHandler(NAME, CLASS|OBJECT)

$obj->contentInfoFrom(HEAD)

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

Error handling

$obj->AUTOLOAD

$obj->addReport(OBJECT)

$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

Cleanup

$obj->DESTROY

    The temporary file is automatically removed when the body is not required anymore.

$obj->inGlobalDestruction

DIAGNOSTICS

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.

DETAILS

REFERENCES

See the MailBox website at http://perl.overmeer.net/mailbox/ for more details.

COPYRIGHTS

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.