NAME

Mail::Box::Dir::Message - one message in a direcory-organized folder

CLASS HIERARCHY

Mail::Box::Dir::Message
is a Mail::Box::Message
is a Mail::Message + ::Construct
is a Mail::Reporter

SYNOPSIS

my $folder = new Mail::Box::MH ...
my $message = $folder->message(10);

DESCRIPTION

A Mail::Box::Dir::Message represents one message in a directory organized folder; each message is stored in a separate file. At the moment, two of these folder types are implemented:

• MH

• Maildir

METHOD INDEX

Methods prefixed with an abbreviation are described in Mail::Message (MM), Mail::Reporter (MR), Mail::Box::Message (MBM), Mail::Message::Construct (MMC).

The general methods for Mail::Box::Dir::Message objects:

 MM bcc                               MM label LABEL [,VALUE [LABEL,...
MMC bounce OPTIONS                    MR log [LEVEL [,STRINGS]]
MMC build [MESSAGE|BODY], CONTENT     MM messageId
MMC buildFromBody BODY, HEADERS       MM modified [BOOL]
 MM cc                                   new OPTIONS
MBM copyTo FOLDER                     MM nrLines
 MM date                              MM parent
 MM decoded OPTIONS                   MM parts
MBM delete                            MM print [FILEHANDLE]
MBM deleted [BOOL]                    MM printUndisclosed [FILEHANDLE]
 MM destinations                     MMC reply OPTIONS
 MM encode OPTIONS                   MMC replyPrelude [STRING|FIELD|...
 MR errors                           MMC replySubject STRING
    filename [FILENAME]               MR report [LEVEL]
MBM folder [FOLDER]                   MR reportAll [LEVEL]
MMC forward OPTIONS                   MM send [MAILER], OPTIONS
MMC forwardPostlude                  MBM seqnr [INTEGER]
MMC forwardPrelude                   MBM shortString
MMC forwardSubject STRING             MM size
 MM from                              MM subject
 MM get FIELD                         MM timestamp
 MM guessTimestamp                    MM to
 MM isDummy                           MM toplevel
 MM isMultipart                       MR trace [LEVEL]
 MM isPart                            MR warnings

The extra methods for extension writers:

 MR AUTOLOAD                             loadHead
 MM DESTROY                           MR logPriority LEVEL
 MM body [BODY]                       MR logSettings
 MM clone                             MR notImplemented
 MM coerce MESSAGE                       parser
MBM diskDelete                        MM read PARSER, [BODYTYPE]
 MM head [HEAD]                      MBM readBody PARSER, HEAD [, BO...
 MR inGlobalDestruction               MM readHead PARSER [,CLASS]
 MM isDelayed                         MM statusToLabels
 MM labels                            MM storeBody BODY
 MM labelsToStatus                    MM takeMessageId [STRING]

METHODS

new OPTIONS

Messages in directory-based folders use the following options:

OPTION      DESCRIBED IN             DEFAULT
body        Mail::Message            undef
deleted     Mail::Box::Message       0
filename    Mail::Box::Dir::Message  undef
folder      Mail::Box::Message       <required>
head        Mail::Message            undef
head_wrap   Mail::Message            undef
labels      Mail::Box::Message       []
log         Mail::Reporter           'WARNINGS'
messageId   Mail::Message            undef
modified    Mail::Message            0
size        Mail::Box::Message       undef
trace       Mail::Reporter           'WARNINGS'
trusted     Mail::Message            0

Only for extension writers:

OPTION      DESCRIBED IN             DEFAULT
body_type   Mail::Box::Message       <not used>
field_type  Mail::Message            undef
head_type   Mail::Message            'Mail::Message::Head::Complete'

• filename => FILENAME

  The file where the message is stored in.

filename [FILENAME]

Returns the name of the file in which this message is actually stored. This will return undef when the message is not stored in a file.

METHODS for extension writers

parser

Create and return a parser for this message (-file).

loadHead

This method is called by the autoloader when the header of the message is needed.

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

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.