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

access

Mail::Box

'r'

body_delayed_type

Mail::Box

Mail::Message::Body::Delayed

body_type

Mail::Box::File

<see description>

coerce_options

Mail::Box

[]

create

Mail::Box

<false>

extract

Mail::Box

10240

field_type

Mail::Box

undef

fix_headers

Mail::Box

<false>

folder

Mail::Box

$ENV{MAIL}

folderdir

Mail::Box

$ENV{HOME}.'/Mail'

head_delayed_type

Mail::Box

Mail::Message::Head::Delayed

head_type

Mail::Box

Mail::Message::Head::Complete

keep_dups

Mail::Box

<false>

lock_extension

Mail::Box::File

'.lock'

lock_file

Mail::Box

<foldername><lock-extension>

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

Mail::Box::Mbox::Message

multipart_type

Mail::Box

Mail::Message::Body::Multipart

remove_when_empty

Mail::Box

<true>

save_on_exit

Mail::Box

<true>

subfolder_extension

'.d'

trace

Mail::Reporter

'WARNINGS'

trusted

Mail::Box

<depends on folder location>

write_policy

Mail::Box::File

undef

access => MODE
body_delayed_type => CLASS
body_type => CLASS|CODE
coerce_options => ARRAY
create => BOOLEAN
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_extension => FILENAME|STRING
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
subfolder_extension => STRING
Mbox folders do not support sub-folders. However, this module can simulate sub-directories if the user wants it to. When a subfolder of folder xyz is created, we create a directory which is called xyz.d to contain them. This extension .d can be changed using this option.
trace => LEVEL
trusted => BOOLEAN
write_policy => 'REPLACE'|'INPLACE'|undef

The folder

$obj->addMessage( MESSAGE, OPTIONS )
See addMessage in Mail::Box.
$obj->addMessages( MESSAGE [, MESSAGE, ...] )
See addMessages in Mail::Box.
$class->appendMessages( OPTIONS )
See appendMessages in Mail::Box::File.
$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->filename
See filename in Mail::Box::File.
$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, [ARRAY-OF-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 )
Option Defined in Default

check

Mail::Box

<false>

folder

Mail::Box

<from calling object>

folderdir

Mail::Box

<from folder>

skip_empty

Mail::Box

<false>

subfolder_extension

<from object>

check => BOOLEAN
folder => FOLDERNAME
folderdir => DIRECTORY
skip_empty => BOOL
subfolder_extension => STRING
When the method is called on an open folder, the extension defined by it is used to detect sub-folders by default. Otherwise, '.d' is taken.
$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->coerce( MESSAGE, OPTIONS )
See coerce in Mail::Box.
$obj->create( FOLDERNAME, OPTIONS )
$class->create( FOLDERNAME, OPTIONS )
Option Defined in Default

folderdir

Mail::Box

undef

subfolder_extension

undef

folderdir => DIRECTORY
subfolder_extension => STRING
If a directory is found on the location of the folder to be created, this STRING is used to extend that directory name with. This will cause the directory to be seen as sub-folder for the created folder. This argument is passed to folderToFilename().
$obj->determineBodyType( MESSAGE, HEAD )
See determineBodyType in Mail::Box.
$obj->folderToFilename( FOLDERNAME, FOLDERDIR, [EXTENSION] )
$class->folderToFilename( FOLDERNAME, FOLDERDIR, [EXTENSION] )

Translate a folder name into a filename, using the FOLDERDIR value to replace a leading =. If no EXTENSION is specified and this method is called as instance method, new(subfolder_extension) is used. Otherwise, the extension default to '.d'.

$class->foundIn( [FOLDERNAME], [OPTIONS] )

If no FOLDERNAME is specified, then the value of the folder option is taken. A mbox folder is a file which starts with a separator line: a line with 'From ' as first characters. Blank lines which start the file are ignored, which is not for all MUA's acceptable.

Option Defined in Default

folder

undef

folderdir

Mail::Box

undef

subfolder_extension

<from object>

folder => FOLDERNAME
folderdir => DIRECTORY
subfolder_extension => STRING
$obj->lineSeparator( [STRING|'CR'|'LF'|'CRLF'] )
See lineSeparator in Mail::Box.
$obj->locker
See locker in Mail::Box.
$obj->messageCreateOptions( [TYPE, CONFIG] )
See messageCreateOptions in Mail::Box::File.
$obj->moveAwaySubFolder( DIRECTORY, EXTENSION )
See moveAwaySubFolder in Mail::Box::File.
$obj->parser
See parser in Mail::Box::File.
$obj->read( OPTIONS )
See read in Mail::Box.
$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::File.
$obj->write( OPTIONS )
See write in Mail::Box::File.
$obj->writeMessages( OPTIONS )
See writeMessages in Mail::Box.

File based folders

See File based folders in Mail::Box::File

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.
$obj->inGlobalDestruction
See inGlobalDestruction in Mail::Reporter.