See METHODS in Mail::Reporter
Option | Defined in | Default |
---|---|---|
autodetect | Mail::Box::Manager |
|
collection_type | Mail::Box::Manage::User | |
default_folder_type | Mail::Box::Manager |
|
delimiter | Mail::Box::Manage::User | "/" |
folder_id_type | Mail::Box::Manage::User | |
folder_types | Mail::Box::Manager | <all standard types> |
folderdir | Mail::Box::Manager |
|
folderdirs | Mail::Box::Manager | <synonym for |
identity | Mail::Box::Manage::User | <required> |
inbox | Mail::Box::Manage::User |
|
index_filename |
| |
log | Mail::Reporter |
|
topfolder_name | Mail::Box::Manage::User |
|
trace | Mail::Reporter |
|
Returns the filename of the index file.
Creates a new folder with the specified name. Folder info is returned, which will be very simple. In the accidental case that the folder already exists, a warning will be issued, and that folder's data returned.
Option | Defined in | Default |
---|---|---|
create_real | Mail::Box::Manage::User | <true> |
create_supers | Mail::Box::Manage::User | <false> |
deleted | Mail::Box::Manage::User | <false> |
id_options | Mail::Box::Manage::User | [] |
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 a hash with folder information. In normal circumstances, it is cheap to get these details, because they are cached in an index file, maintained by Mail::Box::Netzwert::UserIndex.
DO NOT modify the values you find in the hash, because that data may or may not be lost (see Mail::Box::Netzwert::UserIndex subroutine change).
DO NOT trust on the existence of any field in the info: fields may get renamed, removed, or added over time. Not all folder indexes will be generated by the same software release.
my $info = $user->folderInfo($name); # get info