NAME

$obj->addMessages(MESSAGE [, MESSAGE, ...])

Mail::Box::Mbox->appendMessages(OPTIONS)

See "METHODS" in Mail::Box::File

$obj->close(OPTIONS)

$obj->copyTo(FOLDER, OPTIONS)

$obj->delete(OPTIONS)

$obj->filename

See "The folder" in Mail::Box::File

$obj->folderdir([DIRECTORY])

$obj->name

$obj->organization

$obj->size

$obj->type

$obj->update(OPTIONS)

$obj->url

Folder flags

$obj->access

$obj->isModified

$obj->modified([BOOLEAN])

$obj->writable

The messages

$obj->current([NUMBER|MESSAGE|MESSAGE-ID])

$obj->find(MESSAGE-ID)

$obj->findFirstLabeled(LABEL, [BOOLEAN, [ARRAY-OF-MSGS]])

$obj->message(INDEX [,MESSAGE])

$obj->messageId(MESSAGE-ID [,MESSAGE])

$obj->messageIds

$obj->messages(['ALL',RANGE,'ACTIVE','DELETED',LABEL,!LABEL,FILTER])

$obj->nrMessages(OPTIONS)

$obj->scanForMessages(MESSAGE, MESSAGE-IDS, TIMESPAN, WINDOW)

Sub-folders

$obj->listSubFolders(OPTIONS)

Mail::Box::Mbox->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])

Mail::Box::Mbox->nameOfSubFolder(SUBNAME, [PARENTNAME])

$obj->openRelatedFolder(OPTIONS)

$obj->openSubFolder(SUBNAME, OPTIONS)

$obj->topFolderWithMessages

Mail::Box::Mbox->topFolderWithMessages

Internals

$obj->coerce(MESSAGE, OPTIONS)

$obj->create(FOLDERNAME, OPTIONS)

Mail::Box::Mbox->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)

$obj->folderToFilename(FOLDERNAME, FOLDERDIR, [EXTENSION])

Mail::Box::Mbox->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'.

Mail::Box::Mbox->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'])

$obj->locker

$obj->messageCreateOptions([TYPE, CONFIG])

$obj->moveAwaySubFolder(DIRECTORY, EXTENSION)

$obj->parser

$obj->read(OPTIONS)

$obj->readMessages(OPTIONS)

$obj->storeMessage(MESSAGE)

$obj->toBeThreaded(MESSAGES)

$obj->toBeUnthreaded(MESSAGES)

$obj->updateMessages(OPTIONS)

$obj->write(OPTIONS)

$obj->writeMessages(OPTIONS)

File based folders

Other methods

$obj->timespan2seconds(TIME)

Mail::Box::Mbox->timespan2seconds(TIME)

See "Other methods" in Mail::Box

Error handling

$obj->AUTOLOAD

$obj->addReport(OBJECT)

$obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

Mail::Box::Mbox->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

$obj->errors

$obj->log([LEVEL [,STRINGS]])

Mail::Box::Mbox->log([LEVEL [,STRINGS]])

$obj->logPriority(LEVEL)

Mail::Box::Mbox->logPriority(LEVEL)

$obj->logSettings

$obj->notImplemented

$obj->report([LEVEL])

$obj->reportAll([LEVEL])

$obj->trace([LEVEL])

$obj->warnings