Mail::...r::Mutt(3pm)

🎀 Mail::Box::Locker::Mutt — the manual page, but make it make sense

okay bestie so this is Mail::Box::Locker::Mutt(3pm), one of those User Contributed Perl Documentation pages, and it's genuinely so much less scary than it looks. it's a locker class. it locks folders. that's it, that's the girl. 💅

---

💖 NAME

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

like literally that's the whole vibe. a folder locker that outsources the actual locking to mutt's little helper program. ✨

🌈 INHERITANCE

 Mail::Box::Locker::Mutt
   is a Mail::Box::Locker
   is a Mail::Reporter

so she's a Mail::Box::Locker, and a Mail::Box::Locker is a Mail::Reporter. generational talent, honestly. 👑

🦋 SYNOPSIS

 See Mail::Box::Locker

that's it. that's the synopsis. go read your other manpage, babe, everything's inherited. 😭

💜 DESCRIPTION

so the mutt email reader ships with a whole separate program that does exactly one thing and does it well: locking folders. this locker class just calls that external program. no cap.

important!! Mutt is not automatically installed. you have to go get it yourself, bestie. it is not showing up as a surprise dependency. 🙈

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

here's the whole option menu, defaults and all, don't @ me:

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

and now the deep dives on each one:

• exe => PATH — the name of the program. can be a relative path or an absolute path, your call, main character. 🌟
• expires => $seconds — inherited from Mail::Box::Locker, default 1 hour
• file => $file — inherited from Mail::Box::Locker, default undef
• folder => $folder — inherited from Mail::Box::Locker, default <C<undef>>
• method => $name|CLASS|\@names — inherited from Mail::Box::Locker, default 'DOTLOCK'
• timeout => $seconds|'NOTIMEOUT' — inherited from Mail::Box::Locker, default 10

🎀 Attributes

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

• $obj->exe() — hands you back the name of the external binary. that's the whole job. iconic. 💅
• $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->name() — inherited, see "Attributes" in Mail::Box::Locker
• $obj->timeout( [SECONDS] ) — inherited, see "Attributes" 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
• $obj->unlock() — 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->notImplemented() — inherited, see "Error handling" in Mail::Reporter

🍓 Cleanup

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

• $obj->DESTROY() — inherited, see "Cleanup" in Mail::Box::Locker

---

⭐ DIAGNOSTICS

all the messages this girl can throw at you, in order, with zero skips:

• Error: class $package does not implement method $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: couldn't remove mutt-unlock $folder: $! Cast by unlock()
• Fault: failed to remove expired mutt-lock $file: $! Cast by lock()
• Warning: folder $name already mutt-locked with $file. Cast by lock()
• Fault: folder $name will never get a mutt-lock with $file: $! Cast by lock()
• Warning: removed expired mutt-lock file $file. Cast by lock()

---

💀 SEE ALSO

This module is part of Mail-Box version 4.02, built on April 10, 2026.

Website: http://perl.overmeer.net/CPAN/

👑 LICENSE

For contributors see file ChangeLog.

This software is copyright (c) 2001-2026 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.

---

and that's the whole page bestie, slay, go lock a folder responsibly 🦋💖

so like, tiny sign-off: this was rendered for perl v5.40.1 and dated 2026-05-09, and the page itself is Mail::...r::Mutt(3pm) — you're welcome, mwah 🎀✨