• NAME
• INHERITANCE
• SYNOPSIS
• DESCRIPTION
• OVERLOADED
• METHODS
  • Constructors
  • Constructing a body
  • The body
  • About the payload
  • Access to the payload
  • Internals
  • Error handling
  • Cleanup
• DETAILS
• DIAGNOSTICS
• SEE ALSO
• LICENSE

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: ""

See Mail::Message::Body/"OVERLOADED"

overload: '==' and '!='

See Mail::Message::Body/"OVERLOADED"

overload: @{}

See Mail::Message::Body/"OVERLOADED"

overload: bool

See Mail::Message::Body/"OVERLOADED"

METHODS

Constructors

$obj->clone

See Mail::Message::Body/"Constructors"

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'

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

See Mail::Message::Body::Construct/"Constructing a body"

$obj->check

See Mail::Message::Body::Encode/"Constructing a body"

$obj->concatenate(COMPONENTS)

See Mail::Message::Body::Construct/"Constructing a body"

$obj->decoded(OPTIONS)

See Mail::Message::Body/"Constructing a body"

$obj->encode(OPTIONS)

See Mail::Message::Body::Encode/"Constructing a body"

$obj->encoded

See Mail::Message::Body::Encode/"Constructing a body"

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

See Mail::Message::Body/"Constructing a body"

$obj->foreachLine(CODE)

See Mail::Message::Body::Construct/"Constructing a body"

$obj->stripSignature(OPTIONS)

See Mail::Message::Body::Construct/"Constructing a body"

$obj->unify(BODY)

See Mail::Message::Body::Encode/"Constructing a body"

The body

$obj->isDelayed

See Mail::Message::Body/"The body"

$obj->isMultipart

See Mail::Message::Body/"The body"

$obj->isNested

See Mail::Message::Body/"The body"

$obj->message([MESSAGE])

See Mail::Message::Body/"The body"

About the payload

$obj->charset

See Mail::Message::Body/"About the payload"

$obj->checked([BOOLEAN])

See Mail::Message::Body/"About the payload"

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

See Mail::Message::Body/"About the payload"

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

See Mail::Message::Body/"About the payload"

$obj->dispositionFilename([DIRECTORY])

See Mail::Message::Body::Encode/"About the payload"

$obj->isBinary

See Mail::Message::Body::Encode/"About the payload"

$obj->isText

See Mail::Message::Body::Encode/"About the payload"

$obj->mimeType

See Mail::Message::Body/"About the payload"

$obj->nrLines

See Mail::Message::Body/"About the payload"

$obj->size

See Mail::Message::Body/"About the payload"

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

See Mail::Message::Body/"About the payload"

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

See Mail::Message::Body/"About the payload"

Access to the payload

$obj->endsOnNewline

See Mail::Message::Body/"Access to the payload"

$obj->file

See Mail::Message::Body/"Access to the payload"

$obj->lines

See Mail::Message::Body/"Access to the payload"

$obj->print([FILEHANDLE])

See Mail::Message::Body/"Access to the payload"

$obj->printEscapedFrom(FILEHANDLE)

See Mail::Message::Body/"Access to the payload"

$obj->string

See Mail::Message::Body/"Access to the payload"

$obj->stripTrailingNewline

See Mail::Message::Body/"Access to the payload"

$obj->write(OPTIONS)

See Mail::Message::Body/"Access to the payload"

Internals

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

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

See Mail::Message::Body::Encode/"Internals"

$obj->contentInfoFrom(HEAD)

See Mail::Message::Body/"Internals"

$obj->contentInfoTo(HEAD)

See Mail::Message::Body/"Internals"

$obj->fileLocation([BEGIN,END])

See Mail::Message::Body/"Internals"

$obj->getTransferEncHandler(TYPE)

See Mail::Message::Body::Encode/"Internals"

$obj->isModified

See Mail::Message::Body/"Internals"

$obj->load

See Mail::Message::Body/"Internals"

$obj->modified([BOOLEAN])

See Mail::Message::Body/"Internals"

$obj->moveLocation([DISTANCE])

See Mail::Message::Body/"Internals"

$obj->read(PARSER, HEAD, BODYTYPE [,CHARS [,LINES]])

See Mail::Message::Body/"Internals"

$obj->tempFilename([FILENAME])

Returns the name of the temporary file which is used to store this body.

Error handling

$obj->AUTOLOAD

See Mail::Message::Body/"Error handling"

$obj->addReport(OBJECT)

See Mail::Reporter/"Error handling"

$obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

Mail::Message::Body::File->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

See Mail::Reporter/"Error handling"

$obj->errors

See Mail::Reporter/"Error handling"

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

Mail::Message::Body::File->log([LEVEL [,STRINGS]])

See Mail::Reporter/"Error handling"

$obj->logPriority(LEVEL)

Mail::Message::Body::File->logPriority(LEVEL)

See Mail::Reporter/"Error handling"

$obj->logSettings

See Mail::Reporter/"Error handling"

$obj->notImplemented

See Mail::Reporter/"Error handling"

$obj->report([LEVEL])

See Mail::Reporter/"Error handling"

$obj->reportAll([LEVEL])

See Mail::Reporter/"Error handling"

$obj->trace([LEVEL])

See Mail::Reporter/"Error handling"

$obj->warnings

See Mail::Reporter/"Error handling"

Cleanup

$obj->DESTROY

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

$obj->inGlobalDestruction

See Mail::Reporter/"Cleanup"

DETAILS

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.

SEE ALSO

This module is part of Mail-Box distribution version 2.082, built on April 28, 2008. Website: http://perl.overmeer.net/mailbox/

LICENSE

Copyrights 2001-2008 by Mark Overmeer. For other contributors see ChangeLog.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See http://www.perl.com/perl/misc/Artistic.html