1Mail::Box::Locker::MuttU(s3e)r Contributed Perl DocumentaMtaiioln::Box::Locker::Mutt(3)
2
3
4

NAME

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

INHERITANCE

9        Mail::Box::Locker::Mutt
10          is a Mail::Box::Locker
11          is a Mail::Reporter
12

SYNOPSIS

14        See Mail::Box::Locker
15

DESCRIPTION

17       The "mutt" mail reader includes an separate program which is
18       specialized in locking folders.  This locker class uses this external
19       program.  Mutt is not automatically installed.
20

METHODS

22   Constructors
23       Mail::Box::Locker::Mutt->new(OPTIONS)
24            -Option --Defined in     --Default
25             exe                       mutt_dotlock
26             expires  Mail::Box::Locker  1 hour
27             file     Mail::Box::Locker  undef
28             folder   Mail::Box::Locker  <undef>
29             log      Mail::Reporter   'WARNINGS'
30             method   Mail::Box::Locker  'DOTLOCK'
31             timeout  Mail::Box::Locker  10 seconds
32             trace    Mail::Reporter   'WARNINGS'
33
34           exe => PATH
35             The name of the program.  May be a relative or absolute path.
36
37           expires => SECONDS
38           file => FILENAME
39           folder => FOLDER
40           log => LEVEL
41           method => STRING|CLASS|ARRAY
42           timeout => SECONDS|'NOTIMEOUT'
43           trace => LEVEL
44
45   The Locker
46       $obj->filename([FILENAME])
47           See "The Locker" in Mail::Box::Locker
48
49       $obj->folder([FOLDER])
50           See "The Locker" in Mail::Box::Locker
51
52       $obj->name
53           See "The Locker" in Mail::Box::Locker
54
55   Locking
56       $obj->hasLock
57           See "Locking" in Mail::Box::Locker
58
59       $obj->isLocked
60           See "Locking" in Mail::Box::Locker
61
62       $obj->lock
63       $obj->unlock
64
65   Error handling
66       $obj->AUTOLOAD
67           See "Error handling" in Mail::Reporter
68
69       $obj->addReport(OBJECT)
70           See "Error handling" in Mail::Reporter
71
72       $obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
73           Mail::Box::Locker::Mutt->defaultTrace([LEVEL]|[LOGLEVEL,
74           TRACELEVEL]|[LEVEL, CALLBACK])
75
76           See "Error handling" in Mail::Reporter
77
78       $obj->errors
79           See "Error handling" in Mail::Reporter
80
81       $obj->log([LEVEL [,STRINGS]])
82           Mail::Box::Locker::Mutt->log([LEVEL [,STRINGS]])
83
84           See "Error handling" in Mail::Reporter
85
86       $obj->logPriority(LEVEL)
87           Mail::Box::Locker::Mutt->logPriority(LEVEL)
88
89           See "Error handling" in Mail::Reporter
90
91       $obj->logSettings
92           See "Error handling" in Mail::Reporter
93
94       $obj->notImplemented
95           See "Error handling" in Mail::Reporter
96
97       $obj->report([LEVEL])
98           See "Error handling" in Mail::Reporter
99
100       $obj->reportAll([LEVEL])
101           See "Error handling" in Mail::Reporter
102
103       $obj->trace([LEVEL])
104           See "Error handling" in Mail::Reporter
105
106       $obj->warnings
107           See "Error handling" in Mail::Reporter
108
109   Cleanup
110       $obj->DESTROY
111           See "Cleanup" in Mail::Box::Locker
112
113       $obj->inGlobalDestruction
114           See "Cleanup" in Mail::Reporter
115
116       $obj->exe
117           Returns the name of the external binary.
118

DIAGNOSTICS

120       Warning: Couldn't remove mutt-unlock $folder: $!
121       Error: Failed to remove expired mutt-lock $lockfile: $!
122       Warning: Folder $folder already mutt-locked
123       Error: Package $package does not implement $method.
124           Fatal error: the specific package (or one of its superclasses) does
125           not implement this method where it should. This message means that
126           some other related classes do implement this method however the
127           class at hand does not.  Probably you should investigate this and
128           probably inform the author of the package.
129
130       Warning: Removed expired mutt-lock $lockfile
131

SEE ALSO

133       This module is part of Mail-Box distribution version 2.097, built on
134       January 26, 2011. Website: http://perl.overmeer.net/mailbox/
135

LICENSE

137       Copyrights 2001-2011 by Mark Overmeer. For other contributors see
138       ChangeLog.
139
140       This program is free software; you can redistribute it and/or modify it
141       under the same terms as Perl itself.  See
142       http://www.perl.com/perl/misc/Artistic.html
143
144
145
146perl v5.12.3                      2011-01-26        Mail::Box::Locker::Mutt(3)