NAME

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

INHERITANCE

Mail::Box::Dir
  is a Mail::Box
  is a Mail::Reporter
Mail::Box::Dir is extended by
  Mail::Box::MH
  Mail::Box::Maildir

SYNOPSIS

# Do not instantiate this object

DESCRIPTION

This documentation describes the way directory organized mailboxes work. At the moment, this object is extended by

Mail::Box::MH
MH folders, which are represented by a directory containing files which are sequentially numbered.
Mail::Box::Maildir
Maildir folders, which are located in a directory which has sub-directories named "tmp", "new", and "cur". Each of these directories may contain files with names which are a combination of a numeric timestamp and some status flags.
Mail::Box::Netzwert
This folder type was especially developed for Netzwert AG, optimized to run on a cluster of servers with folders on NFS. The code is not publicly available (yet).

Extends "DESCRIPTION" in Mail::Box.

OVERLOADED

Extends "OVERLOADED" in Mail::Box.

overload: "": Inherited, see "OVERLOADED" in Mail::Box
overload: @{}: Inherited, see "OVERLOADED" in Mail::Box
overload: cmp: Inherited, see "OVERLOADED" in Mail::Box

METHODS

Extends "METHODS" in Mail::Box.

Constructors

Extends "Constructors" in Mail::Box.

Mail::Box::Dir->new(%options)

-Option           --Defined in     --Default
 access             Mail::Box        'r'
 body_delayed_type  Mail::Box        Mail::Message::Body::Delayed
 body_type          Mail::Box        Mail::Message::Body::Lines
 coerce_options     Mail::Box        []
 create             Mail::Box        <false>
 directory                           <derived from folder name>
 extract            Mail::Box        10240
 field_type         Mail::Box        undef
 fix_headers        Mail::Box        <false>
 folder             Mail::Box        $ENV{MAIL}
 folderdir          Mail::Box        undef
 head_delayed_type  Mail::Box        Mail::Message::Head::Delayed
 head_type          Mail::Box        Mail::Message::Head::Complete
 keep_dups          Mail::Box        <false>
 lock_file          Mail::Box        <folder>/.lock
 lock_timeout       Mail::Box        1 hour
 lock_type          Mail::Box        Mail::Box::Locker::DotLock
 lock_wait          Mail::Box        10 seconds
 locker             Mail::Box        undef
 log                Mail::Reporter   'WARNINGS'
 manager            Mail::Box        undef
 message_type       Mail::Box        <folder-class>::Message
 multipart_type     Mail::Box        Mail::Message::Body::Multipart
 remove_when_empty  Mail::Box        <true>
 save_on_exit       Mail::Box        <true>
 trace              Mail::Reporter   'WARNINGS'
 trusted            Mail::Box        <depends on folder location>

access => MODE
body_delayed_type => CLASS
body_type => CLASS|CODE
coerce_options => ARRAY
create => BOOLEAN
directory => DIRECTORY: For rare folder types, the directory name may differ from the folder name.
extract => INTEGER | CODE | METHOD | 'LAZY'|'ALWAYS'
field_type => CLASS
fix_headers => BOOLEAN
folder => FOLDERNAME
folderdir => DIRECTORY
head_delayed_type => CLASS
head_type => CLASS
keep_dups => BOOLEAN
lock_file => FILENAME
lock_timeout => SECONDS
lock_type => CLASS|STRING|ARRAY
lock_wait => SECONDS
locker => OBJECT
log => LEVEL
manager => MANAGER
message_type => CLASS
multipart_type => CLASS
remove_when_empty => BOOLEAN
save_on_exit => BOOLEAN
trace => LEVEL
trusted => BOOLEAN