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

DETAILS

251       Mailing list fields
252
253       Detected lists
254
255       The Mail::Message::Head::ListGroup class can detect many different
256       mailing lists, some of which are very popular and some of which are
257       rare.
258
259       Numerous fields in a header are addded when the message is passed
260       through a mailing list server.  Each list software has defined its own
261       fields, sometimes woth conflicting definitions.  There are also two
262       RFCs about mailing list: "rfc2919" and "rfc2369".
263
264       The following lists are currently detected.  Between parenthesis is the
265       string returned by type() when that differs from the software name.
266
267       * CommuniGate
268           Legacy commercial MacOS implementation by Stalker Software Inc.
269           <http://www.stalker.com/mac/default.html>
270
271       * CommuniGate Pro (CommuniGatePro)
272           Commercial rfc2919 compliant implementation by Stalker Software
273           Inc.  <http://www.stalker.com>
274
275       * Ecartis
276           Commercial mailing list manager, formerly known as Listar. Produced
277           by NodeRunner Computing.  See <http://www.ecartis.com>.
278
279       * Ezmlm
280           Open Source mailing list manager, available from
281           <http://www.ezmlm.org>.
282
283       * FML
284           Open Source mailing list manager, see <http://www.fml.org>.
285
286       * Listar
287           Old name for Ecartis.
288
289       * Listbox
290           Mailing lists defined at <http://listbox.com>.
291
292       * Mailman
293           GNU's mailing list manager, available from <http://www.list.org>.
294
295       * Majordomo
296           Free (licenced) mailing list manager by Great Circle Associates,
297           available from <http://www.greatcircle.com/majordomo/>
298
299       * Smartlist
300           Related to procmail, as expressed by their shared main page at
301           <http://www.procmail.org/>.
302
303       * Yahoo! Groups (YahooGroups)
304           Mailing lists defined at <http://groups.yahoo.com>.
305
306       * Listserv
307           Commercial mailing list manager, produced by L-Soft. See
308           <http://www.lsoft.com/>.
309

DIAGNOSTICS

311       Error: Cannot convert "$string" into an address object
312
313       The new(address) is coerced into a Mail::Message::Field::Address, which
314       fails.  Have a look at Mail::Message::Field::Address::coerce() to see
315       what valid arguments are.
316
317       Error: Package $package does not implement $method.
318
319       Fatal error: the specific package (or one of its superclasses) does not
320       implement this method where it should. This message means that some
321       other related classes do implement this method however the class at
322       hand does not.  Probably you should investigate this and probably
323       inform the author of the package.
324

LICENSE

330       Copyrights 2001-2007 by Mark Overmeer.For other contributors see
331       ChangeLog.
332
333       This program is free software; you can redistribute it and/or modify it
334       under the same terms as Perl itself.  See
335       http://www.perl.com/perl/misc/Artistic.html
336
337
338
339perl v5.8.8                       2007-03-25 Mail::Message::Head::ListGroup(3)