The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Mail::Box::Locker::Mutt - lock a folder using mutt_dotlock

INHERITANCE

 Mail::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  <required>
     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])

$obj->folder

$obj->name

Locking

$obj->hasLock

$obj->isLocked

$obj->lock

$obj->unlock

Error handling

$obj->AUTOLOAD

$obj->addReport(OBJECT)

$obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

Mail::Box::Locker::Mutt->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

$obj->errors

$obj->log([LEVEL [,STRINGS]])

Mail::Box::Locker::Mutt->log([LEVEL [,STRINGS]])

$obj->logPriority(LEVEL)

Mail::Box::Locker::Mutt->logPriority(LEVEL)

$obj->logSettings

$obj->notImplemented

$obj->report([LEVEL])

$obj->reportAll([LEVEL])

$obj->trace([LEVEL])

$obj->warnings

Cleanup

$obj->DESTROY

$obj->inGlobalDestruction

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.070, built on March 25, 2007. Website: http://perl.overmeer.net/mailbox/

LICENSE

Copyrights 2001-2007 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