Code Index:

package Mail::Audit::List
package Mail::Audit
- list_accept
__END__
EOF

NAME

Mail::Audit::List - Mail::Audit plugin for automatic list delivery

SYNOPSIS

    use Mail::Audit qw(List);
    my $mail = Mail::Audit->new;
    ...
    $mail->list_accept || $mail->accept;

DESCRIPTION

This is a Mail::Audit plugin which provides a method for automatically delivering mailing lists to a suitable mainbox. It requires the CPAN Mail::ListDetector module.

METHODS

list_accept($delivery_dir, \%arg)

Attempts to deliver the message as a mailing list. It will place each message in $deliver_dir/$list_name. The default value of $deliver_dir is $ENV{HOME} . "/mail".

For instance, mail to perl5-porters@perl.org will end up by default in /home/you/mail/perl5-porters.

Calls accept and returns the filename delivered to if Mail::ListDetector can identify this mail as coming from a mailing list, or 0 otherwise.

Valid named arguments are:

  munge_name - a coderef called to munge the name given by Mail::ListDetector

Note that if you want to use the defailt delivery location, but also to pass args, you must call the method like this:

  $audit->list_accept(undef, { ... });

The recipe given above should be able to replace a great number of special-casing recipes.

AUTHOR

Michael Stevens <michael@etla.org>