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 con‐
21       suming.
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 pre‐
25       defined, but more can be added without limitation.
26

METHODS

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

DIAGNOSTICS

143       Error: Package $package does not implement $method.
144
145       Fatal error: the specific package (or one of its superclasses) does not
146       implement this method where it should. This message means that some
147       other related classes do implement this method however the class at
148       hand does not.  Probably you should investigate this and probably
149       inform the author of the package.
150

LICENSE

156       Copyrights 2001-2007 by Mark Overmeer.For other contributors see
157       ChangeLog.
158
159       This program is free software; you can redistribute it and/or modify it
160       under the same terms as Perl itself.  See
161       http://www.perl.com/perl/misc/Artistic.html
162
163
164
165perl v5.8.8                       2007-03-25          Mail::Box::MH::Labels(3)