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
31       Extends "DESCRIPTION" in Mail::Message::Head::FieldGroup.
32

METHODS

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

DETAILS

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

DIAGNOSTICS

283       Error: Cannot convert "$string" into an address object
284           The new(address) is coerced into a Mail::Message::Field::Address,
285           which fails.  Have a look at
286           Mail::Message::Field::Address::coerce() to see what valid arguments
287           are.
288
289       Error: Package $package does not implement $method.
290           Fatal error: the specific package (or one of its superclasses) does
291           not implement this method where it should. This message means that
292           some other related classes do implement this method however the
293           class at hand does not.  Probably you should investigate this and
294           probably inform the author of the package.
295

LICENSE

301       Copyrights 2001-2022 by [Mark Overmeer <markov@cpan.org>]. For other
302       contributors see ChangeLog.
303
304       This program is free software; you can redistribute it and/or modify it
305       under the same terms as Perl itself.  See http://dev.perl.org/licenses/
306
307
308
309perl v5.36.0                      2023-01-20 Mail::Message::Head::ListGroup(3)