Mail::Message::Head::ListGroup(3pm)

1Mail::Message::Head::LiUssteGrroCuopn(t3r)ibuted Perl DoMcauimle:n:tMaetsisoange::Head::ListGroup(3)
2
3
4

NAME

6       Mail::Message::Head::ListGroup - mailinglist related header fields
7

INHERITANCE

9        Mail::Message::Head::ListGroup
10          is a Mail::Message::Head::FieldGroup
11          is a Mail::Reporter
12

SYNOPSIS

14        my $lg = Mail::Message::Head::ListGroup->new(head => $head, ...);
15        $head->addListGroup($lg);
16
17        my $lg = $head->addListGroup(...);
18
19        $lg->delete;
20

DESCRIPTION

22       A list group is a set of header fields which are added by mailing-list
23       managing software.  This class knowns various details about that
24       software.
25
26       The knowledge and test messages which are used to initially implement
27       this module is taken from Mail::ListDetector, written by Michael
28       Stevens <mailto:michael@etla.org>.  The logic is redesigned to add
29       flexibility and use the powerful MailBox features.
30

METHODS

32   Constructors
33       $obj->address
34           Returns a Mail::Message::Field::Address object (or "undef") which
35           defines the posting address of the mailing list.
36
37       $obj->clone
38           See "Constructors" in Mail::Message::Head::FieldGroup
39
40       $obj->from(HEAD|MESSAGE)
41           Create a "Mail::Message::Head::ListGroup" based in the specified
42           MESSAGE or message HEAD.
43
44       $obj->implementedTypes
45           Mail::Message::Head::ListGroup->implementedTypes
46
47           See "Constructors" in Mail::Message::Head::FieldGroup
48
49       $obj->listname
50           Returns the name of the mailing list, which is usually a part of
51           the e-mail address which is used to post the messages to.
52
53       Mail::Message::Head::ListGroup->new(FIELDS, OPTIONS)
54           Construct an object which maintains one set of mailing list headers
55
56            -Option  --Defined in     --Default
57             address                    undef
58             head      Mail::Message::Head::FieldGroup  undef
59             listname                   <derived from address>
60             log       Mail::Reporter   'WARNINGS'
61             rfc                        undef
62             software  Mail::Message::Head::FieldGroup  undef
63             trace     Mail::Reporter   'WARNINGS'
64             type      Mail::Message::Head::FieldGroup  undef
65             version   Mail::Message::Head::FieldGroup  undef
66
67           address => STRING|OBJECT
68             Address of the mailing list, which may be specified as STRING or
69             e-mail containing object (a Mail::Address or Mail::Identity.  In
70             any case, the data is converted into a Mail::Identity.
71
72           head => HEAD
73           listname => STRING
74             A short textual representation of the mailing-list.
75
76           log => LEVEL
77           rfc => 'rfc2919'|'rfc2369'
78             Defines the mailing list software follows an rfc.
79
80           software => STRING
81           trace => LEVEL
82           type => STRING
83           version => STRING
84       $obj->rfc
85           When the mailing list software follows the guidelines of one of the
86           dedicated RFCs, then this will be returned otherwise "undef".  The
87           return values can be "rfc2919", "rfc2369", or "undef".
88
89   The header
90       $obj->add((FIELD, VALUE) | OBJECT)
91           See "The header" in Mail::Message::Head::FieldGroup
92
93       $obj->addFields([FIELDNAMES])
94           See "The header" in Mail::Message::Head::FieldGroup
95
96       $obj->attach(HEAD)
97           See "The header" in Mail::Message::Head::FieldGroup
98
99       $obj->delete
100           See "The header" in Mail::Message::Head::FieldGroup
101
102       $obj->fieldNames
103           See "The header" in Mail::Message::Head::FieldGroup
104
105       $obj->fields
106           See "The header" in Mail::Message::Head::FieldGroup
107
108       $obj->head
109           See "The header" in Mail::Message::Head::FieldGroup
110
111   Access to the header
112       $obj->isListGroupFieldName(NAME)
113           Mail::Message::Head::ListGroup->isListGroupFieldName(NAME)
114
115       $obj->software
116           See "Access to the header" in Mail::Message::Head::FieldGroup
117
118       $obj->type
119           See "Access to the header" in Mail::Message::Head::FieldGroup
120
121       $obj->version
122           See "Access to the header" in Mail::Message::Head::FieldGroup
123
124   Internals
125       $obj->collectFields
126           Scan the header for fields which are usually contained in mailing
127           list software.  This method is automatically called when a list
128           group is constructed from() an existing header or message.
129
130           Returned are the names of the list header fields found, in scalar
131           context the amount.  An empty list/zero indicates that this is not
132           a mailing list message.
133
134           Please warn the author of MailBox if you see that to few or too
135           many fields are included.
136
137       $obj->detected(TYPE, SOFTWARE, VERSION)
138           See "Internals" in Mail::Message::Head::FieldGroup
139
140   Error handling
141       $obj->AUTOLOAD
142           See "Error handling" in Mail::Reporter
143
144       $obj->addReport(OBJECT)
145           See "Error handling" in Mail::Reporter
146
147       $obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
148           Mail::Message::Head::ListGroup->defaultTrace([LEVEL]|[LOGLEVEL,
149           TRACELEVEL]|[LEVEL, CALLBACK])
150
151           See "Error handling" in Mail::Reporter
152
153       $obj->details
154           Produce information about the detected/create list group, which may
155           be helpful during debugging, by default to the selected file
156           handle.
157
158       $obj->errors
159           See "Error handling" in Mail::Reporter
160
161       $obj->log([LEVEL [,STRINGS]])
162           Mail::Message::Head::ListGroup->log([LEVEL [,STRINGS]])
163
164           See "Error handling" in Mail::Reporter
165
166       $obj->logPriority(LEVEL)
167           Mail::Message::Head::ListGroup->logPriority(LEVEL)
168
169           See "Error handling" in Mail::Reporter
170
171       $obj->logSettings
172           See "Error handling" in Mail::Reporter
173
174       $obj->notImplemented
175           See "Error handling" in Mail::Reporter
176
177       $obj->print([FILEHANDLE])
178           See "Error handling" in Mail::Message::Head::FieldGroup
179
180       $obj->report([LEVEL])
181           See "Error handling" in Mail::Reporter
182
183       $obj->reportAll([LEVEL])
184           See "Error handling" in Mail::Reporter
185
186       $obj->trace([LEVEL])
187           See "Error handling" in Mail::Reporter
188
189       $obj->warnings
190           See "Error handling" in Mail::Reporter
191
192   Cleanup
193       $obj->DESTROY
194           See "Cleanup" in Mail::Reporter
195
196       $obj->inGlobalDestruction
197           See "Cleanup" in Mail::Reporter
198

DETAILS

200   Mailing list fields
201       Detected lists
202
203       The Mail::Message::Head::ListGroup class can detect many different
204       mailing lists, some of which are very popular and some of which are
205       rare.
206
207       Numerous fields in a header are addded when the message is passed
208       through a mailing list server.  Each list software has defined its own
209       fields, sometimes woth conflicting definitions.  There are also two
210       RFCs about mailing list: "rfc2919" and "rfc2369".
211
212       The following lists are currently detected.  Between parenthesis is the
213       string returned by type() when that differs from the software name.
214
215       ·   CommuniGate
216
217           Legacy commercial MacOS implementation by Stalker Software Inc.
218           <http://www.stalker.com/mac/default.html>
219
220       ·   CommuniGate Pro (CommuniGatePro)
221
222           Commercial rfc2919 compliant implementation by Stalker Software
223           Inc.  <http://www.stalker.com>
224
225       ·   Ecartis
226
227           Commercial mailing list manager, formerly known as Listar. Produced
228           by NodeRunner Computing.  See <http://www.ecartis.com>.
229
230       ·   Ezmlm
231
232           Open Source mailing list manager, available from
233           <http://www.ezmlm.org>.
234
235       ·   FML
236
237           Open Source mailing list manager, see <http://www.fml.org>.
238
239       ·   Listar
240
241           Old name for Ecartis.
242
243       ·   Listbox
244
245           Mailing lists defined at <http://listbox.com>.
246
247       ·   Mailman
248
249           GNU's mailing list manager, available from <http://www.list.org>.
250
251       ·   Majordomo
252
253           Free (licenced) mailing list manager by Great Circle Associates,
254           available from <http://www.greatcircle.com/majordomo/>
255
256       ·   Smartlist
257
258           Related to procmail, as expressed by their shared main page at
259           <http://www.procmail.org/>.
260
261       ·   Yahoo! Groups (YahooGroups)
262
263           Mailing lists defined at <http://groups.yahoo.com>.
264
265       ·   Listserv
266
267           Commercial mailing list manager, produced by L-Soft. See
268           <http://www.lsoft.com/>.
269

DIAGNOSTICS

271       Error: Cannot convert "$string" into an address object
272           The new(address) is coerced into a Mail::Message::Field::Address,
273           which fails.  Have a look at
274           Mail::Message::Field::Address::coerce() to see what valid arguments
275           are.
276
277       Error: Package $package does not implement $method.
278           Fatal error: the specific package (or one of its superclasses) does
279           not implement this method where it should. This message means that
280           some other related classes do implement this method however the
281           class at hand does not.  Probably you should investigate this and
282           probably inform the author of the package.
283

LICENSE

289       Copyrights 2001-2011 by Mark Overmeer. For other contributors see
290       ChangeLog.
291
292       This program is free software; you can redistribute it and/or modify it
293       under the same terms as Perl itself.  See
294       http://www.perl.com/perl/misc/Artistic.html
295
296
297
298perl v5.12.3                      2011-01-26 Mail::Message::Head::ListGroup(3)