METHODS

See METHODS in Mail::Reporter

Constructors

$class->new( %options )
Option Defined in Default

autodetect

Mail::Box::Manager

undef

collection_type

Mail::Box::Manage::User

Mail::Box::Collection

default_folder_type

Mail::Box::Manager

'mbox'

delimiter

Mail::Box::Manage::User

"/"

folder_id_type

Mail::Box::Manage::User

Mail::Box::Identity

folder_types

Mail::Box::Manager

<all standard types>

folderdir

Mail::Box::Manager

[ '.' ]

folderdirs

Mail::Box::Manager

<synonym for folderdir>

identity

Mail::Box::Manage::User

<required>

inbox

Mail::Box::Manage::User

undef

index_filename

$folderdir/index

log

Mail::Reporter

'WARNINGS'

topfolder_name

Mail::Box::Manage::User

'='

trace

Mail::Reporter

'WARNINGS'

autodetect => TYPE|ARRAY-OF-TYPES
collection_type => CLASS
default_folder_type => NAME|CLASS
delimiter => STRING
folder_id_type => CLASS|OBJECT
folder_types => NEW-TYPE | ARRAY-OF-NEW-TYPES
folderdir => DIRECTORY
folderdirs => [DIRECTORIES]
identity => OBJECT
inbox => NAME
index_filename => FILENAME
log => LEVEL
topfolder_name => STRING
trace => LEVEL

Attributes

$obj->defaultFolderType
See defaultFolderType in Mail::Box::Manager.
$obj->folderTypes
See folderTypes in Mail::Box::Manager.
$obj->folderdir
See folderdir in Mail::Box::Manager.
$obj->identity
See identity in Mail::Box::Manage::User.
$obj->inbox( [$name] )
See inbox in Mail::Box::Manage::User.
$obj->indexFilename

Returns the filename of the index file.

$obj->registerType( $type, $class, %options )
See registerType in Mail::Box::Manager.

Manage open folders

$obj->close( $folder, %options )
See close in Mail::Box::Manager.
$obj->closeAllFolders( , %options )
See closeAllFolders in Mail::Box::Manager.
$obj->isOpenFolder( $folder )
See isOpenFolder in Mail::Box::Manager.
$obj->open( [$foldername], %options )
See open in Mail::Box::Manager.
$obj->openFolders
See openFolders in Mail::Box::Manager.

Manage existing folders

$obj->folder( $name )
See folder in Mail::Box::Manage::User.
$obj->folderCollection( $name )
See folderCollection in Mail::Box::Manage::User.
$obj->rename( $oldname, $newname, %options )
See rename in Mail::Box::Manage::User.
$obj->topfolder
See topfolder in Mail::Box::Manage::User.

Move messages to folders

$obj->appendMessage( [$folder|$foldername], $messages, %options )
See appendMessage in Mail::Box::Manager.
$obj->copyMessage( [$folder|$foldername], $messages, %options )
See copyMessage in Mail::Box::Manager.
$obj->moveMessage( [$folder|$foldername], $messages, %options )
See moveMessage in Mail::Box::Manager.

Manage message threads

$obj->threads( [$folders], %options )
See threads in Mail::Box::Manager.

Internals

$obj->decodeFolderURL( $url )
See decodeFolderURL in Mail::Box::Manager.
$obj->toBeThreaded( $folder, $messages )
See toBeThreaded in Mail::Box::Manager.
$obj->toBeUnthreaded( $folder, $messages )
See toBeUnthreaded in Mail::Box::Manager.

Error handling

$obj->AUTOLOAD
See AUTOLOAD in Mail::Reporter.
$obj->addReport( $object )
See addReport in Mail::Reporter.
$obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
$class->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
See defaultTrace in Mail::Reporter.
$obj->errors
See errors in Mail::Reporter.
$obj->log( [$level, [$strings]] )
$class->log( [$level, [$strings]] )
See log in Mail::Reporter.
$obj->logPriority( $level )
$class->logPriority( $level )
See logPriority in Mail::Reporter.
$obj->logSettings
See logSettings in Mail::Reporter.
$obj->notImplemented
See notImplemented in Mail::Reporter.
$obj->report( [$level] )
See report in Mail::Reporter.
$obj->reportAll( [$level] )
See reportAll in Mail::Reporter.
$obj->trace( [$level] )
See trace in Mail::Reporter.
$obj->warnings
See warnings in Mail::Reporter.

Cleanup

$obj->DESTROY
See DESTROY in Mail::Reporter.

Manage folders

$obj->create( $name, %options )

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

[]

create_real => BOOLEAN
create_supers => BOOLEAN
deleted => BOOLEAN
id_options => ARRAY
» Error: Cannot create folder directory $dir: $!
» Error: Cannot write name for folder in $file: $!
» Error: Failed writing folder name to $file: $!
» Warning: Folder $name already exists, creation skipped
$obj->delete( $name, %options )

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');
» Error: Unable to remove folder $dir
$obj->folderInfo( $name )

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.

» Example: how to get global info about a folder
 my $info = $user->folderInfo($name); # get info