.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{ . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Mail::Box::Locker::Mutt 3pm" .TH Mail::Box::Locker::Mutt 3pm "2014-08-24" "perl v5.20.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Mail::Box::Locker::Mutt \- lock a folder using mutt_dotlock .SH "INHERITANCE" .IX Header "INHERITANCE" .Vb 3 \& Mail::Box::Locker::Mutt \& is a Mail::Box::Locker \& is a Mail::Reporter .Ve .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& See Mail::Box::Locker .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" The \f(CW\*(C`mutt\*(C'\fR mail reader includes an separate program which is specialized in locking folders. This locker class uses this external program. Mutt is not automatically installed. .PP Extends \*(L"\s-1DESCRIPTION\*(R"\s0 in Mail::Box::Locker. .SH "METHODS" .IX Header "METHODS" Extends \*(L"\s-1METHODS\*(R"\s0 in Mail::Box::Locker. .ie n .IP "$obj\->\fBexe\fR()" 4 .el .IP "\f(CW$obj\fR\->\fBexe\fR()" 4 .IX Item "$obj->exe()" Returns the name of the external binary. .SS "Constructors" .IX Subsection "Constructors" Extends \*(L"Constructors\*(R" in Mail::Box::Locker. .IP "Mail::Box::Locker::Mutt\->\fBnew\fR(%options)" 4 .IX Item "Mail::Box::Locker::Mutt->new(%options)" .Vb 9 \& \-Option \-\-Defined in \-\-Default \& exe mutt_dotlock \& expires Mail::Box::Locker 1 hour \& file Mail::Box::Locker undef \& folder Mail::Box::Locker \& log Mail::Reporter \*(AqWARNINGS\*(Aq \& method Mail::Box::Locker \*(AqDOTLOCK\*(Aq \& timeout Mail::Box::Locker 10 seconds \& trace Mail::Reporter \*(AqWARNINGS\*(Aq .Ve .RS 4 .IP "exe => \s-1PATH\s0" 2 .IX Item "exe => PATH" The name of the program. May be a relative or absolute path. .IP "expires => \s-1SECONDS\s0" 2 .IX Item "expires => SECONDS" .PD 0 .IP "file => \s-1FILENAME\s0" 2 .IX Item "file => FILENAME" .IP "folder => \s-1FOLDER\s0" 2 .IX Item "folder => FOLDER" .IP "log => \s-1LEVEL\s0" 2 .IX Item "log => LEVEL" .IP "method => STRING|CLASS|ARRAY" 2 .IX Item "method => STRING|CLASS|ARRAY" .IP "timeout => SECONDS|'\s-1NOTIMEOUT\s0'" 2 .IX Item "timeout => SECONDS|'NOTIMEOUT'" .IP "trace => \s-1LEVEL\s0" 2 .IX Item "trace => LEVEL" .RE .RS 4 .RE .PD .SS "The Locker" .IX Subsection "The Locker" Extends \*(L"The Locker\*(R" in Mail::Box::Locker. .ie n .IP "$obj\->\fBfilename\fR( [$filename] )" 4 .el .IP "\f(CW$obj\fR\->\fBfilename\fR( [$filename] )" 4 .IX Item "$obj->filename( [$filename] )" Inherited, see \*(L"The Locker\*(R" in Mail::Box::Locker .ie n .IP "$obj\->\fBfolder\fR( [$folder] )" 4 .el .IP "\f(CW$obj\fR\->\fBfolder\fR( [$folder] )" 4 .IX Item "$obj->folder( [$folder] )" Inherited, see \*(L"The Locker\*(R" in Mail::Box::Locker .ie n .IP "$obj\->\fBname\fR()" 4 .el .IP "\f(CW$obj\fR\->\fBname\fR()" 4 .IX Item "$obj->name()" Inherited, see \*(L"The Locker\*(R" in Mail::Box::Locker .SS "Locking" .IX Subsection "Locking" Extends \*(L"Locking\*(R" in Mail::Box::Locker. .ie n .IP "$obj\->\fBhasLock\fR()" 4 .el .IP "\f(CW$obj\fR\->\fBhasLock\fR()" 4 .IX Item "$obj->hasLock()" Inherited, see \*(L"Locking\*(R" in Mail::Box::Locker .ie n .IP "$obj\->\fBisLocked\fR()" 4 .el .IP "\f(CW$obj\fR\->\fBisLocked\fR()" 4 .IX Item "$obj->isLocked()" Inherited, see \*(L"Locking\*(R" in Mail::Box::Locker .ie n .IP "$obj\->\fBlock\fR()" 4 .el .IP "\f(CW$obj\fR\->\fBlock\fR()" 4 .IX Item "$obj->lock()" .PD 0 .ie n .IP "$obj\->\fBunlock\fR()" 4 .el .IP "\f(CW$obj\fR\->\fBunlock\fR()" 4 .IX Item "$obj->unlock()" .PD .SS "Error handling" .IX Subsection "Error handling" Extends \*(L"Error handling\*(R" in Mail::Box::Locker. .ie n .IP "$obj\->\fB\s-1AUTOLOAD\s0\fR()" 4 .el .IP "\f(CW$obj\fR\->\fB\s-1AUTOLOAD\s0\fR()" 4 .IX Item "$obj->AUTOLOAD()" Inherited, see \*(L"Error handling\*(R" in Mail::Reporter .ie n .IP "$obj\->\fBaddReport\fR($object)" 4 .el .IP "\f(CW$obj\fR\->\fBaddReport\fR($object)" 4 .IX Item "$obj->addReport($object)" Inherited, see \*(L"Error handling\*(R" in Mail::Reporter .ie n .IP "$obj\->\fBdefaultTrace\fR( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )" 4 .el .IP "\f(CW$obj\fR\->\fBdefaultTrace\fR( [$level]|[$loglevel, \f(CW$tracelevel\fR]|[$level, \f(CW$callback\fR] )" 4 .IX Item "$obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )" .PD 0 .ie n .IP "Mail::Box::Locker::Mutt\->\fBdefaultTrace\fR( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )" 4 .el .IP "Mail::Box::Locker::Mutt\->\fBdefaultTrace\fR( [$level]|[$loglevel, \f(CW$tracelevel\fR]|[$level, \f(CW$callback\fR] )" 4 .IX Item "Mail::Box::Locker::Mutt->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )" .PD Inherited, see \*(L"Error handling\*(R" in Mail::Reporter .ie n .IP "$obj\->\fBerrors\fR()" 4 .el .IP "\f(CW$obj\fR\->\fBerrors\fR()" 4 .IX Item "$obj->errors()" Inherited, see \*(L"Error handling\*(R" in Mail::Reporter .ie n .IP "$obj\->\fBlog\fR( [$level, [$strings]] )" 4 .el .IP "\f(CW$obj\fR\->\fBlog\fR( [$level, [$strings]] )" 4 .IX Item "$obj->log( [$level, [$strings]] )" .PD 0 .IP "Mail::Box::Locker::Mutt\->\fBlog\fR( [$level, [$strings]] )" 4 .IX Item "Mail::Box::Locker::Mutt->log( [$level, [$strings]] )" .PD Inherited, see \*(L"Error handling\*(R" in Mail::Reporter .ie n .IP "$obj\->\fBlogPriority\fR($level)" 4 .el .IP "\f(CW$obj\fR\->\fBlogPriority\fR($level)" 4 .IX Item "$obj->logPriority($level)" .PD 0 .IP "Mail::Box::Locker::Mutt\->\fBlogPriority\fR($level)" 4 .IX Item "Mail::Box::Locker::Mutt->logPriority($level)" .PD Inherited, see \*(L"Error handling\*(R" in Mail::Reporter .ie n .IP "$obj\->\fBlogSettings\fR()" 4 .el .IP "\f(CW$obj\fR\->\fBlogSettings\fR()" 4 .IX Item "$obj->logSettings()" Inherited, see \*(L"Error handling\*(R" in Mail::Reporter .ie n .IP "$obj\->\fBnotImplemented\fR()" 4 .el .IP "\f(CW$obj\fR\->\fBnotImplemented\fR()" 4 .IX Item "$obj->notImplemented()" Inherited, see \*(L"Error handling\*(R" in Mail::Reporter .ie n .IP "$obj\->\fBreport\fR( [$level] )" 4 .el .IP "\f(CW$obj\fR\->\fBreport\fR( [$level] )" 4 .IX Item "$obj->report( [$level] )" Inherited, see \*(L"Error handling\*(R" in Mail::Reporter .ie n .IP "$obj\->\fBreportAll\fR( [$level] )" 4 .el .IP "\f(CW$obj\fR\->\fBreportAll\fR( [$level] )" 4 .IX Item "$obj->reportAll( [$level] )" Inherited, see \*(L"Error handling\*(R" in Mail::Reporter .ie n .IP "$obj\->\fBtrace\fR( [$level] )" 4 .el .IP "\f(CW$obj\fR\->\fBtrace\fR( [$level] )" 4 .IX Item "$obj->trace( [$level] )" Inherited, see \*(L"Error handling\*(R" in Mail::Reporter .ie n .IP "$obj\->\fBwarnings\fR()" 4 .el .IP "\f(CW$obj\fR\->\fBwarnings\fR()" 4 .IX Item "$obj->warnings()" Inherited, see \*(L"Error handling\*(R" in Mail::Reporter .SS "Cleanup" .IX Subsection "Cleanup" Extends \*(L"Cleanup\*(R" in Mail::Box::Locker. .ie n .IP "$obj\->\fB\s-1DESTROY\s0\fR()" 4 .el .IP "\f(CW$obj\fR\->\fB\s-1DESTROY\s0\fR()" 4 .IX Item "$obj->DESTROY()" Inherited, see \*(L"Cleanup\*(R" in Mail::Box::Locker .SH "DIAGNOSTICS" .IX Header "DIAGNOSTICS" .ie n .IP "Warning: Couldn't remove mutt-unlock $folder: $!" 4 .el .IP "Warning: Couldn't remove mutt-unlock \f(CW$folder:\fR $!" 4 .IX Item "Warning: Couldn't remove mutt-unlock $folder: $!" .PD 0 .ie n .IP "Error: Failed to remove expired mutt-lock $lockfile: $!" 4 .el .IP "Error: Failed to remove expired mutt-lock \f(CW$lockfile:\fR $!" 4 .IX Item "Error: Failed to remove expired mutt-lock $lockfile: $!" .ie n .IP "Warning: Folder $folder already mutt-locked" 4 .el .IP "Warning: Folder \f(CW$folder\fR already mutt-locked" 4 .IX Item "Warning: Folder $folder already mutt-locked" .ie n .IP "Error: Package $package does not implement $method." 4 .el .IP "Error: Package \f(CW$package\fR does not implement \f(CW$method\fR." 4 .IX Item "Error: Package $package does not implement $method." .PD 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. .ie n .IP "Warning: Removed expired mutt-lock $lockfile" 4 .el .IP "Warning: Removed expired mutt-lock \f(CW$lockfile\fR" 4 .IX Item "Warning: Removed expired mutt-lock $lockfile" .SH "SEE ALSO" .IX Header "SEE ALSO" This module is part of Mail-Box distribution version 2.117, built on August 24, 2014. Website: \fIhttp://perl.overmeer.net/mailbox/\fR .SH "LICENSE" .IX Header "LICENSE" Copyrights 2001\-2014 by [Mark Overmeer]. For other contributors see ChangeLog. .PP This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See \fIhttp://www.perl.com/perl/misc/Artistic.html\fR