METHODS

See METHODS in Mail::Reporter

Constructors

$class->new( %options )
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

POSIX

posix_file

<undef>

timeout

Mail::Box::Locker

10

trace

Mail::Reporter

'WARNINGS'

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

Attributes

$obj->expires( [SECONDS] )
See expires in Mail::Box::Locker.
$obj->timeout( [SECONDS] )
See timeout in Mail::Box::Locker.

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
» Error: Unable to check lock file $filename for $folder: $!

To check whether the filename is used to flock a folder, the file must be opened. Apparently this fails, which does not mean that the folder is locked neither that it is unlocked.

$obj->lock
» Warning: Folder $folder already lockf'd
» Error: Unable to open POSIX lock file $filename for $folder: $!

For POSIX style locking, a folder it must be opened, which does not succeed for the specified reason.

» Error: Will never get a POSIX lock at $filename for $folder: $!

Tried to lock the folder, but it did not succeed. The error code received from the OS indicates that it will not succeed ever, so we do not need to try again.

$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.