<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Mail::SpamAssassin::Conf - SpamAssassin configuration file</title>
<link rev="made" href="mailto:root@localhost" />
</head>
<body style="background-color: white">
<p><a name="__index__"></a></p>
<!-- INDEX BEGIN -->
<ul>
<li><a href="#name">NAME</a></li>
<li><a href="#synopsis">SYNOPSIS</a></li>
<li><a href="#description">DESCRIPTION</a></li>
<li><a href="#user_preferences">USER PREFERENCES</a></li>
<li><a href="#settings">SETTINGS</a></li>
<li><a href="#privileged_settings">PRIVILEGED SETTINGS</a></li>
<li><a href="#locali[sz]ation">LOCALI[SZ]ATION</a></li>
<li><a href="#see_also">SEE ALSO</a></li>
</ul>
<!-- INDEX END -->
<hr />
<p>
</p>
<h1><a name="name">NAME</a></h1>
<p>Mail::SpamAssassin::Conf - SpamAssassin configuration file</p>
<p>
</p>
<hr />
<h1><a name="synopsis">SYNOPSIS</a></h1>
<pre>
# a comment</pre>
<pre>
rewrite_subject 1</pre>
<pre>
full PARA_A_2_C_OF_1618 /Paragraph .a.{0,10}2.{0,10}C. of S. 1618/i
describe PARA_A_2_C_OF_1618 Claims compliance with senate bill 1618</pre>
<pre>
header FROM_HAS_MIXED_NUMS From =~ /\d+[a-z]+\d+\S*@/i
describe FROM_HAS_MIXED_NUMS From: contains numbers mixed in with letters</pre>
<pre>
score A_HREF_TO_REMOVE 2.0</pre>
<pre>
lang es describe FROM_FORGED_HOTMAIL Forzado From: simula ser de hotmail.com</pre>
<p>
</p>
<hr />
<h1><a name="description">DESCRIPTION</a></h1>
<p>SpamAssassin is configured using some traditional UNIX-style configuration
files, loaded from the /usr/share/spamassassin and /etc/mail/spamassassin
directories.</p>
<p>The <code>#</code> character starts a comment, which continues until end of line.</p>
<p>Whitespace in the files is not significant, but please note that starting a
line with whitespace is deprecated, as we reserve its use for multi-line rule
definitions, at some point in the future.</p>
<p>Paths can use <code>~</code> to refer to the user's home directory.</p>
<p>Where appropriate, default values are listed in parentheses.</p>
<p>
</p>
<hr />
<h1><a name="user_preferences">USER PREFERENCES</a></h1>
<dl>
<dt><strong><a name="item_require_version_n%2enn">require_version n.nn</a></strong><br />
</dt>
<dd>
Indicates that the entire file, from this line on, requires a certain version
of SpamAssassin to run. If an older or newer version of SpamAssassin tries to
read configuration from this file, it will output a warning instead, and
ignore it.
</dd>
<p></p>
<dt><strong><a name="item_version_tag_string">version_tag string</a></strong><br />
</dt>
<dd>
This tag is appended to the SA version in the X-Spam-Status header. You should
include it when modify your ruleset, especially if you plan to distribute it.
A good choice for <em>string</em> is your last name or your initials followed by a
number which you increase with each change.
</dd>
<dd>
<p>e.g.</p>
</dd>
<dd>
<pre>
version_tag myrules1 # version=2.41-myrules1</pre>
</dd>
<p></p>
<dt><strong><a name="item_whitelist_from_add%40ress%2ecom">whitelist_from <a href="mailto:add@ress.com">add@ress.com</a></a></strong><br />
</dt>
<dd>
Used to specify addresses which send mail that is often tagged (incorrectly) as
spam; it also helps if they are addresses of big companies with lots of
lawyers. This way, if spammers impersonate them, they'll get into big trouble,
so it doesn't provide a shortcut around SpamAssassin.
</dd>
<dd>
<p>Whitelist and blacklist addresses are now file-glob-style patterns, so
<code>friend@somewhere.com</code>, <code>*@isp.com</code>, or <code>*.domain.net</code> will all work.
Regular expressions are not used for security reasons.</p>
</dd>
<dd>
<p>Multiple addresses per line, separated by spaces, is OK. Multiple <code>whitelist_from</code> lines is also
OK.</p>
</dd>
<dd>
<p>e.g.</p>
</dd>
<dd>
<pre>
whitelist_from joe@example.com fred@example.com
whitelist_from simon@example.com</pre>
</dd>
<p></p>
<dt><strong><a name="item_whitelist_from_rcvd_lists%2esourceforge%2enet_sour">whitelist_from_rcvd lists.sourceforge.net sourceforge.net</a></strong><br />
</dt>
<dd>
Use this to supplement the whitelist_from addresses with a check against the
Received headers. The first parameter is the address to whitelist, and the
second is a domain to match in the received headers.
</dd>
<dd>
<p>e.g.</p>
</dd>
<dd>
<pre>
whitelist_from_rcvd joe@example.com example.com
whitelist_from_rcvd axkit.org sergeant.org</pre>
</dd>
<p></p>
<dt><strong><a name="item_unwhitelist_from_add%40ress%2ecom">unwhitelist_from <a href="mailto:add@ress.com">add@ress.com</a></a></strong><br />
</dt>
<dd>
Used to override a default whitelist_from entry, so for example a distribution whitelist_from
can be overriden in a local.cf file, or an individual user can override a whitelist_from entry
in their own <code>user_prefs</code> file.
</dd>
<dd>
<p>e.g.</p>
</dd>
<dd>
<pre>
unwhitelist_from joe@example.com fred@example.com
unwhitelist_from *@amazon.com</pre>
</dd>
<p></p>
<dt><strong><a name="item_blacklist_from_add%40ress%2ecom">blacklist_from <a href="mailto:add@ress.com">add@ress.com</a></a></strong><br />
</dt>
<dd>
Used to specify addresses which send mail that is often tagged (incorrectly) as
non-spam, but which the user doesn't want. Same format as <code>whitelist_from</code>.
</dd>
<p></p>
<dt><strong><a name="item_unblacklist_from_add%40ress%2ecom">unblacklist_from <a href="mailto:add@ress.com">add@ress.com</a></a></strong><br />
</dt>
<dd>
Used to override a default blacklist_from entry, so for example a distribution blacklist_from
can be overriden in a local.cf file, or an individual user can override a blacklist_from entry
in their own <code>user_prefs</code> file.
</dd>
<dd>
<p>e.g.</p>
</dd>
<dd>
<pre>
unblacklist_from joe@example.com fred@example.com
unblacklist_from *@spammer.com</pre>
</dd>
<p></p>
<dt><strong><a name="item_whitelist_to_add%40ress%2ecom">whitelist_to <a href="mailto:add@ress.com">add@ress.com</a></a></strong><br />
</dt>
<dd>
If the given address appears in the <code>To:</code> or <code>Cc:</code> headers, mail will be
whitelisted. Useful if you're deploying SpamAssassin system-wide, and don't
want some users to have their mail filtered. Same format as <code>whitelist_from</code>.
</dd>
<dd>
<p>There are three levels of To-whitelisting, <code>whitelist_to</code>, <code>more_spam_to</code>
and <code>all_spam_to</code>. Users in the first level may still get some spammish
mails blocked, but users in <code>all_spam_to</code> should never get mail blocked.</p>
</dd>
<p></p>
<dt><strong><a name="item_more_spam_to_add%40ress%2ecom">more_spam_to <a href="mailto:add@ress.com">add@ress.com</a></a></strong><br />
</dt>
<dd>
See above.
</dd>
<p></p>
<dt><strong><a name="item_all_spam_to_add%40ress%2ecom">all_spam_to <a href="mailto:add@ress.com">add@ress.com</a></a></strong><br />
</dt>
<dd>
See above.
</dd>
<p></p>
<dt><strong><a name="item_nn">required_hits n.nn (default: 5)</a></strong><br />
</dt>
<dd>
Set the number of hits required before a mail is considered spam. <code>n.nn</code> can
be an integer or a real number. 5.0 is the default setting, and is quite
aggressive; it would be suitable for a single-user setup, but if you're an ISP
installing SpamAssassin, you should probably set the default to be something
much more conservative, like 8.0 or 10.0. Experience has shown that you
<strong>will</strong> get plenty of user complaints otherwise!
</dd>
<p></p>
<dt><strong><a name="item_score_symbolic_test_name_n%2enn">score SYMBOLIC_TEST_NAME n.nn</a></strong><br />
</dt>
<dd>
Assign a score to a given test. Scores can be positive or negative real
numbers or integers. <a href="#item_symbolic_test_name"><code>SYMBOLIC_TEST_NAME</code></a> is the symbolic name used by
SpamAssassin as a handle for that test; for example, 'FROM_ENDS_IN_NUMS'.
</dd>
<dd>
<p>Note that test names which begin with '__' are reserved for meta-match
sub-rules, and are not scored or listed in the 'tests hit' reports.</p>
</dd>
<p></p>
<dt><strong><a name="item_detailed_phrase_score_%7b_0_%7c_1_%7d_%28default%3">detailed_phrase_score { 0 | 1 } (default: 0)</a></strong><br />
</dt>
<dd>
This option displays all matches for ``contains phrases frequently found in spam''
Note that this is disabled by default because it can output huge headers (800
words and more than 8KB in some cases)
</dd>
<p></p>
<dt><strong><a name="item_rewrite_subject_%7b_0_%7c_1_%7d_%28default%3a_1%29">rewrite_subject { 0 | 1 } (default: 1)</a></strong><br />
</dt>
<dd>
By default, the subject lines of suspected spam will be tagged. This can be
disabled here.
</dd>
<p></p>
<dt><strong><a name="item_fold_headers_%7b_0_%7c_1_%7d_%28default%3a_1%29">fold_headers { 0 | 1 } (default: 1)</a></strong><br />
</dt>
<dd>
By default, the X-Spam-Status header will be whitespace folded, in other words,
it will be broken up into multiple lines instead of one very long one.
This can be disabled here.
</dd>
<p></p>
<dt><strong><a name="item_spam_level_stars_%7b_0_%7c_1_%7d_%28default%3a_1%2">spam_level_stars { 0 | 1 } (default: 1)</a></strong><br />
</dt>
<dd>
By default, a header field called ``X-Spam-Level'' will be added to the message,
with its value set to a number of asterisks equal to the score of the message.
In other words, for a message scoring 7.2 points:
</dd>
<dd>
<p>X-Spam-Level: *******</p>
</dd>
<dd>
<p>This can be useful for MUA rule creation.</p>
</dd>
<p></p>
<dt><strong><a name="item_x">spam_level_char { x (some character, unquoted) } (default: *)</a></strong><br />
</dt>
<dd>
By default, the ``X-Spam-Level'' header will use a '*' character with its length
equal to the score of the message. Some people don't like escaping *s though,
so you can set the character to anything with this option.
</dd>
<dd>
<p>In other words, for a message scoring 7.2 points with this option set to .</p>
</dd>
<dd>
<p>X-Spam-Level: .......</p>
</dd>
<p></p>
<dt><strong><a name="item_subject_tag_string_%2e%2e%2e_%28default%3a_%2a%2a%">subject_tag STRING ... (default: *****SPAM*****)</a></strong><br />
</dt>
<dd>
Text added to the <code>Subject:</code> line of mails that are considered spam,
if <code>rewrite_subject</code> is 1. _HITS_ in the tag will be replace with the calculated
score for this message. _REQD_ will be replaced with the threshold.
</dd>
<p></p>
<dt><strong><a name="item_report_header_%7b_0_%7c_1_%7d_%28default%3a_0%29">report_header { 0 | 1 } (default: 0)</a></strong><br />
</dt>
<dd>
By default, SpamAssassin will include its report in the body of suspected spam.
Enabling this causes the report to go in the headers instead. Using
'use_terse_report' with this is recommended.
</dd>
<p></p>
<dt><strong><a name="item_use_terse_report_%7b_0_%7c_1_%7d_%28default%3a_0%2">use_terse_report { 0 | 1 } (default: 0)</a></strong><br />
</dt>
<dd>
By default, SpamAssassin uses a fairly long report format. Enabling this uses
a shorter format which includes all the information in the normal one, but
without the superfluous explanations.
</dd>
<p></p>
<dt><strong><a name="item_defang_mime_%7b_0_%7c_1_%7d_%28default%3a_1%29">defang_mime { 0 | 1 } (default: 1)</a></strong><br />
</dt>
<dd>
By default, SpamAssassin will change the Content-type: header of suspected spam
to ``text/plain''. This is a safety feature. If you prefer to leave the
Content-type header alone, set this to 0.
</dd>
<p></p>
<dt><strong><a name="item_dns_available_%7b_yes_%7c_test%5b%3a_name1_name2%2">dns_available { yes | test[: name1 name2...] | no } (default: test)</a></strong><br />
</dt>
<dd>
By default, SpamAssassin will query some default hosts on the internet to
attempt to check if DNS is working on not. The problem is that it can introduce
some delay if your network connection is down, and in some cases it can wrongly
guess that DNS is unavailable because the test connections failed.
SpamAssassin includes a default set of 13 servers, among which 3 are picked
randomly.
</dd>
<dd>
<p>You can however specify your own list by specifying</p>
</dd>
<dd>
<p>dns_available test: server1.tld server2.tld server3.tld</p>
</dd>
<p></p>
<dt><strong><a name="item_skip_rbl_checks_%7b_0_%7c_1_%7d_%28default%3a_0%29">skip_rbl_checks { 0 | 1 } (default: 0)</a></strong><br />
</dt>
<dd>
By default, SpamAssassin will run RBL checks. If your ISP already does this
for you, set this to 1.
</dd>
<p></p>
<dt><strong><a name="item_n">check_mx_attempts n (default: 2)</a></strong><br />
</dt>
<dd>
By default, SpamAssassin checks the From: address for a valid MX this many
times, waiting 5 seconds each time.
</dd>
<p></p>
<dt><strong>check_mx_delay n (default 5)</strong><br />
</dt>
<dd>
How many seconds to wait before retrying an MX check.
</dd>
<p></p>
<dt><strong><a name="item_ok_languages_xx_%5b_yy_zz_%2e%2e%2e_%5d_%28default">ok_languages xx [ yy zz ... ] (default: all)</a></strong><br />
</dt>
<dd>
Which languages are considered OK to receive mail from. Mail using
character sets used by these languages will not be marked as possibly
being spam in an undesired language.
</dd>
<dd>
<p>The following languages are recognized. In your configuration, you must
use the language specifier located in the first column, not the English
name for the language. You may also specify ``all'' if your language is
not listed or if you want to allow any language.</p>
</dd>
<dl>
<dt><strong><a name="item_af_afrikaans">af afrikaans</a></strong><br />
</dt>
<dt><strong><a name="item_am_amharic">am amharic</a></strong><br />
</dt>
<dt><strong><a name="item_ar_arabic">ar arabic</a></strong><br />
</dt>
<dt><strong><a name="item_be_byelorussian">be byelorussian</a></strong><br />
</dt>
<dt><strong><a name="item_bg_bulgarian">bg bulgarian</a></strong><br />
</dt>
<dt><strong><a name="item_bs_bosnian">bs bosnian</a></strong><br />
</dt>
<dt><strong><a name="item_ca_catalan">ca catalan</a></strong><br />
</dt>
<dt><strong><a name="item_cs_czech">cs czech</a></strong><br />
</dt>
<dt><strong><a name="item_cy_welsh">cy welsh</a></strong><br />
</dt>
<dt><strong><a name="item_da_danish">da danish</a></strong><br />
</dt>
<dt><strong><a name="item_de_german">de german</a></strong><br />
</dt>
<dt><strong><a name="item_el_greek">el greek</a></strong><br />
</dt>
<dt><strong><a name="item_en_english">en english</a></strong><br />
</dt>
<dt><strong><a name="item_eo_esperanto">eo esperanto</a></strong><br />
</dt>
<dt><strong><a name="item_es_spanish">es spanish</a></strong><br />
</dt>
<dt><strong><a name="item_et_estonian">et estonian</a></strong><br />
</dt>
<dt><strong><a name="item_eu_basque">eu basque</a></strong><br />
</dt>
<dt><strong><a name="item_fa_persian">fa persian</a></strong><br />
</dt>
<dt><strong><a name="item_fi_finnish">fi finnish</a></strong><br />
</dt>
<dt><strong><a name="item_fr_french">fr french</a></strong><br />
</dt>
<dt><strong><a name="item_fy_frisian">fy frisian</a></strong><br />
</dt>
<dt><strong><a name="item_ga_irish">ga irish</a></strong><br />
</dt>
<dt><strong><a name="item_gd_scots">gd scots</a></strong><br />
</dt>
<dt><strong><a name="item_he_hebrew">he hebrew</a></strong><br />
</dt>
<dt><strong><a name="item_hi_hindi">hi hindi</a></strong><br />
</dt>
<dt><strong><a name="item_hr_croatian">hr croatian</a></strong><br />
</dt>
<dt><strong><a name="item_hu_hungarian">hu hungarian</a></strong><br />
</dt>
<dt><strong><a name="item_hy_armenian">hy armenian</a></strong><br />
</dt>
<dt><strong><a name="item_id_indonesian">id indonesian</a></strong><br />
</dt>
<dt><strong><a name="item_is_icelandic">is icelandic</a></strong><br />
</dt>
<dt><strong><a name="item_it_italian">it italian</a></strong><br />
</dt>
<dt><strong><a name="item_ja_japanese">ja japanese</a></strong><br />
</dt>
<dt><strong><a name="item_ka_georgian">ka georgian</a></strong><br />
</dt>
<dt><strong><a name="item_ko_korean">ko korean</a></strong><br />
</dt>
<dt><strong><a name="item_la_latin">la latin</a></strong><br />
</dt>
<dt><strong><a name="item_lt_lithuanian">lt lithuanian</a></strong><br />
</dt>
<dt><strong><a name="item_lv_latvian">lv latvian</a></strong><br />
</dt>
<dt><strong><a name="item_mr_marathi">mr marathi</a></strong><br />
</dt>
<dt><strong><a name="item_ms_malay">ms malay</a></strong><br />
</dt>
<dt><strong><a name="item_ne_nepali">ne nepali</a></strong><br />
</dt>
<dt><strong><a name="item_nl_dutch">nl dutch</a></strong><br />
</dt>
<dt><strong><a name="item_no_norwegian">no norwegian</a></strong><br />
</dt>
<dt><strong><a name="item_pl_polish">pl polish</a></strong><br />
</dt>
<dt><strong><a name="item_pt_portuguese">pt portuguese</a></strong><br />
</dt>
<dt><strong><a name="item_qu_quechua">qu quechua</a></strong><br />
</dt>
<dt><strong><a name="item_rm_rhaeto%2dromance">rm rhaeto-romance</a></strong><br />
</dt>
<dt><strong><a name="item_ro_romanian">ro romanian</a></strong><br />
</dt>
<dt><strong><a name="item_ru_russian">ru russian</a></strong><br />
</dt>
<dt><strong><a name="item_sa_sanskrit">sa sanskrit</a></strong><br />
</dt>
<dt><strong><a name="item_sco_scots">sco scots</a></strong><br />
</dt>
<dt><strong><a name="item_sk_slovak">sk slovak</a></strong><br />
</dt>
<dt><strong><a name="item_sl_slovenian">sl slovenian</a></strong><br />
</dt>
<dt><strong><a name="item_sq_albanian">sq albanian</a></strong><br />
</dt>
<dt><strong><a name="item_sr_serbian">sr serbian</a></strong><br />
</dt>
<dt><strong><a name="item_sv_swedish">sv swedish</a></strong><br />
</dt>
<dt><strong><a name="item_sw_swahili">sw swahili</a></strong><br />
</dt>
<dt><strong><a name="item_ta_tamil">ta tamil</a></strong><br />
</dt>
<dt><strong><a name="item_th_thai">th thai</a></strong><br />
</dt>
<dt><strong><a name="item_tl_tagalog">tl tagalog</a></strong><br />
</dt>
<dt><strong><a name="item_tr_turkish">tr turkish</a></strong><br />
</dt>
<dt><strong><a name="item_uk_ukrainian">uk ukrainian</a></strong><br />
</dt>
<dt><strong><a name="item_vi_vietnamese">vi vietnamese</a></strong><br />
</dt>
<dt><strong><a name="item_yi_yiddish">yi yiddish</a></strong><br />
</dt>
<dt><strong><a name="item_zh_chinese">zh chinese</a></strong><br />
</dt>
</dl>
<p>Note that the language cannot always be recognized. In that case, no
points will be assigned.</p>
<dt><strong>rbl_timeout n (default 30)</strong><br />
</dt>
<dd>
All RBL queries are started at the beginning and we try to read the results
at the end. In case some of them are hanging or not returning, you can specify
here how long you're willing to wait for them before deciding that they timed
out
</dd>
<p></p>
<dt><strong><a name="item_ok_locales_xx_%5b_yy_zz_%2e%2e%2e_%5d_%28default%3">ok_locales xx [ yy zz ... ] (default: all)</a></strong><br />
</dt>
<dd>
Which locales (country codes) are considered OK to receive mail from. Mail
using character sets used by languages in these countries, will not be marked
as possibly being spam in a foreign language.
</dd>
<dd>
<p>Note that all ISO-8859-* character sets, and Windows code page character sets,
are always permitted by default anyway.</p>
</dd>
<dd>
<p>If you wish SpamAssassin to block spam in foreign languages, set this to
the locale which matches your preference, from the list below:</p>
</dd>
<dl>
<dt><strong><a name="item_ja">ja</a></strong><br />
</dt>
<dd>
Japanese
</dd>
<p></p>
<dt><strong><a name="item_ko">ko</a></strong><br />
</dt>
<dd>
Korea
</dd>
<p></p>
<dt><strong><a name="item_ru">ru</a></strong><br />
</dt>
<dd>
Cyrillic charsets
</dd>
<p></p>
<dt><strong><a name="item_th">th</a></strong><br />
</dt>
<dd>
Thai
</dd>
<p></p>
<dt><strong><a name="item_zh">zh</a></strong><br />
</dt>
<dd>
Chinese (both simplified and traditional)
</dd>
<p></p></dl>
<dt><strong>auto_whitelist_factor n (default: 0.5, range [0..1])</strong><br />
</dt>
<dd>
How much towards the long-term mean for the sender to regress a message. Basically,
the algorithm is to track the long-term mean score of messages for the sender (<code>mean</code>),
and then once we have otherwise fully calculated the score for this message (<code>score</code>),
we calculate the final score for the message as:
</dd>
<dd>
<p><code>finalscore</code> = <code>score</code> + (<code>mean</code> - <code>score</code>) * <code>factor</code></p>
</dd>
<dd>
<p>So if <code>factor</code> = 0.5, then we'll move to half way between the calculated score and the mean.
If <code>factor</code> = 0.3, then we'll move about 1/3 of the way from the score toward the mean.
<code>factor</code> = 1 means just use the long-term mean; <code>factor</code> = 0 mean just use the calculated score.</p>
</dd>
<p></p>
<dt><strong><a name="item_describe_symbolic_test_name_description_%2e%2e%2e">describe SYMBOLIC_TEST_NAME description ...</a></strong><br />
</dt>
<dd>
Used to describe a test. This text is shown to users in the detailed report.
</dd>
<dd>
<p>Note that test names which begin with '__' are reserved for meta-match
sub-rules, and are not scored or listed in the 'tests hit' reports.</p>
</dd>
<p></p>
<dt><strong><a name="item_tflags_symbolic_test_name_%5b_%7b_net_%7c_nice_%7d">tflags SYMBOLIC_TEST_NAME [ { net | nice } ... ]</a></strong><br />
</dt>
<dd>
Used to set flags on a test. These flags are used in the score-determination back
end system for details of the test's behaviour. The following flags can be set:
</dd>
<dl>
<dt><strong><a name="item_net">net</a></strong><br />
</dt>
<dd>
The test is a network test, and will not be run in the mass checking system
or if <strong>-L</strong> is used, therefore its score should not be modified.
</dd>
<p></p>
<dt><strong><a name="item_nice">nice</a></strong><br />
</dt>
<dd>
The test is intended to compensate for common false positives, and should be
assigned a negative score.
</dd>
<p></p></dl>
<dt><strong><a name="item_report_%2e%2e%2esome_text_for_a_report%2e%2e%2e">report ...some text for a report...</a></strong><br />
</dt>
<dd>
Set the report template which is attached to spam mail messages. See the
<code>10_misc.cf</code> configuration file in <code>/usr/share/spamassassin</code> for an
example.
</dd>
<dd>
<p>If you change this, try to keep it under 76 columns (inside the the dots
below). Bear in mind that EVERY line will be prefixed with ``SPAM: '' in order
to make it clear what's been added, and allow other filters to <strong>remove</strong>
spamfilter modifications, so you lose 6 columns right there. Also note that the
first line of the report must start with 4 dashes, for the same reason. Each
<code>report</code> line appends to the existing template, so use
<code>clear-report-template</code> to restart.</p>
</dd>
<dd>
<p>The following template items are supported, and will be filled out by
SpamAssassin:</p>
</dd>
<dl>
<dt><strong><a name="item__hits_%3a_the_number_of_hits_the_message_triggered">_HITS_: the number of hits the message triggered</a></strong><br />
</dt>
<dt><strong><a name="item__reqd_%3a_the_required_hits_to_be_considered_spam">_REQD_: the required hits to be considered spam</a></strong><br />
</dt>
<dt><strong><a name="item__summary_%3a_the_full_details_of_what_hits_were_tr">_SUMMARY_: the full details of what hits were triggered</a></strong><br />
</dt>
<dt><strong><a name="item__ver_%3a_spamassassin_version">_VER_: SpamAssassin version</a></strong><br />
</dt>
<dt><strong><a name="item__home_%3a_spamassassin_home_url">_HOME_: SpamAssassin home URL</a></strong><br />
</dt>
</dl>
<dt><strong><a name="item_clear_report_template">clear_report_template</a></strong><br />
</dt>
<dd>
Clear the report template.
</dd>
<p></p>
<dt><strong><a name="item_terse_report_%2e%2e%2esome_text_for_a_report%2e%2e">terse_report ...some text for a report...</a></strong><br />
</dt>
<dd>
Set the report template which is attached to spam mail messages, for the
terse-report format. See the <code>10_misc.cf</code> configuration file in
<code>/usr/share/spamassassin</code> for an example.
</dd>
<p></p>
<dt><strong><a name="item_clear%2dterse%2dreport%2dtemplate">clear-terse-report-template</a></strong><br />
</dt>
<dd>
Clear the terse-report template.
</dd>
<p></p>
<dt><strong><a name="item_spamtrap_%2e%2e%2esome_text_for_spamtrap_reply_mai">spamtrap ...some text for spamtrap reply mail...</a></strong><br />
</dt>
<dd>
A template for spam-trap responses. If the first few lines begin with
<code>Xxxxxx: yyy</code> where Xxxxxx is a header and yyy is some text, they'll be used
as headers. See the <code>10_misc.cf</code> configuration file in
<code>/usr/share/spamassassin</code> for an example.
</dd>
<p></p>
<dt><strong><a name="item_clear_spamtrap_template">clear_spamtrap_template</a></strong><br />
</dt>
<dd>
Clear the spamtrap template.
</dd>
<p></p>
<dt><strong><a name="item_dcc_path_string">dcc_path STRING</a></strong><br />
</dt>
<dd>
This option tells SpamAssassin specifically where to find the pyzor client
instead of relying on SpamAssassin to find it in the current PATH.
</dd>
<p></p>
<dt><strong><a name="item_dcc_body_max_number">dcc_body_max NUMBER</a></strong><br />
</dt>
<dt><strong><a name="item_dcc_fuz1_max_number">dcc_fuz1_max NUMBER</a></strong><br />
</dt>
<dt><strong><a name="item_dcc_fuz2_max_number">dcc_fuz2_max NUMBER</a></strong><br />
</dt>
<dd>
DCC (Distributed Checksum Clearinghouse) is a system similar to Razor.
This option sets how often a message's body/fuz1/fuz2 checksum must have been
reported to the DCC server before SpamAssassin will consider the DCC check as
matched.
</dd>
<dd>
<p>As nearly all DCC clients are auto-reporting these checksums you should set
this to a relatively high value, e.g. 999999 (this is DCC's MANY count).</p>
</dd>
<dd>
<p>The default is 999999 for all these options.</p>
</dd>
<p></p>
<dt><strong><a name="item_dcc_add_header_%7b_0_%7c_1_%7d_%28default%3a_0%29">dcc_add_header { 0 | 1 } (default: 0)</a></strong><br />
</dt>
<dd>
DCC processing creates a message header containing the statistics for the
message. This option sets whether SpamAssassin will add the heading to
messages it processes.
</dd>
<dd>
<p>The default is to not add the header.</p>
</dd>
<p></p>
<dt><strong>dcc_timeout n (default: 10)</strong><br />
</dt>
<dd>
How many seconds you wait for dcc to complete before you go on without
the results
</dd>
<p></p>
<dt><strong><a name="item_pyzor_path_string">pyzor_path STRING</a></strong><br />
</dt>
<dd>
This option tells SpamAssassin specifically where to find the pyzor client
instead of relying on SpamAssassin to find it in the current PATH.
</dd>
<p></p>
<dt><strong><a name="item_pyzor_max_number">pyzor_max NUMBER</a></strong><br />
</dt>
<dd>
Pyzor is a system similar to Razor. This option sets how often a message's
body checksum must have been reported to the Pyzor server before SpamAssassin
will consider the Pyzor check as matched.
</dd>
<dd>
<p>The default is 5.</p>
</dd>
<p></p>
<dt><strong><a name="item_pyzor_add_header_%7b_0_%7c_1_%7d_%28default%3a_0%2">pyzor_add_header { 0 | 1 } (default: 0)</a></strong><br />
</dt>
<dd>
Pyzor processing creates a message header containing the statistics for the
message. This option sets whether SpamAssassin will add the heading to
messages it processes.
</dd>
<dd>
<p>The default is to not add the header.</p>
</dd>
<p></p>
<dt><strong>pyzor_timeout n (default: 10)</strong><br />
</dt>
<dd>
How many seconds you wait for pyzor to complete before you go on without
the results
</dd>
<p></p>
<dt><strong>razor_timeout n (default 10)</strong><br />
</dt>
<dd>
How many seconds you wait for razor to complete before you go on without
the results
</dd>
<p></p>
<dt><strong><a name="item_num_check_received_%7b_integer_%7d_%28default%3a_2">num_check_received { integer } (default: 2)</a></strong><br />
</dt>
<dd>
How many received lines from and including the original mail relay
do we check in RBLs (you'd want at least 1 or 2).
Note that for checking against dialup lists, you can call check_rbl
with a special set name of ``set-firsthop'' and this rule will only
be matched against the first hop if there is more than one hop, so
that you can set a negative score to not penalize people who properly
relayed through their ISP.
See dialup_codes for more details and an example
</dd>
<p></p></dl>
<p>
</p>
<hr />
<h1><a name="settings">SETTINGS</a></h1>
<p>These settings differ from the ones above, in that they are considered
'privileged'. Only users running <code>spamassassin</code> from their procmailrc's or
forward files, or sysadmins editing a file in <code>/etc/mail/spamassassin</code>, can
use them. <code>spamd</code> users cannot use them in their <code>user_prefs</code> files, for
security and efficiency reasons, unless allow_user_rules is enabled (and
then, they may only add rules from below).</p>
<dl>
<dt><strong><a name="item_allow_user_rules_%7b_0_%7c_1_%7d_%28default%3a_0%2">allow_user_rules { 0 | 1 } (default: 0)</a></strong><br />
</dt>
<dd>
This setting allows users to create rules (and only rules) in their
<code>user_prefs</code> files for use with <code>spamd</code>. It defaults to off, because
this could be a severe security hole. It may be possible for users to
gain root level access if <code>spamd</code> is run as root. It is NOT a good
idea, unless you have some other way of ensuring that users' tests are
safe. Don't use this unless you are certain you know what you are
doing. Furthermore, this option causes spamassassin to recompile all
the tests each time it processes a message for a user with a rule in
his/her <code>user_prefs</code> file, which could have a significant effect on
server load. It is not recommended.
</dd>
<p></p>
<dt><strong><a name="item_dialup_codes">dialup_codes { ``domain1'' => ``127.0.x.y'', ``domain2'' => ``127.0.a.b'' }</a></strong><br />
</dt>
<dd>
Default:
{ ``dialups.mail-abuse.org.'' => ``127.0.0.3'',
# For DUL + other codes, we ignore that it's on DUL
``rbl-plus.mail-abuse.org.'' => ``127.0.0.2'',
``relays.osirusoft.com.'' => ``127.0.0.3'' };
</dd>
<dd>
<p>WARNING!!! When passing a reference to a hash, you need to put the whole hash in
one line for the parser to read it correctly (you can check with
<code>spamassassin -D < mesg</code>)</p>
</dd>
<dd>
<p>Set this to what your RBLs return for dialup IPs
It is used by dialup-firsthop and relay-firsthop rules so that you can match
DUL codes and compensate DUL checks with a negative score if the IP is a dialup
IP the mail originated from and it was properly relayed by a hop before reaching
you (hopefully not your secondary MX :-)
The trailing ``-firsthop'' is magic, it's what triggers the RBL to only be run
on the originating hop
The idea is to not penalize (or penalize less) people who properly relayed
through their ISP's mail server</p>
</dd>
<dd>
<p>Here's an example showing the use of Osirusoft and MAPS DUL, as well as the use
of check_two_rbl_results to compensate for a match in both RBLs</p>
</dd>
<dd>
<p><table cellspacing="0" cellpadding="0"><tr><td>header RCVD_IN_DUL<td>rbleval:check_rbl('dialup', 'dialups.mail-abuse.org.')
<tr><td>describe RCVD_IN_DUL<td>Received from dialup, see <a href="http://www.mail-abuse.org/dul/">http://www.mail-abuse.org/dul/</a>
<tr><td>score RCVD_IN_DUL<td>4</table></p>
</dd>
<dd>
<p><table cellspacing="0" cellpadding="0"><tr><td>header X_RCVD_IN_DUL_FH<td>rbleval:check_rbl('dialup-firsthop', 'dialups.mail-abuse.org.')
<tr><td>describe X_RCVD_IN_DUL_FH<td>Received from first hop dialup, see <a href="http://www.mail-abuse.org/dul/">http://www.mail-abuse.org/dul/</a>
<tr><td>score X_RCVD_IN_DUL_FH<td>-3</table></p>
</dd>
<dd>
<p>header RCVD_IN_OSIRUSOFT_COM rbleval:check_rbl('osirusoft', 'relays.osirusoft.com.')
describe RCVD_IN_OSIRUSOFT_COM Received via an IP flagged in relays.osirusoft.com</p>
</dd>
<dd>
<p>header X_OSIRU_SPAM_SRC rbleval:check_rbl_results_for('osirusoft', '127.0.0.4')
describe X_OSIRU_SPAM_SRC DNSBL: sender is Confirmed Spam Source, penalizing further
score X_OSIRU_SPAM_SRC 3.0</p>
</dd>
<dd>
<p>header X_OSIRU_SPAMWARE_SITE rbleval:check_rbl_results_for('osirusoft', '127.0.0.6')
describe X_OSIRU_SPAMWARE_SITE DNSBL: sender is a Spamware site or vendor, penalizing further
score X_OSIRU_SPAMWARE_SITE 5.0</p>
</dd>
<dd>
<p><table cellspacing="0" cellpadding="0"><tr><td>header X_OSIRU_DUL_FH<td>rbleval:check_rbl('osirusoft-dul-firsthop', 'relays.osirusoft.com.')
<tr><td>describe X_OSIRU_DUL_FH<td>Received from first hop dialup listed in relays.osirusoft.com
<tr><td>score X_OSIRU_DUL_FH<td>-1.5</table></p>
</dd>
<dd>
<p><table cellspacing="0" cellpadding="0"><tr><td>header Z_FUDGE_DUL_MAPS_OSIRU<td>rblreseval:check_two_rbl_results('osirusoft', ``127.0.0.3'', 'dialup', ``127.0.0.3'')
<tr><td>describe Z_FUDGE_DUL_MAPS_OSIRU<td>Do not double penalize for MAPS DUL and Osirusoft DUL
<tr><td>score Z_FUDGE_DUL_MAPS_OSIRU<td>-2</table></p>
</dd>
<dd>
<p><table cellspacing="0" cellpadding="0"><tr><td>header Z_FUDGE_RELAY_OSIRU<td>rblreseval:check_two_rbl_results('osirusoft', ``127.0.0.2'', 'relay', ``127.0.0.2'')
<tr><td>describe Z_FUDGE_RELAY_OSIRU<td>Do not double penalize for being an open relay on Osirusoft and another DNSBL
<tr><td>score Z_FUDGE_RELAY_OSIRU<td>-2</table></p>
</dd>
<dd>
<p><table cellspacing="0" cellpadding="0"><tr><td>header Z_FUDGE_DUL_OSIRU_FH<td>rblreseval:check_two_rbl_results('osirusoft-dul-firsthop', ``127.0.0.3'', 'dialup-firsthop', ``127.0.0.3'')
<tr><td>describe Z_FUDGE_DUL_OSIRU_FH<td>Do not double compensate for MAPS DUL and Osirusoft DUL first hop dialup
<tr><td>score Z_FUDGE_DUL_OSIRU_FH<td>1.5</table></p>
</dd>
<p></p>
<dt><strong><a name="item_header_symbolic_test_name_header_op_%2fpattern%2fm">header SYMBOLIC_TEST_NAME header op /pattern/modifiers [if-unset: STRING]</a></strong><br />
</dt>
<dd>
Define a test. <a href="#item_symbolic_test_name"><code>SYMBOLIC_TEST_NAME</code></a> is a symbolic test name, such as
'FROM_ENDS_IN_NUMS'. <code>header</code> is the name of a mail header, such as
'Subject', 'To', etc.
</dd>
<dd>
<p>'ALL' can be used to mean the text of all the message's headers. 'ToCc' can be
used to mean the contents of both the 'To' and 'Cc' headers.</p>
</dd>
<dd>
<p><code>op</code> is either <code>=~</code> (contains regular expression) or <code>!~</code> (does not contain
regular expression), and <code>pattern</code> is a valid Perl regular expression, with
<code>modifiers</code> as regexp modifiers in the usual style.</p>
</dd>
<dd>
<p>If the <code>[if-unset: STRING]</code> tag is present, then <code>STRING</code> will
be used if the header is not found in the mail message.</p>
</dd>
<dd>
<p>Note that test names which begin with '__' are reserved for meta-match
sub-rules, and are not scored or listed in the 'tests hit' reports.</p>
</dd>
<p></p>
<dt><strong><a name="item_header_symbolic_test_name_exists%3aname_of_header">header SYMBOLIC_TEST_NAME exists:name_of_header</a></strong><br />
</dt>
<dd>
Define a header existence test. <code>name_of_header</code> is the name of a
header to test for existence. This is just a very simple version of
the above header tests.
</dd>
<p></p>
<dt><strong><a name="item_name_of_eval_method">header SYMBOLIC_TEST_NAME eval:name_of_eval_method([arguments])</a></strong><br />
</dt>
<dd>
Define a header eval test. <a href="#item_name_of_eval_method"><code>name_of_eval_method</code></a> is the name of
a method on the <code>Mail::SpamAssassin::EvalTests</code> object. <code>arguments</code>
are optional arguments to the function call.
</dd>
<p></p>
<dt><strong><a name="item_body_symbolic_test_name_%2fpattern%2fmodifiers">body SYMBOLIC_TEST_NAME /pattern/modifiers</a></strong><br />
</dt>
<dd>
Define a body pattern test. <code>pattern</code> is a Perl regular expression.
</dd>
<dd>
<p>The 'body' in this case is the textual parts of the message body; any non-text
MIME parts are stripped, and the message decoded from Quoted-Printable or
Base-64-encoded format if necessary. All HTML tags and line breaks will be
removed before matching.</p>
</dd>
<p></p>
<dt><strong>body SYMBOLIC_TEST_NAME eval:name_of_eval_method([args])</strong><br />
</dt>
<dd>
Define a body eval test. See above.
</dd>
<p></p>
<dt><strong><a name="item_uri_symbolic_test_name_%2fpattern%2fmodifiers">uri SYMBOLIC_TEST_NAME /pattern/modifiers</a></strong><br />
</dt>
<dd>
Define a uri pattern test. <code>pattern</code> is a Perl regular expression.
</dd>
<dd>
<p>The 'uri' in this case is a list of all the URIs in the body of the email,
and the test will be run on each and every one of those URIs, adjusting the
score if a match is found. Use this test instead of one of the body tests
when you need to match a URI, as it is more accurately bound to the start/end
points of the URI, and will also be faster.</p>
</dd>
<p></p>
<dt><strong><a name="item_rawbody_symbolic_test_name_%2fpattern%2fmodifiers">rawbody SYMBOLIC_TEST_NAME /pattern/modifiers</a></strong><br />
</dt>
<dd>
Define a raw-body pattern test. <code>pattern</code> is a Perl regular expression.
</dd>
<dd>
<p>The 'raw body' of a message is the text, including all textual parts.
The text will be decoded from base64 or quoted-printable encoding, but
HTML tags and line breaks will still be present.</p>
</dd>
<p></p>
<dt><strong>rawbody SYMBOLIC_TEST_NAME eval:name_of_eval_method([args])</strong><br />
</dt>
<dd>
Define a raw-body eval test. See above.
</dd>
<p></p>
<dt><strong><a name="item_full_symbolic_test_name_%2fpattern%2fmodifiers">full SYMBOLIC_TEST_NAME /pattern/modifiers</a></strong><br />
</dt>
<dd>
Define a full-body pattern test. <code>pattern</code> is a Perl regular expression.
</dd>
<dd>
<p>The 'full body' of a message is the un-decoded text, including all parts
(including images or other attachments). SpamAssassin no longer tests
full tests against decoded text; use <code>rawbody</code> for that.</p>
</dd>
<p></p>
<dt><strong>full SYMBOLIC_TEST_NAME eval:name_of_eval_method([args])</strong><br />
</dt>
<dd>
Define a full-body eval test. See above.
</dd>
<p></p>
<dt><strong><a name="item_meta_symbolic_test_name_boolean_expression">meta SYMBOLIC_TEST_NAME boolean expression</a></strong><br />
</dt>
<dd>
Define a boolean expression test in terms of other tests that have
been hit or not hit. For example:
</dd>
<dd>
<p>meta META1 TEST1 && !(TEST2 || TEST3)</p>
</dd>
<dd>
<p>Note that English language operators (``and'', ``or'') will be treated as
rule names, and that there is no XOR operator.</p>
</dd>
<dd>
<p>If you want to define a meta-rule, but do not want its individual sub-rules to
count towards the final score unless the entire meta-rule matches, give the
sub-rules names that start with '__' (two underscores). SpamAssassin will
ignore these for scoring.</p>
</dd>
<p></p></dl>
<p>
</p>
<hr />
<h1><a name="privileged_settings">PRIVILEGED SETTINGS</a></h1>
<p>These settings differ from the ones above, in that they are considered 'more
privileged' -- even more than the ones in the SETTINGS section. No matter what
<code>allow_user_rules</code> is set to, these can never be set from a user's
<code>user_prefs</code> file.</p>
<dl>
<dt><strong><a name="item_symbolic_test_name">test SYMBOLIC_TEST_NAME (ok|fail) Some string to test against</a></strong><br />
</dt>
<dd>
Define a regression testing string. You can have more than one regression test string
per symbolic test name. Simply specify a string that you wish the test to match.
</dd>
<dd>
<p>These tests are only run as part of the test suite - they should not affect the general
running of SpamAssassin.</p>
</dd>
<p></p>
<dt><strong><a name="item_razor_config_filename">razor_config filename</a></strong><br />
</dt>
<dd>
Define the filename used to store Razor's configuration settings.
Currently this is the same value Razor itself uses: <code>~/razor.conf</code>.
</dd>
<p></p>
<dt><strong><a name="item_dcc_options_options">dcc_options options</a></strong><br />
</dt>
<dd>
Specify additional options to the <code>dccproc(8)</code> command. Please note that only
[A-Z -] is allowed (security).
</dd>
<dd>
<p>The default is <code>-R</code></p>
</dd>
<p></p>
<dt><strong><a name="item_file">auto_whitelist_path /path/to/file (default: ~/.spamassassin/auto-whitelist)</a></strong><br />
</dt>
<dd>
Automatic-whitelist directory or file. By default, each user has their own, in
their <code>~/.spamassassin</code> directory with mode 0700, but for system-wide
SpamAssassin use, you may want to share this across all users.
</dd>
<p></p>
<dt><strong><a name="item_dir">timelog_path /path/to/dir (default: NULL)</a></strong><br />
</dt>
<dd>
If you set this value, razor will try to create logfiles for each message I
processes and dump information on how fast it ran, and in which parts of the
code the time was spent.
The files will be named: unixdate_mesgid (i.e <a href="mailto:1023257504_chuvn31gdu@4ax.com)">1023257504_chuvn31gdu@4ax.com)</a>
</dd>
<dd>
<p>Make sure SA can write the log file, if you're not sure what permissions
needed, make the log directory chmod'ed 1777, and adjust later.</p>
</dd>
<p></p>
<dt><strong><a name="item_auto_whitelist_file_mode">auto_whitelist_file_mode (default: 0700)</a></strong><br />
</dt>
<dd>
The file mode bits used for the automatic-whitelist directory or file.
Make sure this has the relevant execute-bits set (--x), otherwise
things will go wrong.
</dd>
<p></p>
<dt><strong><a name="item_user%2dscores%2ddsn_dbi%3adatabasetype%3adatabasen">user-scores-dsn DBI:databasetype:databasename:hostname:port</a></strong><br />
</dt>
<dd>
If you load user scores from an SQL database, this will set the DSN
used to connect. Example: <code>DBI:mysql:spamassassin:localhost</code>
</dd>
<p></p>
<dt><strong><a name="item_user_scores_sql_username_username">user_scores_sql_username username</a></strong><br />
</dt>
<dd>
The authorized username to connect to the above DSN.
</dd>
<p></p>
<dt><strong><a name="item_user_scores_sql_password_password">user_scores_sql_password password</a></strong><br />
</dt>
<dd>
The password for the database username, for the above DSN.
</dd>
<p></p>
<dt><strong><a name="item_user_scores_sql_table_tablename">user_scores_sql_table tablename</a></strong><br />
</dt>
<dd>
The table user preferences are stored in, for the above DSN.
</dd>
<p></p>
<dt><strong><a name="item_spamphrase_score_phrase_%2e%2e%2e">spamphrase score phrase ...</a></strong><br />
</dt>
<dd>
A 2-word spam phrase, for the FREQ_SPAM_PHRASE test.
</dd>
<p></p>
<dt><strong><a name="item_spamphrase%2dhighest%2dscore_nnnnn">spamphrase-highest-score nnnnn</a></strong><br />
</dt>
<dd>
The highest score of any of the spamphrases. Used for scaling.
</dd>
<p></p></dl>
<p>
</p>
<hr />
<h1><a name="locali[sz]ation">LOCALI[SZ]ATION</a></h1>
<p>A line starting with the text <code>lang xx</code> will only be interpreted
if the user is in that locale, allowing test descriptions and
templates to be set for that language.</p>
<p>
</p>
<hr />
<h1><a name="see_also">SEE ALSO</a></h1>
<p><code>Mail::SpamAssassin</code>
<code>spamassassin</code>
<code>spamd</code>
</p>
</body>
</html>
