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

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

MMBC attach MESSAGES, OPTIONS         MMB message [MESSAGE]
MMBE check                            MMB mimeType
 MMB checked [BOOLEAN]                MMB modified [BOOL]
MMBC concatenate COMPONENTS               new OPTIONS
 MMB decoded OPTIONS                  MMB nrLines
 MMB disposition [STRING|FIELD]           print [FILE]
MMBE encode OPTIONS                   MMB reply OPTIONS
MMBE encoded                           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 lines                            MMB type
  MR log [LEVEL [,STRINGS]]            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                      MR notImplemented
MMBE getTransferEncHandler TYPE       MMB read PARSER, HEAD, BODYTYPE...
  MR inGlobalDestruction                  tempFilename [FILENAME]

Methods prefixed with an abbreviation are described in the following manual-pages:

  MR = L<Mail::Reporter>
 MMB = L<Mail::Message::Body>
MMBC = L<Mail::Message::Body::Construct>
MMBE = L<Mail::Message::Body::Encode>

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

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

Copyright (c) 2001 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.