.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Mail::ListDetector 3pm"
.TH Mail::ListDetector 3pm "2022-11-29" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Mail::ListDetector \- Perl extension for detecting mailing list messages
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Mail::ListDetector;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module analyzes mail objects in any of the classes handled by
Email::Abstract. It returns a Mail::ListDetector::List object
representing the mailing list.
.PP
The \s-1RFC2369\s0 mailing list detector is also capable of matching some
Mailman and Ezmlm messages. It is deliberately checked last to allow
the more specific Mailman and Ezmlm parsing to happen first, and more
accurately identify the type of mailing list involved.
.SH "METHODS"
.IX Header "METHODS"
.SS "new"
.IX Subsection "new"
This method is the core of the module. Pass it a mail object, it will
either return a Mail::ListDetector::List object that describes the
mailing list that the message was posted to, or \f(CW\*(C`undef\*(C'\fR if it appears
not to have been a mailing list post.
.SS "register_plugin($plugin_name)"
.IX Subsection "register_plugin($plugin_name)"
Registers a new plugin module that might recognise lists. Should
be a subclass of Mail::ListDetector::Detector::Base, and provide
the same interface as the other detector modules.
.PP
You can eval arbitrary perl code with this, so don't do that if that's
not what you want.
.SH "EMAILS USED"
.IX Header "EMAILS USED"
This module includes a number of sample emails from various mailing
lists. In all cases, mails are used with permission of the author, and
must not be distributed separately from this archive. If you believe
I may have accidentally used your email or content without permission,
contact me, and if this turns out to be the case I will immediately remove
it from the latest version of the archive.
.SH "BUGS"
.IX Header "BUGS"
.IP "\(bu" 4
A lot of the code applies fairly simple regular expressions to email
address to extract information. This may fall over for really weird
email addresses, but I'm hoping no-one will use those for names of
mailing lists.
.IP "\(bu" 4
The majordomo and smartlist recognisers don't have much to go on,
and therefore are probably not as reliable as the other detectors.
This is liable to be hard to fix.
.IP "\(bu" 4
Forwarding messages (for example using procmail) can sometimes break
the \f(CW\*(C`Sender: \*(C'\fR header information needed to recognise some list
types.
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "\(bu" 4
Michael Stevens \- michael@etla.org.
.IP "\(bu" 4
Andy Turner \- turner@mikomi.org.
.IP "\(bu" 4
Adam Lazur \- adam@lazur.org.
.IP "\(bu" 4
Peter Oliver \- p.d.oliver@mavit.freeserve.co.uk
.IP "\(bu" 4
Matthew Walker \- matthew@walker.wattle.id.au
.IP "\(bu" 4
Tatsuhiko Miyagawa \- miyagawa@bulknews.net
.IP "\(bu" 4
johnnnnnn \- john@phaedrusdeinus.org
.IP "\(bu" 4
Mik Firestone \- mik@racerx.homedns.org
.IP "\(bu" 4
Simon Cozens \- simon@simon\-cozens.org
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBperl\fR\|(1). The Mail::Audit::List module, which is a convenient way of using
Mail::Audit and Mail::ListDetector together.