NAME

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

VERSION

0.17

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 ],
    ...
);

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 Mail::SpamAssassin. 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 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>