NAME

Mail::Box::Dir - handle folders with a file per message.

CLASS HIERARCHY

Mail::Box::Dir
is a Mail::Box
is a Mail::Reporter

SYNOPSIS

# Do not instantiate this object

DESCRIPTION

This documentation describes how directory organized mailboxes work. Please read Mail::Box-Overview first.

At the moment, this object is extended by

• MH

• Maildir

METHOD INDEX

Methods prefixed with an abbreviation are described in Mail::Box (MB), Mail::Reporter (MR).

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

MB addMessage  MESSAGE               MB message INDEX [,MESSAGE]
MB addMessages MESSAGE [, MESS...    MB messageId MESSAGE-ID [,MESS...
MB close OPTIONS                     MB messageIds
MB copyTo FOLDER, OPTIONS            MB messages ['ALL',RANGE,'ACTI...
MB create FOLDERNAME [, OPTIONS]     MB modified [BOOLEAN]
MB current [NUMBER|MESSAGE|MES...    MB name
MB delete                               new OPTIONS
   directory                         MB openSubFolder NAME [,OPTIONS]
MR errors                            MR report [LEVEL]
MB find MESSAGE-ID                   MR reportAll [LEVEL]
MB listSubFolders OPTIONS            MR trace [LEVEL]
MB locker                            MR warnings
MR log [LEVEL [,STRINGS]]            MB writable

The extra methods for extension writers:

MR AUTOLOAD                          MB organization
MB DESTROY                           MB read OPTIONS
MB appendMessages OPTIONS               readAllHeaders
MB clone OPTIONS                        readMessageFilenames DIRECTORY
MB coerce MESSAGE                    MB readMessages OPTIONS
MB determineBodyType MESSAGE, ...    MB scanForMessages MESSAGE, ME...
   folderToDirectory FOLDERNAM...    MB sort PREPARE, COMPARE, LIST
MB folderdir [DIR]                   MB storeMessage MESSAGE
MB foundIn [FOLDERNAME], OPTIONS     MB timespan2seconds TIME
MR inGlobalDestruction               MB toBeThreaded MESSAGES
MB lineSeparator [STRING|'CR'|...    MB toBeUnthreaded MESSAGES
MR logPriority LEVEL                 MB update OPTIONS
MR logSettings                       MB updateMessages OPTIONS
MR notImplemented                    MB write OPTIONS
MB openRelatedFolder OPTIONS         MB writeMessages

METHODS

new OPTIONS

Create a new folder. The are many options which are taken from other objects. For some, different options are set. For MH-specific options see below, but first the full list.

OPTION            DEFINED BY         DEFAULT
access            Mail::Box          'r'
create            Mail::Box          0
folder            Mail::Box          $ENV{MAIL}
folderdir         Mail::Box          undef
head_wrap         Mail::Box          72
keep_dups         Mail::Box          0
extract           Mail::Box          10kB
lock_type         Mail::Box          'DOTLOCK'
lock_file         Mail::Box          foldername.'/.lock'
lock_timeout      Mail::Box          3600    (1 hour)
lock_wait         Mail::Box          10      (seconds)
log               Mail::Reporter     'WARNINGS'
remove_when_empty Mail::Box          1
save_on_exit      Mail::Box          1
trace             Mail::Reporter     'WARNINGS'
trusted           Mail::Box          <depends on folder location>

Only useful to write extension to Mail::Box::Dir. Common users of folders you will not specify these:

OPTION            DEFINED BY         DEFAULT
body_type         Mail::Box::Dir     'Mail::Message::Body::Lines'
body_delayed_type Mail::Box          'Mail::Message::Body::Delayed'
coerce_options    Mail::Box          []
field_type        Mail::Box          undef
head_type         Mail::Box          'Mail::Message::Head::Complete'
head_delayed_type Mail::Box          'Mail::Message::Head::Delayed'
locker            Mail::Box          undef
multipart_type    Mail::Box          'Mail::Message::Body::Multipart'
manager           Mail::Box          undef
message_type      Mail::Box          'Mail::Box::Dir::Message'
realhead_type     Mail::Box          'Mail::Message::Head'

directory

Returns the directory related to this folder.

Example:

print $folder->directory;

METHODS for extension writers

folderToDirectory FOLDERNAME, FOLDERDIR

(class method) Translate a foldername into a filename, with use of the FOLDERDIR to replace a leading =.

readMessageFilenames DIRECTORY

Returns a list of all filenames which are found in this folder directory and represent a message. The filenames are returned as relative path.

readAllHeaders

Force all messages to be read at least till their header information is known.

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

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.