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
27       Extends "DESCRIPTION" in Mail::Reporter.
28

METHODS

30       Extends "METHODS" in Mail::Reporter.
31
32   Constructors
33       Extends "Constructors" in Mail::Reporter.
34
35       Mail::Box::MH::Labels->new(%options)
36            -Option  --Defined in     --Default
37             filename                   <required>
38             log       Mail::Reporter   'WARNINGS'
39             trace     Mail::Reporter   'WARNINGS'
40
41           filename => FILENAME
42             The FILENAME which is used in each directory to store the headers
43             of all mails. The filename must be an absolute path.
44
45           log => LEVEL
46           trace => LEVEL
47
48   The Label Table
49       $obj->append($messages)
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           Returns the name of the index file.
56
57       $obj->get($msgnr)
58           Look if there is label info for message $msgnr.
59
60       $obj->print($fh, $messages)
61           Print the labels of the specified messages to the opened file.
62
63       $obj->read()
64           Read all label information from file.
65
66       $obj->write($messages)
67           Write the labels related to the specified messages to the label
68           file.
69
70   Error handling
71       Extends "Error handling" in Mail::Reporter.
72
73       $obj->AUTOLOAD()
74           Inherited, see "Error handling" in Mail::Reporter
75
76       $obj->addReport($object)
77           Inherited, see "Error handling" in Mail::Reporter
78
79       $obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level,
80       $callback] )
81       Mail::Box::MH::Labels->defaultTrace( [$level]|[$loglevel,
82       $tracelevel]|[$level, $callback] )
83           Inherited, see "Error handling" in Mail::Reporter
84
85       $obj->errors()
86           Inherited, see "Error handling" in Mail::Reporter
87
88       $obj->log( [$level, [$strings]] )
89       Mail::Box::MH::Labels->log( [$level, [$strings]] )
90           Inherited, see "Error handling" in Mail::Reporter
91
92       $obj->logPriority($level)
93       Mail::Box::MH::Labels->logPriority($level)
94           Inherited, see "Error handling" in Mail::Reporter
95
96       $obj->logSettings()
97           Inherited, see "Error handling" in Mail::Reporter
98
99       $obj->notImplemented()
100           Inherited, see "Error handling" in Mail::Reporter
101
102       $obj->report( [$level] )
103           Inherited, see "Error handling" in Mail::Reporter
104
105       $obj->reportAll( [$level] )
106           Inherited, see "Error handling" in Mail::Reporter
107
108       $obj->trace( [$level] )
109           Inherited, see "Error handling" in Mail::Reporter
110
111       $obj->warnings()
112           Inherited, see "Error handling" in Mail::Reporter
113
114   Cleanup
115       Extends "Cleanup" in Mail::Reporter.
116
117       $obj->DESTROY()
118           Inherited, see "Cleanup" in Mail::Reporter
119

DIAGNOSTICS

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

LICENSE

133       Copyrights 2001-2020 by [Mark Overmeer]. For other contributors see
134       ChangeLog.
135
136       This program is free software; you can redistribute it and/or modify it
137       under the same terms as Perl itself.  See http://dev.perl.org/licenses/
138
139
140
141perl v5.34.0                      2021-07-22          Mail::Box::MH::Labels(3)