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 email reader includes a separate program which is specialized in locking folders. This locker class uses this external program. Mutt is not automatically installed.

Extends "DESCRIPTION" in Mail::Box::Locker.

METHODS

Extends "METHODS" in Mail::Box::Locker.

Constructors

Extends "Constructors" in Mail::Box::Locker.

$class->new(%options)

Inherited, see "METHODS" in Mail::Box::Locker

-Option --Defined in       --Default
 exe                         mutt_dotlock
 expires  Mail::Box::Locker  1 hour
 file     Mail::Box::Locker  undef
 folder   Mail::Box::Locker  <C<undef>>
 log      Mail::Reporter     'WARNINGS'
 method   Mail::Box::Locker  'DOTLOCK'
 timeout  Mail::Box::Locker  10
 trace    Mail::Reporter     'WARNINGS'

exe => PATH

The name of the program. May be a relative or absolute path.

expires => $seconds

file => $file

folder => $folder

log => LEVEL

method => $name|CLASS|\@names

timeout => $seconds|'NOTIMEOUT'

trace => LEVEL

Attributes

Extends "Attributes" in Mail::Box::Locker.

$obj->exe()

Returns the name of the external binary.

$obj->expires( [SECONDS] )

Inherited, see "Attributes" in Mail::Box::Locker

$obj->filename( [$filename] )

Inherited, see "Attributes" in Mail::Box::Locker

$obj->folder( [$folder] )

Inherited, see "Attributes" in Mail::Box::Locker

$obj->logSettings()

Inherited, see "Attributes" in Mail::Reporter

$obj->name()

Inherited, see "Attributes" in Mail::Box::Locker

$obj->timeout( [SECONDS] )

Inherited, see "Attributes" in Mail::Box::Locker

$obj->unlock()

Inherited, see "Locking" in Mail::Box::Locker

Locking

Extends "Locking" in Mail::Box::Locker.

$obj->hasLock()

Inherited, see "Locking" in Mail::Box::Locker

$obj->isLocked()

Inherited, see "Locking" in Mail::Box::Locker

$obj->lock()

Inherited, see "Locking" in Mail::Box::Locker

Error handling

Extends "Error handling" in Mail::Box::Locker.

$obj->AUTOLOAD()

Inherited, see "Error handling" in Mail::Reporter

$obj->addReport($object)

Inherited, see "Error handling" in Mail::Reporter

$any->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )

Inherited, see "Error handling" in Mail::Reporter

$obj->errors()

Inherited, see "Error handling" in Mail::Reporter

$any->log( [$level, [$strings]] )

Inherited, see "Error handling" in Mail::Reporter

$any->logPriority($level)

Inherited, see "Error handling" in Mail::Reporter

$obj->notImplemented()

Inherited, see "Error handling" in Mail::Reporter

$obj->report( [$level] )

Inherited, see "Error handling" in Mail::Reporter

$obj->reportAll( [$level] )

Inherited, see "Error handling" in Mail::Reporter

$obj->trace( [$level] )

Inherited, see "Error handling" in Mail::Reporter

$obj->warnings()

Inherited, see "Error handling" in Mail::Reporter

Cleanup

Extends "Cleanup" in Mail::Box::Locker.

$obj->DESTROY()

Inherited, see "Cleanup" in Mail::Box::Locker

DIAGNOSTICS

Warning: Couldn't remove mutt-unlock $folder: $!

Cast by unlock()

Error: Failed to remove expired mutt-lock $lockfile: $!

Cast by lock()

Warning: Folder $folder already mutt-locked

Cast by lock()

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. Cast by notImplemented()

Warning: Removed expired mutt-lock $lockfile

Cast by lock()

SEE ALSO

This module is part of Mail-Box version 3.012, built on November 27, 2025. Website: http://perl.overmeer.net/CPAN/

LICENSE

For contributors see file ChangeLog.

This software is copyright (c) 2001-2025 by Mark Overmeer.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

cpanm Mail::Box

perl -MCPAN -e shell
install Mail::Box