Mail::Filter(3pm)

Usage

 use Mail::Filter;
    
 my $filter = Mail::Filter->new( \&filter1, \&filter2 );
    
 my $mail   = Mail::Internet->new( [<>] );
 my $mail   = $filter->filter($mail);
 my $folder = Mail::Folder->new( .... );
 my $filter->filter($folder);

Overview

"Mail::Filter" provides an interface to filtering Email through multiple subroutines.

"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 filtered.

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.

Methods

Constructors

Mail::Filter->new(@filters): Create a new "Mail::Filter" 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(@filters): Add the given @filters to the end of the filter list.

Processing

$obj->filter($mail|$folder): If the first argument is a Mail::Internet object, then this object will be passed through the filter list. If the first argument is a Mail::Folder object, then each message in turn will be passed through the filter list.

$obj->folder(): 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.

$obj->msgnum(): 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.

Releases

16 releases since Debian 2.0 (Hamm); the text changed 13 times.