Mail::Filter man page on BSDi

Man page or keyword search:  
man Server   6284 pages
apropos Keyword Search (all sections)
Output format
BSDi logo
[printable version]



Mail::Filter(3)User Contributed Perl DocumentationMail::Filter(3)

NAME
       Mail::Filter - Filter mail through multiple subroutines

SYNOPSIS
	   use Mail::Filter;

	   $filter = new Mail::Filter( \&filter1, \&filter2 );

	   $mail = new Mail::Internet( [<>] );
	   $mail = $filter->filter($mail);

	   $folder = new Mail::Folder( .... );
	   $filter->filter($folder);

DESCRIPTION
       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 fist is the filter object and the
       second is the mail 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.

CONSTRUCTOR
       new ( [ FILTER [, ... ]])
	   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.

METHODS
       add ( FILTER [, FILTER ...] )
	   Add the given filters to the end of the fliter list.

       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 argument is a Mail::Folder object, then each
	   message in turn will be passed through the filter
	   list.

       folder
	   If the filter method is called with a Mail::Folder
	   object, then the filter subroutines may call this
	   method to obtain the folder object that is being
	   processed.

16/Feb/1998	       perl 5.005, patch 03			1

Mail::Filter(3)User Contributed Perl DocumentationMail::Filter(3)

       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.

SEE ALSO
       the Mail::Internet manpage the Mail::Folder manpage

AUTHOR
       Graham Barr <gbarr@pobox.com>

COPYRIGHT
       Copyright (c) 1997 Graham Barr. All rights reserved. This
       program is free software; you can redistribute it and/or
       modify it under the same terms as Perl itself.

16/Feb/1998	       perl 5.005, patch 03			2

[top]

List of man pages available for BSDi

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net