NAME

Courier::Filter::Module::SpamAssassin - A SpamAssassin message filter module for the Courier::Filter framework

Back to Top

VERSION

0.17

Back to Top

SYNOPSIS

    use Courier::Filter::Module::SpamAssassin;

    my $module = Courier::Filter::Module::SpamAssassin->new(
        sa_options  => {
            # Mail::SpamAssassin options, e.g.:
            site_rules_filename => '/etc/spamassassin/courier-filter.cf'
        },
        
        logger      => $logger,
        inverse     => 0,
        trusting    => 0,
        testing     => 0,
        debugging   => 0
    );

    my $filter = Courier::Filter->new(
        ...
        modules     => [ $module ],
        ...
    );

Back to Top

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:

sa_options

A hashref specifying options for the Mail::SpamAssassin manpage. For example, a Courier::Filer-specific rules file could be specified as the site_rules_filename option, as shown in the SYNOPSIS.

All options of the Courier::Filter::Module constructor are also supported. Please see new in the Courier::Filter::Module manpage for their descriptions.

Instance methods

See Instance methods in the Courier::Filter::Module manpage for a description of the provided instance methods.

Back to Top

SEE ALSO

the Courier::Filter::Module manpage, the Courier::Filter::Overview manpage.

For AVAILABILITY, SUPPORT, COPYRIGHT, and LICENSE information, see the Courier::Filter::Overview manpage.

Back to Top

AUTHOR

Julian Mehnle <julian@mehnle.net>

Back to Top