/usr/share/perl5/Mail/Message/Head/ListGroup.pod is in libmail-box-perl 2.110-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 | =encoding utf8
=head1 NAME
Mail::Message::Head::ListGroup - mailinglist related header fields
=head1 INHERITANCE
Mail::Message::Head::ListGroup
is a Mail::Message::Head::FieldGroup
is a Mail::Reporter
=head1 SYNOPSIS
my $lg = Mail::Message::Head::ListGroup->new(head => $head, ...);
$head->addListGroup($lg);
my $lg = $head->addListGroup(...);
$lg->delete;
=head1 DESCRIPTION
A I<list group> is a set of header fields which are added by mailing-list
managing software. This class knowns various details about that software.
The knowledge and test messages which are used to initially implement
this module is taken from Mail::ListDetector, written by
Michael Stevens <mailto:michael@etla.org>. The logic is redesigned to
add flexibility and use the powerful MailBox features.
See L<documentation in the base class|Mail::Message::Head::FieldGroup/"DESCRIPTION">.
=head1 METHODS
See L<documentation in the base class|Mail::Message::Head::FieldGroup/"METHODS">.
=head2 Constructors
See L<documentation in the base class|Mail::Message::Head::FieldGroup/"Constructors">.
=over 4
=item $obj-E<gt>B<address>()
Returns a L<Mail::Message::Field::Address|Mail::Message::Field::Address> object (or C<undef>) which
defines the posting address of the mailing list.
=item $obj-E<gt>B<clone>()
See L<Mail::Message::Head::FieldGroup/"Constructors">
=item $obj-E<gt>B<from>(HEAD|MESSAGE)
Create a C<Mail::Message::Head::ListGroup> based in the specified MESSAGE
or message HEAD.
=item $obj-E<gt>B<implementedTypes>()
=item Mail::Message::Head::ListGroup-E<gt>B<implementedTypes>()
See L<Mail::Message::Head::FieldGroup/"Constructors">
=item $obj-E<gt>B<listname>()
Returns the name of the mailing list, which is usually a part of the
e-mail address which is used to post the messages to.
=item Mail::Message::Head::ListGroup-E<gt>B<new>(FIELDS, OPTIONS)
Construct an object which maintains one set of mailing list headers
-Option --Defined in --Default
address undef
head Mail::Message::Head::FieldGroup undef
listname <derived from address>
log Mail::Reporter 'WARNINGS'
rfc undef
software Mail::Message::Head::FieldGroup undef
trace Mail::Reporter 'WARNINGS'
type Mail::Message::Head::FieldGroup undef
version Mail::Message::Head::FieldGroup undef
=over 2
=item address => STRING|OBJECT
Address of the mailing list, which may be specified as STRING
or e-mail containing object (a L<Mail::Address|Mail::Address> or L<Mail::Identity|Mail::Identity>.
In any case, the data is converted into a L<Mail::Identity|Mail::Identity>.
=item head => HEAD
=item listname => STRING
A short textual representation of the mailing-list.
=item log => LEVEL
=item rfc => 'rfc2919'|'rfc2369'
Defines the mailing list software follows an rfc.
=item software => STRING
=item trace => LEVEL
=item type => STRING
=item version => STRING
=back
=item $obj-E<gt>B<rfc>()
When the mailing list software follows the guidelines of one of the dedicated
RFCs, then this will be returned otherwise C<undef>. The return values can
be C<rfc2919>, C<rfc2369>, or C<undef>.
=back
=head2 The header
See L<documentation in the base class|Mail::Message::Head::FieldGroup/"The header">.
=over 4
=item $obj-E<gt>B<add>((FIELD, VALUE) | OBJECT)
See L<Mail::Message::Head::FieldGroup/"The header">
=item $obj-E<gt>B<addFields>([FIELDNAMES])
See L<Mail::Message::Head::FieldGroup/"The header">
=item $obj-E<gt>B<attach>(HEAD)
See L<Mail::Message::Head::FieldGroup/"The header">
=item $obj-E<gt>B<delete>()
See L<Mail::Message::Head::FieldGroup/"The header">
=item $obj-E<gt>B<fieldNames>()
See L<Mail::Message::Head::FieldGroup/"The header">
=item $obj-E<gt>B<fields>()
See L<Mail::Message::Head::FieldGroup/"The header">
=item $obj-E<gt>B<head>()
See L<Mail::Message::Head::FieldGroup/"The header">
=back
=head2 Access to the header
See L<documentation in the base class|Mail::Message::Head::FieldGroup/"Access to the header">.
=over 4
=item $obj-E<gt>B<isListGroupFieldName>(NAME)
=item Mail::Message::Head::ListGroup-E<gt>B<isListGroupFieldName>(NAME)
=item $obj-E<gt>B<software>()
See L<Mail::Message::Head::FieldGroup/"Access to the header">
=item $obj-E<gt>B<type>()
See L<Mail::Message::Head::FieldGroup/"Access to the header">
=item $obj-E<gt>B<version>()
See L<Mail::Message::Head::FieldGroup/"Access to the header">
=back
=head2 Internals
See L<documentation in the base class|Mail::Message::Head::FieldGroup/"Internals">.
=over 4
=item $obj-E<gt>B<collectFields>()
Scan the header for fields which are usually contained in mailing list
software. This method is automatically called when a list group is
constructed L<from()|Mail::Message::Head::ListGroup/"Constructors"> an existing header or message.
Returned are the names of the list header fields found, in scalar
context the amount. An empty list/zero indicates that this is not
a mailing list message.
Please warn the author of MailBox if you see that to few
or too many fields are included.
=item $obj-E<gt>B<detected>(TYPE, SOFTWARE, VERSION)
See L<Mail::Message::Head::FieldGroup/"Internals">
=back
=head2 Error handling
See L<documentation in the base class|Mail::Message::Head::FieldGroup/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<addReport>(OBJECT)
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
=item Mail::Message::Head::ListGroup-E<gt>B<defaultTrace>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<details>()
Produce information about the detected/create list group, which may be
helpful during debugging, by default to the selected file handle.
=item $obj-E<gt>B<errors>()
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<log>([LEVEL [,STRINGS]])
=item Mail::Message::Head::ListGroup-E<gt>B<log>([LEVEL [,STRINGS]])
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logPriority>(LEVEL)
=item Mail::Message::Head::ListGroup-E<gt>B<logPriority>(LEVEL)
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<print>([FILEHANDLE])
See L<Mail::Message::Head::FieldGroup/"Error handling">
=item $obj-E<gt>B<report>([LEVEL])
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<reportAll>([LEVEL])
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<trace>([LEVEL])
See L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
See L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
See L<documentation in the base class|Mail::Message::Head::FieldGroup/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
See L<Mail::Reporter/"Cleanup">
=back
=head1 DETAILS
=head2 Mailing list fields
=head3 Detected lists
The L<Mail::Message::Head::ListGroup|Mail::Message::Head::ListGroup> class can detect many different
mailing lists, some of which are very popular and some of which are
rare.
Numerous fields in a header are addded when the message is passed
through a mailing list server. Each list software has defined its own
fields, sometimes woth conflicting definitions. There are also two
RFCs about mailing list: C<rfc2919> and C<rfc2369>.
The following lists are currently detected. Between parenthesis is
the string returned by L<type()|Mail::Message::Head::FieldGroup/"Access to the header"> when that differs from the software
name.
=over 4
=item * CommuniGate
Legacy commercial MacOS implementation by Stalker Software Inc.
L<http://www.stalker.com/mac/default.html>
=item * CommuniGate Pro (CommuniGatePro)
Commercial rfc2919 compliant implementation by Stalker Software Inc.
L<http://www.stalker.com>
=item * Ecartis
Commercial mailing list manager, formerly known as Listar. Produced
by NodeRunner Computing. See L<http://www.ecartis.com>.
=item * Ezmlm
Open Source mailing list manager, available from L<http://www.ezmlm.org>.
=item * FML
Open Source mailing list manager, see L<http://www.fml.org>.
=item * Listar
Old name for Ecartis.
=item * Listbox
Mailing lists defined at L<http://listbox.com>.
=item * Mailman
GNU's mailing list manager, available from L<http://www.list.org>.
=item * Majordomo
Free (licenced) mailing list manager by Great Circle Associates,
available from L<http://www.greatcircle.com/majordomo/>
=item * Smartlist
Related to procmail, as expressed by their shared main page at
L<http://www.procmail.org/>.
=item * Yahoo! Groups (YahooGroups)
Mailing lists defined at L<http://groups.yahoo.com>.
=item * Listserv
Commercial mailing list manager, produced by L-Soft. See
L<http://www.lsoft.com/>.
=back
=head1 DIAGNOSTICS
=over 4
=item Error: Cannot convert "$string" into an address object
The L<new(address)|Mail::Message::Head::ListGroup/"Constructors"> is coerced into a L<Mail::Message::Field::Address|Mail::Message::Field::Address>,
which fails. Have a look at L<Mail::Message::Field::Address::coerce()|Mail::Message::Field::Address/"Constructors">
to see what valid arguments are.
=item Error: Package $package does not implement $method.
Fatal error: the specific package (or one of its superclasses) does not
implement this method where it should. This message means that some other
related classes do implement this method however the class at hand does
not. Probably you should investigate this and probably inform the author
of the package.
=back
=head1 SEE ALSO
This module is part of Mail-Box distribution version 2.110,
built on January 05, 2014. Website: F<http://perl.overmeer.net/mailbox/>
=head1 LICENSE
Copyrights 2001-2014 by [Mark Overmeer]. For other contributors see ChangeLog.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
See F<http://www.perl.com/perl/misc/Artistic.html>
|