Mail::Box::Locker::Mutt(3pm)

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 special‐
18       ized in locking folders.  This locker class uses this external program.
19       Mutt is not automatically installed.
20

METHODS

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

DIAGNOSTICS

154       Warning: Couldn't remove mutt-unlock $folder: $!
155
156       Error: Failed to remove expired mutt-lock $lockfile: $!
157
158       Warning: Folder $folder already mutt-locked
159
160       Error: Package $package does not implement $method.
161
162       Fatal error: the specific package (or one of its superclasses) does not
163       implement this method where it should. This message means that some
164       other related classes do implement this method however the class at
165       hand does not.  Probably you should investigate this and probably
166       inform the author of the package.
167
168       Warning: Removed expired mutt-lock $lockfile
169

LICENSE

175       Copyrights 2001-2007 by Mark Overmeer.For other contributors see
176       ChangeLog.
177
178       This program is free software; you can redistribute it and/or modify it
179       under the same terms as Perl itself.  See
180       http://www.perl.com/perl/misc/Artistic.html
181
182
183
184perl v5.8.8                       2007-03-25        Mail::Box::Locker::Mutt(3)