METHODS

See METHODS in Mail::Reporter

Constructors

$class->new( OPTIONS )

You may also pass all OPTIONS understood by the initiated lockers used by the multi locker.

Option Defined in Default

expires

Mail::Box::Locker

1 hour

file

Mail::Box::Locker

undef

folder

Mail::Box::Locker

<undef>

log

Mail::Reporter

'WARNINGS'

method

Mail::Box::Locker

'MULTI'

timeout

Mail::Box::Locker

10 seconds

trace

Mail::Reporter

'WARNINGS'

use

<all possible>

expires => SECONDS
file => FILENAME
folder => FOLDER
log => LEVEL
method => STRING|CLASS|ARRAY
timeout => SECONDS|'NOTIMEOUT'
trace => LEVEL
use => ARRAY-of-(NAMES|LOCKER)
Array of locker type NAMES or LOCKER objects to be used to lock one folder. The type NAMES are converted into objects. When you create your own LOCKER objects, be sure to set the timeout very short (preferrably to 1).
Some locking types are not available on some platforms, so they will not be excluded from the default list (NFS POSIX Flock).
» Example: using a subset of multi-lockers
 my $locker = Mail::Box::Locker::Multi->new(use => ['DOTLOCK','FLOCK']);

The Locker

$obj->filename( [FILENAME] )
See filename in Mail::Box::Locker.
$obj->folder( [FOLDER] )
See folder in Mail::Box::Locker.
$obj->lockers

Returns a list with all locker objects used by this object.

$obj->name
See name in Mail::Box::Locker.

Locking

$obj->hasLock
See hasLock in Mail::Box::Locker.
$obj->isLocked
See isLocked in Mail::Box::Locker.
$obj->lock( FOLDER )
See lock in Mail::Box::Locker.
$obj->unlock
See unlock in Mail::Box::Locker.

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