METHODS

See METHODS in Mail::Reporter

Constructors

$class->new( OPTIONS )

Name of the file to lock. By default, the folder's name is extended with .lock.

Option Defined in Default

dotlock_file

<undef>

expires

Mail::Box::Locker

1 hour

file

Mail::Box::Locker

<folderfile>.lock

folder

Mail::Box::Locker

<undef>

log

Mail::Reporter

'WARNINGS'

method

Mail::Box::Locker

'DOTLOCK'

timeout

Mail::Box::Locker

10 seconds

trace

Mail::Reporter

'WARNINGS'

dotlock_file => FILENAME
Alternative name for file, especially useful to confusion when the multi locker is used.
expires => SECONDS
file => FILENAME
folder => FOLDER
log => LEVEL
method => STRING|CLASS|ARRAY
timeout => SECONDS|'NOTIMEOUT'
trace => LEVEL

The Locker

$obj->filename( [FILENAME] )
See filename in Mail::Box::Locker.
$obj->folder( [FOLDER] )
See folder in Mail::Box::Locker.
$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
» Error: Failed to remove expired lockfile $lockfile: $!
» Warning: Folder already locked with file $lockfile
» Warning: Removed expired lockfile $lockfile
$obj->unlock
» Warning: Couldn't remove lockfile $lock: $!

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.