table of contents
Courier::Filter::Module::SpamAssassin(3pm) | User Contributed Perl Documentation | Courier::Filter::Module::SpamAssassin(3pm) |
NAME¶
Courier::Filter::Module::SpamAssassin - SpamAssassin message filter module for the Courier::Filter framework
SYNOPSIS¶
use Courier::Filter::Module::SpamAssassin; my $module = Courier::Filter::Module::SpamAssassin->new( prefs_file => '/etc/courier/filters/courier-filter-spamassassin.cf', sa_options => { # any Mail::SpamAssassin options }, logger => $logger, inverse => 0, trusting => 0, testing => 0, debugging => 0 ); my $filter = Courier::Filter->new( ... modules => [ $module ], ... );
DESCRIPTION¶
This class is a filter module class for use with Courier::Filter. It matches a message if its SpamAssassin spam score exceeds the configured threshold.
Constructor¶
The following constructor is provided:
- new(%options): returns Courier::Filter::Module::SpamAssassin
- Creates a new SpamAssassin filter module.
%options is a list of key/value pairs representing any of the following options:
- prefs_file
- The path of a SpamAssassin preferences file. If this option is specified, its value is passed to the Mail::SpamAssassin constructor's "userprefs_filename" option . If undef, SpamAssassin is instructed not to read any preferences besides its default configuration files. Defaults to undef.
- sa_options
- A hash-ref specifying options for the Mail::SpamAssassin object used by this filter module. See "new" in Mail::SpamAssassin for the supported options.
All options of the Courier::Filter::Module constructor are also supported. Please see "new" in Courier::Filter::Module for their descriptions.
Instance methods¶
See "Instance methods" in Courier::Filter::Module for a description of the provided instance methods.
SEE ALSO¶
Courier::Filter::Module, Courier::Filter::Overview.
For AVAILABILITY, SUPPORT, COPYRIGHT, and LICENSE information, see Courier::Filter::Overview.
AUTHOR¶
Julian Mehnle <julian@mehnle.net>
2022-10-21 | perl v5.34.0 |