Mail::Box::MH::Labels(3pm)

1Mail::Box::MH::Labels(3U)ser Contributed Perl DocumentatiMoanil::Box::MH::Labels(3)
2
3
4

NAME

6       Mail::Box::MH::Labels - maintain MH message related labels
7

INHERITANCE

9        Mail::Box::MH::Labels
10          is a Mail::Reporter
11

SYNOPSIS

13        my $labels = Mail::Box::MH::Labels->new;
14        $labels->read(...)
15        $labels->write(...)
16

DESCRIPTION

18       MH type message folders use one dedicated file per folder-directory to
19       list special tags to messages in that folder.  By doing this, mail
20       agents may avoid parsing all the messages, which is very resource
21       consuming.
22
23       Labels can be used to group messages, for instance to reflect which
24       messages have been read or which look like spam.  Some labels are
25       predefined, but more can be added without limitation.
26

METHODS

28   Constructors
29       Mail::Box::MH::Labels->new(OPTIONS)
30            -Option  --Defined in     --Default
31             filename                   <required>
32             log       Mail::Reporter   'WARNINGS'
33             trace     Mail::Reporter   'WARNINGS'
34
35           filename => FILENAME
36             The FILENAME which is used in each directory to store the headers
37             of all mails. The filename must be an absolute path.
38
39           log => LEVEL
40           trace => LEVEL
41
42   The Label Table
43       $obj->append(MESSAGES)
44           Append the label information about the specified MESSAGES to the
45           end of the label file.  The information will not be merged with the
46           information already present in the label file.
47
48       $obj->filename
49           Returns the name of the index file.
50
51       $obj->get(MSGNR)
52           Look if there is label info for message MSGNR.
53
54       $obj->print(FILEHANDLE, MESSAGES)
55           Print the labels of the specified messages to the opened file.
56
57       $obj->read
58           Read all label information from file.
59
60       $obj->write(MESSAGES)
61           Write the labels related to the specified messages to the label
62           file.
63
64   Error handling
65       $obj->AUTOLOAD
66           See "Error handling" in Mail::Reporter
67
68       $obj->addReport(OBJECT)
69           See "Error handling" in Mail::Reporter
70
71       $obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
72           Mail::Box::MH::Labels->defaultTrace([LEVEL]|[LOGLEVEL,
73           TRACELEVEL]|[LEVEL, CALLBACK])
74
75           See "Error handling" in Mail::Reporter
76
77       $obj->errors
78           See "Error handling" in Mail::Reporter
79
80       $obj->log([LEVEL [,STRINGS]])
81           Mail::Box::MH::Labels->log([LEVEL [,STRINGS]])
82
83           See "Error handling" in Mail::Reporter
84
85       $obj->logPriority(LEVEL)
86           Mail::Box::MH::Labels->logPriority(LEVEL)
87
88           See "Error handling" in Mail::Reporter
89
90       $obj->logSettings
91           See "Error handling" in Mail::Reporter
92
93       $obj->notImplemented
94           See "Error handling" in Mail::Reporter
95
96       $obj->report([LEVEL])
97           See "Error handling" in Mail::Reporter
98
99       $obj->reportAll([LEVEL])
100           See "Error handling" in Mail::Reporter
101
102       $obj->trace([LEVEL])
103           See "Error handling" in Mail::Reporter
104
105       $obj->warnings
106           See "Error handling" in Mail::Reporter
107
108   Cleanup
109       $obj->DESTROY
110           See "Cleanup" in Mail::Reporter
111
112       $obj->inGlobalDestruction
113           See "Cleanup" in Mail::Reporter
114

DIAGNOSTICS

116       Error: Package $package does not implement $method.
117           Fatal error: the specific package (or one of its superclasses) does
118           not implement this method where it should. This message means that
119           some other related classes do implement this method however the
120           class at hand does not.  Probably you should investigate this and
121           probably inform the author of the package.
122

LICENSE

128       Copyrights 2001-2011 by Mark Overmeer. For other contributors see
129       ChangeLog.
130
131       This program is free software; you can redistribute it and/or modify it
132       under the same terms as Perl itself.  See
133       http://www.perl.com/perl/misc/Artistic.html
134
135
136
137perl v5.12.3                      2011-01-26          Mail::Box::MH::Labels(3)