OVERLOADED

overload: @{}
See @{} in User::Identity::Collection.
overload: stringification
See stringification in User::Identity::Collection.

METHODS

See METHODS in Mail::Reporter

Constructors

$class->new( [NAME], OPTIONS )
Option Defined in Default

description

User::Identity::Item

undef

folder_type

<from parent>

item_type

User::Identity::Collection

Mail::Box::Identity

log

Mail::Reporter

'WARNINGS'

manager

<from parent>

name

User::Identity::Item

'folders'

parent

User::Identity::Item

undef

roles

User::Identity::Collection

undef

trace

Mail::Reporter

'WARNINGS'

description => STRING
folder_type => CLASS
item_type => CLASS
log => LEVEL
manager => OBJECT
An Mail::Box::Manager OBJECT (could be a Mail::Box::Manage::User).
name => STRING
parent => OBJECT
roles => ROLE|ARRAY
trace => LEVEL

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.
$obj->inGlobalDestruction
See inGlobalDestruction in Mail::Reporter.

Attributes

$obj->description
See description in User::Identity::Item.
$obj->folderType( [FOLDERCLASS] )

Returns the type of folder (on this location). When specified, then FOLDERCLASS must be a Mail::Box extension.

$obj->itemType
See itemType in User::Identity::Collection.
$obj->manager

The Mail::Box::Manager (usually a Mail::Box::Manage::User object), which is handling the opening of folders.

$obj->name( [NEWNAME] )
See name in User::Identity::Item.
$obj->roles
See roles in User::Identity::Collection.

Collections

$obj->add( COLLECTION, ROLE )
See add in User::Identity::Item.
$obj->addCollection( OBJECT | ([TYPE], OPTIONS) )
See addCollection in User::Identity::Item.
$obj->collection( NAME )
See collection in User::Identity::Item.
$obj->parent( [PARENT] )
See parent in User::Identity::Item.
$obj->removeCollection( OBJECT|NAME )
See removeCollection in User::Identity::Item.
$obj->type
$class->type
See type in User::Identity::Item.
$obj->user
See user in User::Identity::Item.

Maintaining roles

$obj->addRole( ROLE| ( [NAME],OPTIONS ) | ARRAY-OF-OPTIONS )
See addRole in User::Identity::Collection.
$obj->removeRole( ROLE|NAME )
See removeRole in User::Identity::Collection.
$obj->renameRole( ROLE|OLDNAME, NEWNAME )
See renameRole in User::Identity::Collection.
$obj->sorted
See sorted in User::Identity::Collection.

Searching

$obj->find( NAME|CODE|undef )
See find in User::Identity::Collection.