NAME

Mail::SpamAssassin::Plugin::Razor2 - perform Razor check of messages

SYNOPSIS

  loadplugin     Mail::SpamAssassin::Plugin::Razor2

DESCRIPTION

Vipul's Razor is a distributed, collaborative, spam detection and filtering network based on user submissions of spam. Detection is done with signatures that efficiently spot mutating spam content and user input is validated through reputation assignments.

See http://razor.sourceforge.net/ for more information about Razor.

DEPENDENCIES

Razor2 requires the "Razor2::Client::Agent" Perl module to be installed.

RULE DEFINITIONS

Razor2 calculates a signature for each part of a multipart message and then compares those signatures to a database of known spam signatures. The server returns a confidence value (0-100) for each part of the message. The part with the highest confidence value is used as the confidence value for the message.

The following eval rules are provided by this plugin:

 full   RULENAME   eval:check_razor2()
    Returns true if the confidence value of the message is greater than or equal to `min_cf` as defined in
    the Razor2 configuration file 'razor-agent.conf(1)'.
 full   RULENAME   eval:check_razor2_range(<engine>,<min>,<max>)
    <engine>  Engine number (4, 8 or '')
    <min>     Minimum confidence value (0-100)
    <max>     Maximum confidence value (0-100)
    Returns true if the spam confidence value for the message is greater than or equal to <min> and
    less than or equal to <max>. If <engine> is not specified, the engine with the highest
    confidence value is used.

USER SETTINGS

use_razor2 (0|1) (default: 1)

Whether to use Razor2, if it is available.

ADMINISTRATOR SETTINGS

razor_fork (0|1) (default: 1)

Instead of running Razor2 synchronously, fork separate process for it and read the results in later (similar to async DNS lookups). Increases throughput. Considered experimental on Windows, where default is 0.

razor_timeout n (default: 5)

How many seconds you wait for Razor to complete before you go on without the results

razor_config filename

Define the filename used to store Razor's configuration settings. Currently this is left to Razor to decide.