NAME

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

Mail::Box::Dbx->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::Dbx->listSubFolders(OPTIONS)

It is adviced to set the check flag, because dbx folder often list large amounts of folder names which do not really exist. However, checking does consume some time.

Option    --Defined in     --Default
check       Mail::Box        <false>
folder      Mail::Box        <from calling object>
folderdir   Mail::Box        <from folder>
skip_empty  Mail::Box        <false>

. check => BOOLEAN

. folder => FOLDERNAME

. folderdir => DIRECTORY

. skip_empty => BOOL

$obj->nameOfSubFolder(SUBNAME, [PARENTNAME])

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

$obj->openRelatedFolder(OPTIONS)

$obj->openSubFolder(SUBNAME, OPTIONS)

$obj->topFolderWithMessages

Mail::Box::Dbx->topFolderWithMessages

Internals

$obj->coerce(MESSAGE, OPTIONS)

$obj->create(FOLDERNAME, OPTIONS)

Mail::Box::Dbx->create(FOLDERNAME, OPTIONS)

Creation is not supported for dbx folders.

Option   --Defined in--Default
folderdir  Mail::Box   undef

. folderdir => DIRECTORY

$obj->determineBodyType(MESSAGE, HEAD)

$obj->folderToFilename(FOLDERNAME, FOLDERDIR)

Mail::Box::Dbx->folderToFilename(FOLDERNAME, FOLDERDIR)

Translate a folder name into a filename, using the FOLDERDIR value to replace a leading =.

Mail::Box::Dbx->foundIn([FOLDERNAME], [OPTIONS])

If no FOLDERNAME is specified, then the value of the folder option is taken. A dbx folder is a file which name ends on .dbx (case insensitive).

Option   --Defined in     --Default
folder                      undef
folderdir  Mail::Box        undef

. folder => FOLDERNAME

. folderdir => DIRECTORY

$obj->lineSeparator([STRING|'CR'|'LF'|'CRLF'])

$obj->locker

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

$obj->moveAwaySubFolder(DIRECTORY, EXTENSION)

$obj->parser

The parsing of messages is a combined job for the Mail::Transport::Dbx module (to get the right data) and read(). Asking for the parser will provide the transporter object. If asked more than once, each time the same object will be returned.

$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::Dbx->timespan2seconds(TIME)

See "Other methods" in Mail::Box

Error handling

$obj->AUTOLOAD

$obj->addReport(OBJECT)

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

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

$obj->errors

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

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

$obj->logPriority(LEVEL)

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

$obj->logSettings

$obj->notImplemented

$obj->report([LEVEL])

$obj->reportAll([LEVEL])

$obj->trace([LEVEL])

$obj->warnings