/ 
Mail-Box-2.015
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

CLASS HIERARCHY

Mail::Message::Body::File
is a Mail::Message::Body + ::Construct + ::Encode
is a Mail::Reporter

SYNOPSIS

See Mail::Message::Body

DESCRIPTION

READ Mail::Message::Body FIRST. This manual-page only describes the extensions to the default body functionality.

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.

METHOD INDEX

Methods prefixed with an abbreviation are described in Mail::Reporter (MR), Mail::Message::Body (MMB), Mail::Message::Body::Construct (MMBC), Mail::Message::Body::Encode (MMBE).

The general methods for Mail::Message::Body::File objects:

MMBC attach MESSAGES, OPTIONS         MMB lines
 MMB charset                           MR log [LEVEL [,STRINGS]]
MMBE check                            MMB message [MESSAGE]
 MMB checked [BOOLEAN]                MMB mimeType
MMBC concatenate COMPONENTS           MMB modified [BOOL]
 MMB decoded OPTIONS                      new OPTIONS
 MMB disposition [STRING|FIELD]       MMB nrLines
MMBE encode OPTIONS                   MMB print [FILE]
MMBE encoded                          MMB reply OPTIONS
 MMB eol ['CR'|'LF'|'CRLF'|'NATI...    MR report [LEVEL]
  MR errors                            MR reportAll [LEVEL]
 MMB file                             MMB size
MMBC foreachLine CODE                 MMB string
MMBE isBinary                        MMBC stripSignature OPTIONS
 MMB isDelayed                         MR trace [LEVEL]
 MMB isMultipart                      MMB transferEncoding [STRING|FI...
 MMB isNested                         MMB type
MMBE isText                            MR warnings

The extra methods for extension writers:

  MR AUTOLOAD                         MMB load
     DESTROY                           MR logPriority LEVEL
MMBE addTransferEncHandler NAME,...    MR logSettings
 MMB clone                            MMB moveLocation [DISTANCE]
 MMB fileLocation [BEGIN,END]          MR notImplemented
MMBE getTransferEncHandler TYPE       MMB read PARSER, HEAD, BODYTYPE...
  MR inGlobalDestruction                  tempFilename [FILENAME]

METHODS

new OPTIONS
OPTION    DESCRIBED IN                  DEFAULT
data      Mail::Message::Body           undef
log       Mail::Reporter                'WARNINGS'
message   Mail::Message::Body           undef
modified  Mail::Message::Body           0
trace     Mail::Reporter                'WARNINGS'

METHODS for extension writers

tempFilename [FILENAME]

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

DESTROY

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

SEE ALSO

Mail::Box-Overview

For support and additional documentation, see http://perl.overmeer.net/mailbox/

AUTHOR

Mark Overmeer (mailbox@overmeer.net). All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

VERSION

This code is beta, version 2.015.

Copyright (c) 2001-2002 Mark Overmeer. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.