Mail::Filter(3pm) User Contributed Perl Documentation Mail::Filter(3pm)
Mail::Filter - Filter mail through multiple subroutines
my $filter = Mail::Filter->new( \&filter1, \&filter2 );
my $mail = Mail::Internet->new( [<>] );
my $mail = $filter->filter($mail);
my $folder = Mail::Folder->new( .... );
"Mail::Filter" provides an interface to filtering Email through multi-
"Mail::Filter" filters mail by calling each filter subroutine in turn.
Each filter subroutine is called with two arguments, the first is the
filter object and the second is the mail or folder object being fil-
The result from each filter sub is passed to the next filter as the
mail object. If a filter subroutine returns undef, then "Mail::Filter"
will abort and return immediately.
The function returns the result from the last subroutine to operate on
the mail object.
Mail::Filter->new([FILTER [, ... ]])
Create a new "Mail::Filter" object with the given filter subrou-
tines. Each filter may be either a code reference or the name of a
method to call on the <Mail::Filter> object.
$obj->add(FILTER [, FILTER ...])
Add the given filters to the end of the fliter list.
$obj->filter(MAIL-OBJECT | MAIL-FOLDER)
If the first argument is a "Mail::Internet" object, then this
object will be passed through the filter list. If the first argu-
ment is a "Mail::Folder" object, then each message in turn will be
passed through the filter list.
While the "filter" method is called with a "Mail::Folder" object,
these filter subroutines can call this method to obtain the folder
object that is being processed.
If the "filter" method is called with a "Mail::Folder" object, then
the filter subroutines may call this method to obtain the message
number of the message that is being processed.
This module is part of the MailTools distribution, http://perl.over-
The MailTools bundle was developed by Graham Barr. Later, Mark Over-
meer took over maintenance without development.
Mail::Cap by Gisle Aas <aasAToslonett.no>. Mail::Field::AddrList by
Peter Orbaek <poeATcit.dk>. Mail::Mailer and Mail::Send by Tim Bunce
<Tim.BunceATig.uk>. For other contributors see ChangeLog.
Copyrights 1995-2000 Graham Barr <gbarrATpobox.com> and 2001-2007 Mark
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself. See
perl v5.8.8 2008-04-14 Mail::Filter(3pm)