.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Mail::SpamAssassin::Plugin::Razor2 3"
.TH Mail::SpamAssassin::Plugin::Razor2 3 2024-09-01 "perl v5.40.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Mail::SpamAssassin::Plugin::Razor2 \- perform Razor check of messages
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  loadplugin     Mail::SpamAssassin::Plugin::Razor2
.Ve
.SH DESCRIPTION
.IX Header "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.
.PP
See http://razor.sourceforge.net/ for more information about Razor.
.SH DEPENDENCIES
.IX Header "DEPENDENCIES"
Razor2 requires the \f(CW\*(C`Razor2::Client::Agent\*(C'\fR Perl module to be installed.
.SH "RULE DEFINITIONS"
.IX Header "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.
.PP
The following eval rules are provided by this plugin:
.PP
.Vb 1
\& 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 \*(Aqrazor\-agent.conf(1)\*(Aq.
\&
\& full   RULENAME   eval:check_razor2_range(<engine>,<min>,<max>)
\&
\&    <engine>  Engine number (4, 8 or \*(Aq\*(Aq)
\&    <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.
.Ve
.SH "USER SETTINGS"
.IX Header "USER SETTINGS"
.IP "use_razor2 (0|1)		(default: 1)" 4
.IX Item "use_razor2 (0|1) (default: 1)"
Whether to use Razor2, if it is available.
.SH "ADMINISTRATOR SETTINGS"
.IX Header "ADMINISTRATOR SETTINGS"
.IP "razor_fork (0|1)		(default: 1)" 4
.IX Item "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.
.IP "razor_timeout n		(default: 5)" 4
.IX Item "razor_timeout n (default: 5)"
How many seconds you wait for Razor to complete before you go on without
the results
.IP "razor_config filename" 4
.IX Item "razor_config filename"
Define the filename used to store Razor's configuration settings.
Currently this is left to Razor to decide.