OVERLOADED

overload: ""
See "" in Mail::Box.
overload: @{}
See @{} in Mail::Box.
overload: cmp
See cmp in Mail::Box.

METHODS

See METHODS in Mail::Reporter

Constructors

$class->new( %options )
Option Defined in Default

accept_new

<false>

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

Mail::Box::Dir

<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

$ENV{HOME}/.maildir

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

<not used>

lock_timeout

Mail::Box

<not used>

lock_type

Mail::Box

'NONE' (constant)

lock_wait

Mail::Box

<not used>

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>

accept_new => BOOLEAN
When the folder is open, some messages may be stored in the new sub-directory. By default, these messages are immediately moved to the cur directory when the folder is opened. Otherwise, you have to call acceptMessages() or Mail::Box::Maildir::Message::accept().
access => MODE
body_delayed_type => CLASS
body_type => CLASS|CODE
coerce_options => ARRAY
create => BOOLEAN
directory => DIRECTORY
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

The folder

$obj->addMessage( $message, %options )
See addMessage in Mail::Box.
$obj->addMessages( @messages )
See addMessages in Mail::Box.
$class->appendMessages( %options )
See appendMessages in Mail::Box.
$obj->close( %options )
See close in Mail::Box.
$obj->copyTo( $folder, %options )
See copyTo in Mail::Box.
$obj->delete( %options )
See delete in Mail::Box.
$obj->directory
See directory in Mail::Box::Dir.
$obj->folderdir( [$directory] )
See folderdir in Mail::Box.
$obj->name
See name in Mail::Box.
$obj->organization
See organization in Mail::Box.
$obj->size
See size in Mail::Box.
$obj->type
See type in Mail::Box.
$obj->update( %options )
See update in Mail::Box.
$obj->url
See url in Mail::Box.

Folder flags

$obj->access
See access in Mail::Box.
$obj->isModified
See isModified in Mail::Box.
$obj->modified( [BOOLEAN] )
See modified in Mail::Box.
$obj->writable
See writable in Mail::Box.

The messages

$obj->current( [$number|$message|$message_id] )
See current in Mail::Box.
$obj->find( $message_id )
See find in Mail::Box.
$obj->findFirstLabeled( $label, [BOOLEAN, [$msgs]] )
See findFirstLabeled in Mail::Box.
$obj->message( $index, [$message] )
See message in Mail::Box.
$obj->messageId( $message_id, [$message] )
See messageId in Mail::Box.
$obj->messageIds
See messageIds in Mail::Box.
$obj->messages( <'ALL'|$range|'ACTIVE'|'DELETED'|$label| !$label|$filter> )
See messages in Mail::Box.
$obj->nrMessages( %options )
See nrMessages in Mail::Box.
$obj->scanForMessages( $message, $message_ids, $timespan, $window )
See scanForMessages in Mail::Box.

Sub-folders

$obj->listSubFolders( %options )
$class->listSubFolders( %options )
See listSubFolders in Mail::Box.
$obj->nameOfSubFolder( $subname, [$parentname] )
$class->nameOfSubFolder( $subname, [$parentname] )
See nameOfSubFolder in Mail::Box.
$obj->openRelatedFolder( %options )
See openRelatedFolder in Mail::Box.
$obj->openSubFolder( $subname, %options )
See openSubFolder in Mail::Box.
$obj->topFolderWithMessages
$class->topFolderWithMessages
See topFolderWithMessages in Mail::Box.

Internals

$obj->acceptMessages

Accept all messages which are waiting in the new directory to be moved to the cur directory. This will not rescan the directory for newly arrived messages, because that's a task for update().

$class->appendMessage( %options )
» Error: Cannot append Maildir message in $new to folder $self.

The message (or messages) could not be stored in the right directories for the Maildir folder.

$obj->coerce( $message, %options )
» Error: Cannot create Maildir message file $new.

A message is converted from some other message format into a Maildir format by writing it to a file with a name which contains the status flags of the message. Apparently, creating this file failed.

$obj->create( $foldername, %options )
$class->create( $foldername, %options )
Option Defined in Default

folderdir

Mail::Box

undef

folderdir => DIRECTORY
» Error: Cannot create Maildir folder $name.

One or more of the directories required to administer a Maildir folder could not be created.

$obj->createDirs( $folderdir )
$class->createDirs( $folderdir )

The $folderdir contains the absolute path of the location where the messages are kept. Maildir folders contain a tmp, new, and cur sub-directory within that folder directory as well. This method will ensure that all directories exist. Returns false on failure.

» Error: Cannot create Maildir directory $dir: $!

A Maildir folder is represented by a directory, with some sub-directories. The top folder directory could not be created for the reason indicated.

» Error: Cannot create Maildir subdir $dir: $!

Each Maildir folder has three sub-directories for administration: new, tmp, and cur. The mentioned directory could not be created for the indicated reason.

$obj->determineBodyType( $message, $head )
See determineBodyType in Mail::Box.
$obj->folderIsEmpty( $folderdir )
$class->folderIsEmpty( $folderdir )

Checks whether the folder whose directory is specified as absolute $folderdir is empty or not. A folder is empty when the tmp, new, and cur subdirectories are empty and some files which are left there by application programs. The maildir spec explicitly states: .qmail, bulletintime, bulletinlock and seriallock. If any other files are found, the directory is considered not-empty.

$obj->folderToDirectory( $foldername, $folderdir )
See folderToDirectory in Mail::Box::Dir.
$class->foundIn( [$foldername], %options )
See foundIn in Mail::Box.
$obj->lineSeparator( [<STRING|'CR'|'LF'|'CRLF'>] )
See lineSeparator in Mail::Box.
$obj->locker
See locker in Mail::Box.
$obj->read( %options )
See read in Mail::Box.
$obj->readMessageFilenames( $directory )
See readMessageFilenames in Mail::Box::Dir.
$obj->readMessages( %options )
See readMessages in Mail::Box.
$obj->storeMessage( $message )
See storeMessage in Mail::Box.
$obj->toBeThreaded( $messages )
See toBeThreaded in Mail::Box.
$obj->toBeUnthreaded( $messages )
See toBeUnthreaded in Mail::Box.
$obj->updateMessages( %options )
See updateMessages in Mail::Box.
$obj->write( %options )
See write in Mail::Box.
$obj->writeMessages( %options )
See writeMessages in Mail::Box.

Other methods

$obj->timespan2seconds( $time )
$class->timespan2seconds( $time )
See timespan2seconds in Mail::Box.

Error handling

$obj->AUTOLOAD
See AUTOLOAD in Mail::Reporter.
$obj->addReport( $object )
See addReport in Mail::Reporter.
$obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
$class->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
See defaultTrace in Mail::Reporter.
$obj->errors
See errors in Mail::Reporter.
$obj->log( [$level, [$strings]] )
$class->log( [$level, [$strings]] )
See log in Mail::Reporter.
$obj->logPriority( $level )
$class->logPriority( $level )
See logPriority in Mail::Reporter.
$obj->logSettings
See logSettings in Mail::Reporter.
$obj->notImplemented
See notImplemented in Mail::Reporter.
$obj->report( [$level] )
See report in Mail::Reporter.
$obj->reportAll( [$level] )
See reportAll in Mail::Reporter.
$obj->trace( [$level] )
See trace in Mail::Reporter.
$obj->warnings
See warnings in Mail::Reporter.

Cleanup

$obj->DESTROY
See DESTROY in Mail::Box.