Codex

Mail::Filter

Section: User Contributed Perl Documentation (3pm)

Updated: 2014-01-05

Index?action=index Return to Main Contents


NAME

Mail::Filter - Filter mail through multiple subroutines

SYNOPSIS

DESCRIPTION

provides an interface to filtering Email through multiple subroutines.
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 filtered.
The result from each filter sub is passed to the next filter as the mail object. If a filter subroutine returns undef, then will abort and return immediately.

The function returns the result from the last subroutine to operate on the mail object.

METHODS

Constructors

Mail
:Filter->new([FILTER [, ... ]]):Create a new object with the given filter subroutines. Each filter may be either a code reference or the name of a method to call on the <Mail::Filter> object.:

Accessors

$obj->add(FILTER [, FILTER ...])
Add the given filters to the end of the filter list.:

Processing

$obj->filter(MAIL-OBJECT | MAIL-FOLDER)
If the first argument is a object, then this object will be passed through the filter list. If the first argument is a object, then each message in turn will be passed through the filter list.:
$obj->folder()
While the method is called with a object, these filter subroutines can call this method to obtain the folder object that is being processed.:
$obj->msgnum()
If the method is called with a object, then the filter subroutines may call this method to obtain the message number of the message that is being processed.:

SEE ALSO

This module is part of the MailTools distribution, http://perl.overmeer.net/mailtools/.

AUTHORS

The MailTools bundle was developed by Graham Barr. Later, Mark Overmeer took over maintenance without commitment to further development.

Mail::Cap by Gisle Aas <[email protected]>. Mail::Field::AddrList by Peter Orbaek <[email protected]>. Mail::Mailer and Mail::Send by Tim Bunce <[email protected]>. For other contributors see ChangeLog.

LICENSE

Copyrights 1995-2000 Graham Barr <[email protected]> and 2001-2007 Mark Overmeer <[email protected]>.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See http://www.perl.com/perl/misc/Artistic.html


Index

NAME

SYNOPSIS

DESCRIPTION

METHODS

Constructors

Accessors

Processing

SEE ALSO

AUTHORS

LICENSE