See METHODS in Mail::Reporter
Use new(default_folder_type) to explicitly state which kind of folders you use.
Option | Defined in | Default |
---|---|---|
autodetect | Mail::Box::Manager |
|
collection_type | ||
default_folder_type | Mail::Box::Manager |
|
delimiter | "/" | |
folder_id_type | ||
folder_types | Mail::Box::Manager | <all standard types> |
folderdir | Mail::Box::Manager |
|
folderdirs | Mail::Box::Manager | <synonym for |
identity | <required> | |
inbox |
| |
log | Mail::Reporter |
|
topfolder_name |
| |
trace | Mail::Reporter |
|
Returns a User::Identity object.
(Set and) get the NAME of the mailbox which is considered the folder for incoming mail. In many protocols, this folder is handled separately. For instance in IMAP this is the only case-insensitive folder name.
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 | [] |
Unless you set create(create_supers), all higher level folders must exist before this new one can be created.
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> |
print "no xyz (anymore)\n" if $user->delete('xyz');
Returns the folder description, a Mail::Box::Identity.
Returns a pair: the folder collection (Mail::Box::Collection) and the base name of NAME.
Rename the folder with name OLDNAME to NEWNAME. Both names are full pathnames.
Option | Default |
---|---|
create_supers | <false> |
Unless you set create(create_supers), all higher level folders must exist before this new one can be created.
Returns the top folder of the user's mailbox storage.