NAME

$obj->folderTypes

$obj->folderdir

$obj->identity

Returns a User::Identity object.

$obj->inbox([NAME])

(Set and) get the NAME of the mailbox which is considered the folder for incoming mail. In many protocols, this folder is handled seperately. For instance in IMAP this is the only case-insensitive folder name.

$obj->registerType(TYPE, CLASS [,OPTIONS])

Manage open folders

$obj->close(FOLDER, OPTIONS)

$obj->closeAllFolders(, OPTIONS)

$obj->isOpenFolder(FOLDER)

$obj->open([FOLDERNAME], OPTIONS)

$obj->openFolders

See Mail::Box::Manager/"Move messages to folders"

Manage existing folders

$obj->create(NAME, OPTIONS)

Creates a new folder with the specified name. An folder's administrative structure (Mail::Box::Identity) is returned, but the folder is not opened.

In the accidental case that the folder already exists, a warning will be issued, and an empty list/undef returned.

The OPTIONS are passed to Mail::Box::create() of your default folder type, except for the options intended for this method itself.

 Option       --Default
 create_real    <true>
 create_supers  <false>
 deleted        <false>
 id_options     []

. create_real => BOOLEAN

When this option is false, the pysical folder will not be created, but only the administration is updated.

. create_supers => BOOLEAN

When you create a folder where upper hierarchy level are missing, they will be created as well.

. deleted => BOOLEAN

The folder starts as deleted.

. id_options => ARRAY

Values passed to the instantiated Mail::Box::Identity. That object is very picky about the initiation values it accepts.

$obj->delete(NAME)

Remove all signs from the folder on the file-system. Messages still in the folder will be removed. This method returns a true value when the folder has been removed or not found, so "false" means failure.

It is also possible to delete a folder using $folder->delete, which will call this method here. OPTIONS, which are used for some other folder types, will be ignored here: the user's index contains the required details.

 Option   --Defined in        --Default
 recursive  Mail::Box::Manager  <folder's default>

. recursive => BOOLEAN

example: how to delete a folder

 print "no xyz (anymore)\n" if $user->delete('xyz');

$obj->folder(NAME)

Returns the folder description, a Mail::Box::Identity.

$obj->folderCollection(NAME)

Returns a pair: the folder collection (Mail::Box::Collection) and the base name of NAME.

$obj->rename(OLDNAME, NEWNAME, OPTIONS)

Rename the folder with name OLDNAME to NEWNAME. Both names are full pathnames.

 Option       --Default
 create_supers  <false>

. create_supers => BOOLEAN

When you rename a folder to a place where upper hierarchy levels are missing, they will get be defined, but with the deleted flag set.

$obj->topfolder

Returns the top folder of the user's mailbox storage.

Move messages to folders

$obj->appendMessage([FOLDER|FOLDERNAME,] MESSAGES, OPTIONS)

$obj->copyMessage([FOLDER|FOLDERNAME,] MESSAGES, OPTIONS)

See Mail::Box::Manager/"Move messages to folders"

$obj->moveMessage([FOLDER|FOLDERNAME,] MESSAGES, OPTIONS)

See Mail::Box::Manager/"Move messages to folders"

Manage message threads

$obj->threads([FOLDERS], OPTIONS)

See Mail::Box::Manager/"Manage message threads"

Internals

$obj->decodeFolderURL(URL)

See Mail::Box::Manager/"Internals"

$obj->toBeThreaded(FOLDER, MESSAGES)

See Mail::Box::Manager/"Internals"

$obj->toBeUnthreaded(FOLDER, MESSAGES)

See Mail::Box::Manager/"Internals"

Error handling

$obj->AUTOLOAD

$obj->addReport(OBJECT)

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

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

$obj->errors

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

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

$obj->logPriority(LEVEL)

Mail::Box::Manage::User->logPriority(LEVEL)

$obj->logSettings

$obj->notImplemented

$obj->report([LEVEL])

$obj->reportAll([LEVEL])

$obj->trace([LEVEL])

$obj->warnings