Mail::Box::Locker::MutUser Contributed Perl DocumentMail::Box::Locker::Mutt(3)NAMEMail::Box::Locker::Mutt - lock a folder using mutt_dotlock
INHERITANCEMail::Box::Locker::Mutt
is a Mail::Box::Locker
is a Mail::Reporter
SYNOPSIS
See Mail::Box::Locker
DESCRIPTION
The "mutt" mail reader includes an separate program which is
specialized in locking folders. This locker class uses this external
program. Mutt is not automatically installed.
METHODS
$obj->exe
Returns the name of the external binary.
Constructors
Mail::Box::Locker::Mutt->new(OPTIONS)
Option --Defined in --Default
exe mutt_dotlock
expires Mail::Box::Locker 1 hour
file Mail::Box::Locker undef
folder Mail::Box::Locker <undef>
log Mail::Reporter 'WARNINGS'
method Mail::Box::Locker 'DOTLOCK'
timeout Mail::Box::Locker 10 seconds
trace Mail::Reporter 'WARNINGS'
. exe => PATH
The name of the program. May be a relative or absolute path.
. expires => SECONDS
. file => FILENAME
. folder => FOLDER
. log => LEVEL
. method => STRING|CLASS|ARRAY
. timeout => SECONDS|'NOTIMEOUT'
. trace => LEVEL
The Locker
$obj->filename([FILENAME])
See "The Locker" in Mail::Box::Locker
$obj->folder([FOLDER])
See "The Locker" in Mail::Box::Locker
$obj->name
See "The Locker" in Mail::Box::Locker
Locking
$obj->hasLock
See "Locking" in Mail::Box::Locker
$obj->isLocked
See "Locking" in Mail::Box::Locker
$obj->lock
$obj->unlock
Error handling
$obj->AUTOLOAD
See "Error handling" in Mail::Reporter
$obj->addReport(OBJECT)
See "Error handling" in Mail::Reporter
$obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
Mail::Box::Locker::Mutt->defaultTrace([LEVEL]|[LOGLEVEL,
TRACELEVEL]|[LEVEL, CALLBACK])
See "Error handling" in Mail::Reporter
$obj->errors
See "Error handling" in Mail::Reporter
$obj->log([LEVEL [,STRINGS]])
Mail::Box::Locker::Mutt->log([LEVEL [,STRINGS]])
See "Error handling" in Mail::Reporter
$obj->logPriority(LEVEL)
Mail::Box::Locker::Mutt->logPriority(LEVEL)
See "Error handling" in Mail::Reporter
$obj->logSettings
See "Error handling" in Mail::Reporter
$obj->notImplemented
See "Error handling" in Mail::Reporter
$obj->report([LEVEL])
See "Error handling" in Mail::Reporter
$obj->reportAll([LEVEL])
See "Error handling" in Mail::Reporter
$obj->trace([LEVEL])
See "Error handling" in Mail::Reporter
$obj->warnings
See "Error handling" in Mail::Reporter
Cleanup
$obj->DESTROY
See "Cleanup" in Mail::Box::Locker
$obj->inGlobalDestruction
See "Cleanup" in Mail::Reporter
DIAGNOSTICS
Warning: Couldn't remove mutt-unlock $folder: $!
Error: Failed to remove expired mutt-lock $lockfile: $!
Warning: Folder $folder already mutt-locked
Error: Package $package does not implement $method.
Fatal error: the specific package (or one of its superclasses) does
not implement this method where it should. This message means that
some other related classes do implement this method however the
class at hand does not. Probably you should investigate this and
probably inform the author of the package.
Warning: Removed expired mutt-lock $lockfile
SEE ALSO
This module is part of Mail-Box distribution version 2.094, built on
April 06, 2010. Website: http://perl.overmeer.net/mailbox/
LICENSE
Copyrights 2001-2010 by Mark Overmeer. For other contributors see
ChangeLog.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself. See
http://www.perl.com/perl/misc/Artistic.html
perl v5.10.1 2010-04-06 Mail::Box::Locker::Mutt(3)
