You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@spamassassin.apache.org by km...@apache.org on 2018/09/16 14:36:13 UTC
svn commit: r1841017 [11/17] - in /spamassassin/site/full/3.4.x: ./ doc/
Added: spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Pyzor.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Pyzor.html?rev=1841017&view=auto
==============================================================================
--- spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Pyzor.html (added)
+++ spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Pyzor.html Sun Sep 16 14:36:10 2018
@@ -0,0 +1,91 @@
+<?xml version="1.0" ?>
+<!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></title>
+<meta http-equiv="content-type" content="text/html; charset=utf-8" />
+<link rev="made" href="mailto:root@localhost" />
+</head>
+
+<body style="background-color: white">
+
+
+
+<ul id="index">
+ <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-OPTIONS">USER OPTIONS</a></li>
+ <li><a href="#ADMINISTRATOR-OPTIONS">ADMINISTRATOR OPTIONS</a></li>
+</ul>
+
+<h1 id="NAME">NAME</h1>
+
+<p>Mail::SpamAssassin::Plugin::Pyzor - perform Pyzor check of messages</p>
+
+<h1 id="SYNOPSIS">SYNOPSIS</h1>
+
+<pre><code> loadplugin Mail::SpamAssassin::Plugin::Pyzor</code></pre>
+
+<h1 id="DESCRIPTION">DESCRIPTION</h1>
+
+<p>Pyzor is a collaborative, networked system to detect and block spam using identifying digests of messages.</p>
+
+<p>See http://pyzor.org/ for more information about Pyzor.</p>
+
+<h1 id="USER-OPTIONS">USER OPTIONS</h1>
+
+<dl>
+
+<dt id="use_pyzor-0-1-default:-1">use_pyzor (0|1) (default: 1)</dt>
+<dd>
+
+<p>Whether to use Pyzor, if it is available.</p>
+
+</dd>
+<dt id="pyzor_max-NUMBER-default:-5">pyzor_max NUMBER (default: 5)</dt>
+<dd>
+
+<p>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.</p>
+
+<p>As most clients should not be auto-reporting these checksums, you should set this to a relatively low value, e.g. <code>5</code>.</p>
+
+</dd>
+</dl>
+
+<h1 id="ADMINISTRATOR-OPTIONS">ADMINISTRATOR OPTIONS</h1>
+
+<dl>
+
+<dt id="pyzor_timeout-n-default:-3.5">pyzor_timeout n (default: 3.5)</dt>
+<dd>
+
+<p>How many seconds you wait for Pyzor to complete, before scanning continues without the Pyzor results. A numeric value is optionally suffixed by a time unit (s, m, h, d, w, indicating seconds (default), minutes, hours, days, weeks).</p>
+
+<p>You can configure Pyzor to have its own per-server timeout. Set this plugin's timeout with that in mind. This plugin's timeout is a maximum ceiling. If Pyzor takes longer than this to complete its communication with all servers, no results are used by SpamAssassin.</p>
+
+<p>Pyzor servers do not yet synchronize their servers, so it can be beneficial to check and report to more than one. See the pyzor-users mailing list for alternate servers that are not published via 'pyzor discover'.</p>
+
+<p>If you are using multiple Pyzor servers, a good rule of thumb would be to set the SpamAssassin plugin's timeout to be the same or just a bit more than the per-server Pyzor timeout (e.g., 3.5 and 2 for two Pyzor servers). If more than one of your Pyzor servers is always timing out, consider removing one of them.</p>
+
+</dd>
+<dt id="pyzor_options-options">pyzor_options options</dt>
+<dd>
+
+<p>Specify additional options to the pyzor(1) command. Please note that only characters in the range [0-9A-Za-z ,._/-] are allowed for security reasons.</p>
+
+</dd>
+<dt id="pyzor_path-STRING">pyzor_path STRING</dt>
+<dd>
+
+<p>This option tells SpamAssassin specifically where to find the <code>pyzor</code> client instead of relying on SpamAssassin to find it in the current PATH. Note that if <i>taint mode</i> is enabled in the Perl interpreter, you should use this, as the current PATH will have been cleared.</p>
+
+</dd>
+</dl>
+
+
+</body>
+
+</html>
+
+
Added: spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Pyzor.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Pyzor.txt?rev=1841017&view=auto
==============================================================================
--- spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Pyzor.txt (added)
+++ spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Pyzor.txt Sun Sep 16 14:36:10 2018
@@ -0,0 +1,59 @@
+NAME
+ Mail::SpamAssassin::Plugin::Pyzor - perform Pyzor check of messages
+
+SYNOPSIS
+ loadplugin Mail::SpamAssassin::Plugin::Pyzor
+
+DESCRIPTION
+ Pyzor is a collaborative, networked system to detect and block spam
+ using identifying digests of messages.
+
+ See http://pyzor.org/ for more information about Pyzor.
+
+USER OPTIONS
+ use_pyzor (0|1) (default: 1)
+ Whether to use Pyzor, if it is available.
+
+ pyzor_max NUMBER (default: 5)
+ 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.
+
+ As most clients should not be auto-reporting these checksums, you
+ should set this to a relatively low value, e.g. 5.
+
+ADMINISTRATOR OPTIONS
+ pyzor_timeout n (default: 3.5)
+ How many seconds you wait for Pyzor to complete, before scanning
+ continues without the Pyzor results. A numeric value is optionally
+ suffixed by a time unit (s, m, h, d, w, indicating seconds
+ (default), minutes, hours, days, weeks).
+
+ You can configure Pyzor to have its own per-server timeout. Set this
+ plugin's timeout with that in mind. This plugin's timeout is a
+ maximum ceiling. If Pyzor takes longer than this to complete its
+ communication with all servers, no results are used by SpamAssassin.
+
+ Pyzor servers do not yet synchronize their servers, so it can be
+ beneficial to check and report to more than one. See the pyzor-users
+ mailing list for alternate servers that are not published via 'pyzor
+ discover'.
+
+ If you are using multiple Pyzor servers, a good rule of thumb would
+ be to set the SpamAssassin plugin's timeout to be the same or just a
+ bit more than the per-server Pyzor timeout (e.g., 3.5 and 2 for two
+ Pyzor servers). If more than one of your Pyzor servers is always
+ timing out, consider removing one of them.
+
+ pyzor_options options
+ Specify additional options to the pyzor(1) command. Please note that
+ only characters in the range [0-9A-Za-z ,._/-] are allowed for
+ security reasons.
+
+ pyzor_path STRING
+ This option tells SpamAssassin specifically where to find the
+ "pyzor" client instead of relying on SpamAssassin to find it in the
+ current PATH. Note that if *taint mode* is enabled in the Perl
+ interpreter, you should use this, as the current PATH will have been
+ cleared.
+
Added: spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Razor2.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Razor2.html?rev=1841017&view=auto
==============================================================================
--- spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Razor2.html (added)
+++ spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Razor2.html Sun Sep 16 14:36:10 2018
@@ -0,0 +1,71 @@
+<?xml version="1.0" ?>
+<!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></title>
+<meta http-equiv="content-type" content="text/html; charset=utf-8" />
+<link rev="made" href="mailto:root@localhost" />
+</head>
+
+<body style="background-color: white">
+
+
+
+<ul id="index">
+ <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-SETTINGS">USER SETTINGS</a></li>
+ <li><a href="#ADMINISTRATOR-SETTINGS">ADMINISTRATOR SETTINGS</a></li>
+</ul>
+
+<h1 id="NAME">NAME</h1>
+
+<p>Mail::SpamAssassin::Plugin::Razor2 - perform Razor check of messages</p>
+
+<h1 id="SYNOPSIS">SYNOPSIS</h1>
+
+<pre><code> loadplugin Mail::SpamAssassin::Plugin::Razor2</code></pre>
+
+<h1 id="DESCRIPTION">DESCRIPTION</h1>
+
+<p>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.</p>
+
+<p>See http://razor.sourceforge.net/ for more information about Razor.</p>
+
+<h1 id="USER-SETTINGS">USER SETTINGS</h1>
+
+<dl>
+
+<dt id="use_razor2-0-1-default:-1">use_razor2 (0|1) (default: 1)</dt>
+<dd>
+
+<p>Whether to use Razor2, if it is available.</p>
+
+</dd>
+</dl>
+
+<h1 id="ADMINISTRATOR-SETTINGS">ADMINISTRATOR SETTINGS</h1>
+
+<dl>
+
+<dt id="razor_timeout-n-default:-5">razor_timeout n (default: 5)</dt>
+<dd>
+
+<p>How many seconds you wait for Razor to complete before you go on without the results</p>
+
+</dd>
+<dt id="razor_config-filename">razor_config filename</dt>
+<dd>
+
+<p>Define the filename used to store Razor's configuration settings. Currently this is left to Razor to decide.</p>
+
+</dd>
+</dl>
+
+
+</body>
+
+</html>
+
+
Added: spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Razor2.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Razor2.txt?rev=1841017&view=auto
==============================================================================
--- spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Razor2.txt (added)
+++ spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Razor2.txt Sun Sep 16 14:36:10 2018
@@ -0,0 +1,27 @@
+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.
+
+USER SETTINGS
+ use_razor2 (0|1) (default: 1)
+ Whether to use Razor2, if it is available.
+
+ADMINISTRATOR SETTINGS
+ 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.
+
Added: spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_RelayCountry.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_RelayCountry.html?rev=1841017&view=auto
==============================================================================
--- spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_RelayCountry.html (added)
+++ spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_RelayCountry.html Sun Sep 16 14:36:10 2018
@@ -0,0 +1,67 @@
+<?xml version="1.0" ?>
+<!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></title>
+<meta http-equiv="content-type" content="text/html; charset=utf-8" />
+<link rev="made" href="mailto:root@localhost" />
+</head>
+
+<body style="background-color: white">
+
+
+
+<ul id="index">
+ <li><a href="#NAME">NAME</a></li>
+ <li><a href="#SYNOPSIS">SYNOPSIS</a></li>
+ <li><a href="#DESCRIPTION">DESCRIPTION</a></li>
+ <li><a href="#REQUIREMENT">REQUIREMENT</a></li>
+ <li><a href="#USER-PREFERENCES">USER PREFERENCES</a></li>
+</ul>
+
+<h1 id="NAME">NAME</h1>
+
+<p>RelayCountry - add message metadata indicating the country code of each relay</p>
+
+<h1 id="SYNOPSIS">SYNOPSIS</h1>
+
+<pre><code> loadplugin Mail::SpamAssassin::Plugin::RelayCountry</code></pre>
+
+<h1 id="DESCRIPTION">DESCRIPTION</h1>
+
+<p>The RelayCountry plugin attempts to determine the domain country codes of each relay used in the delivery path of messages and add that information to the message metadata as "X-Relay-Countries", or the <code>_RELAYCOUNTRY_</code> header markup.</p>
+
+<h1 id="REQUIREMENT">REQUIREMENT</h1>
+
+<p>This plugin requires the GeoIP2, Geo::IP, IP::Country::DB_File or IP::Country::Fast module from CPAN. For backward compatibility IP::Country::Fast is used as fallback if no db_type is specified in the config file.</p>
+
+<h1 id="USER-PREFERENCES">USER PREFERENCES</h1>
+
+<p>The following options can be used in both site-wide (<code>local.cf</code>) and user-specific (<code>user_prefs</code>) configuration files to customize how SpamAssassin handles incoming email messages.</p>
+
+<dl>
+
+<dt id="country_db_type-STRING">country_db_type STRING</dt>
+<dd>
+
+<p>This option tells SpamAssassin which type of Geo database to use. Valid database types are GeoIP, GeoIP2, DB_File and Fast.</p>
+
+</dd>
+</dl>
+
+<dl>
+
+<dt id="country_db_path-STRING">country_db_path STRING</dt>
+<dd>
+
+<p>This option tells SpamAssassin where to find MaxMind GeoIP2 or IP::Country::DB_File database.</p>
+
+</dd>
+</dl>
+
+
+</body>
+
+</html>
+
+
Added: spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_RelayCountry.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_RelayCountry.txt?rev=1841017&view=auto
==============================================================================
--- spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_RelayCountry.txt (added)
+++ spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_RelayCountry.txt Sun Sep 16 14:36:10 2018
@@ -0,0 +1,32 @@
+NAME
+ RelayCountry - add message metadata indicating the country code of each
+ relay
+
+SYNOPSIS
+ loadplugin Mail::SpamAssassin::Plugin::RelayCountry
+
+DESCRIPTION
+ The RelayCountry plugin attempts to determine the domain country codes
+ of each relay used in the delivery path of messages and add that
+ information to the message metadata as "X-Relay-Countries", or the
+ "_RELAYCOUNTRY_" header markup.
+
+REQUIREMENT
+ This plugin requires the GeoIP2, Geo::IP, IP::Country::DB_File or
+ IP::Country::Fast module from CPAN. For backward compatibility
+ IP::Country::Fast is used as fallback if no db_type is specified in the
+ config file.
+
+USER PREFERENCES
+ The following options can be used in both site-wide ("local.cf") and
+ user-specific ("user_prefs") configuration files to customize how
+ SpamAssassin handles incoming email messages.
+
+ country_db_type STRING
+ This option tells SpamAssassin which type of Geo database to use.
+ Valid database types are GeoIP, GeoIP2, DB_File and Fast.
+
+ country_db_path STRING
+ This option tells SpamAssassin where to find MaxMind GeoIP2 or
+ IP::Country::DB_File database.
+
Added: spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_ReplaceTags.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_ReplaceTags.html?rev=1841017&view=auto
==============================================================================
--- spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_ReplaceTags.html (added)
+++ spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_ReplaceTags.html Sun Sep 16 14:36:10 2018
@@ -0,0 +1,100 @@
+<?xml version="1.0" ?>
+<!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></title>
+<meta http-equiv="content-type" content="text/html; charset=utf-8" />
+<link rev="made" href="mailto:root@localhost" />
+</head>
+
+<body style="background-color: white">
+
+
+
+<ul id="index">
+ <li><a href="#NAME">NAME</a></li>
+ <li><a href="#SYNOPSIS">SYNOPSIS</a></li>
+ <li><a href="#RULE-DEFINITIONS-AND-PRIVILEGED-SETTINGS">RULE DEFINITIONS AND PRIVILEGED SETTINGS</a></li>
+</ul>
+
+<h1 id="NAME">NAME</h1>
+
+<p>Mail::SpamAssassin::Plugin::ReplaceTags - tags for SpamAssassin rules</p>
+
+<p>The plugin allows rules to contain regular expression tags to be used in regular expression rules. The tags make it much easier to maintain complicated rules.</p>
+
+<p>Warning: This plugin relies on data structures specific to this version of SpamAssasin; it is not guaranteed to work with other versions of SpamAssassin.</p>
+
+<h1 id="SYNOPSIS">SYNOPSIS</h1>
+
+<pre><code> loadplugin Mail::SpamAssassin::Plugin::ReplaceTags
+
+ replace_start <
+ replace_end >
+
+ replace_tag A [a@]
+ replace_tag G [gk]
+ replace_tag I [il|!1y\?\xcc\xcd\xce\xcf\xec\xed\xee\xef]
+ replace_tag R [r3]
+ replace_tag V (?:[vu]|\\\/)
+ replace_tag SP [\s~_-]
+
+ body VIAGRA_OBFU /(?!viagra)<V>+<SP>*<I>+<SP>*<A>+<SP>*<G>+<SP>*<R>+<SP>*<A>+/i
+ describe VIAGRA_OBFU Attempt to obfuscate "viagra"
+
+ replace_rules VIAGRA_OBFU</code></pre>
+
+<h1 id="RULE-DEFINITIONS-AND-PRIVILEGED-SETTINGS">RULE DEFINITIONS AND PRIVILEGED SETTINGS</h1>
+
+<dl>
+
+<dt id="replace_tag-tagname-expression">replace_tag tagname expression</dt>
+<dd>
+
+<p>Assign a valid regular expression to tagname.</p>
+
+<p>Note: It is not recommended to put quantifiers inside the tag, it's better to put them inside the rule itself for greater flexibility.</p>
+
+</dd>
+<dt id="replace_pre-tagname-expression">replace_pre tagname expression</dt>
+<dd>
+
+<p>Assign a valid regular expression to tagname. The expression will be placed before each tag that is replaced.</p>
+
+</dd>
+<dt id="replace_inter-tagname-expression">replace_inter tagname expression</dt>
+<dd>
+
+<p>Assign a valid regular expression to tagname. The expression will be placed between each two immediately adjacent tags that are replaced.</p>
+
+</dd>
+<dt id="replace_post-tagname-expression">replace_post tagname expression</dt>
+<dd>
+
+<p>Assign a valid regular expression to tagname. The expression will be placed after each tag that is replaced.</p>
+
+</dd>
+<dt id="replace_rules-list_of_tests">replace_rules list_of_tests</dt>
+<dd>
+
+<p>Specify a list of symbolic test names (separated by whitespace) of tests which should be modified using replacement tags. Only simple regular expression body, header, uri, full, rawbody tests are supported.</p>
+
+</dd>
+<dt id="replace_start-string">replace_start string</dt>
+<dd>
+
+</dd>
+<dt id="replace_end-string">replace_end string</dt>
+<dd>
+
+<p>String(s) which indicate the start and end of a tag inside a rule. Only tags enclosed by the start and end strings are found and replaced.</p>
+
+</dd>
+</dl>
+
+
+</body>
+
+</html>
+
+
Added: spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_ReplaceTags.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_ReplaceTags.txt?rev=1841017&view=auto
==============================================================================
--- spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_ReplaceTags.txt (added)
+++ spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_ReplaceTags.txt Sun Sep 16 14:36:10 2018
@@ -0,0 +1,60 @@
+NAME
+ Mail::SpamAssassin::Plugin::ReplaceTags - tags for SpamAssassin rules
+
+ The plugin allows rules to contain regular expression tags to be used in
+ regular expression rules. The tags make it much easier to maintain
+ complicated rules.
+
+ Warning: This plugin relies on data structures specific to this version
+ of SpamAssasin; it is not guaranteed to work with other versions of
+ SpamAssassin.
+
+SYNOPSIS
+ loadplugin Mail::SpamAssassin::Plugin::ReplaceTags
+
+ replace_start <
+ replace_end >
+
+ replace_tag A [a@]
+ replace_tag G [gk]
+ replace_tag I [il|!1y\?\xcc\xcd\xce\xcf\xec\xed\xee\xef]
+ replace_tag R [r3]
+ replace_tag V (?:[vu]|\\\/)
+ replace_tag SP [\s~_-]
+
+ body VIAGRA_OBFU /(?!viagra)<V>+<SP>*<I>+<SP>*<A>+<SP>*<G>+<SP>*<R>+<SP>*<A>+/i
+ describe VIAGRA_OBFU Attempt to obfuscate "viagra"
+
+ replace_rules VIAGRA_OBFU
+
+RULE DEFINITIONS AND PRIVILEGED SETTINGS
+ replace_tag tagname expression
+ Assign a valid regular expression to tagname.
+
+ Note: It is not recommended to put quantifiers inside the tag, it's
+ better to put them inside the rule itself for greater flexibility.
+
+ replace_pre tagname expression
+ Assign a valid regular expression to tagname. The expression will be
+ placed before each tag that is replaced.
+
+ replace_inter tagname expression
+ Assign a valid regular expression to tagname. The expression will be
+ placed between each two immediately adjacent tags that are replaced.
+
+ replace_post tagname expression
+ Assign a valid regular expression to tagname. The expression will be
+ placed after each tag that is replaced.
+
+ replace_rules list_of_tests
+ Specify a list of symbolic test names (separated by whitespace) of
+ tests which should be modified using replacement tags. Only simple
+ regular expression body, header, uri, full, rawbody tests are
+ supported.
+
+ replace_start string
+ replace_end string
+ String(s) which indicate the start and end of a tag inside a rule.
+ Only tags enclosed by the start and end strings are found and
+ replaced.
+
Added: spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_ResourceLimits.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_ResourceLimits.html?rev=1841017&view=auto
==============================================================================
--- spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_ResourceLimits.html (added)
+++ spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_ResourceLimits.html Sun Sep 16 14:36:10 2018
@@ -0,0 +1,75 @@
+<?xml version="1.0" ?>
+<!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></title>
+<meta http-equiv="content-type" content="text/html; charset=utf-8" />
+<link rev="made" href="mailto:root@localhost" />
+</head>
+
+<body style="background-color: white">
+
+
+
+<ul id="index">
+ <li><a href="#NAME">NAME</a></li>
+ <li><a href="#SYNOPSIS">SYNOPSIS</a></li>
+ <li><a href="#DESCRIPTION">DESCRIPTION</a></li>
+ <li><a href="#ADMINISTRATOR-SETTINGS">ADMINISTRATOR SETTINGS</a></li>
+</ul>
+
+<h1 id="NAME">NAME</h1>
+
+<p>Mail::SpamAssassin::Plugin::ResourceLimits - Limit the memory and/or CPU of child spamd processes</p>
+
+<h1 id="SYNOPSIS">SYNOPSIS</h1>
+
+<pre><code> # This plugin is for admin only and cannot be specified in user config.
+ loadplugin Mail::SpamAssassin::Plugin::ResourceLimits
+
+ # Sets to RLIMIT_CPU from BSD::Resource. The quota is based on max CPU Time seconds.
+ resource_limit_cpu 120
+
+ # Sets to RLIMIT_RSS and RLIMIT_AS via BSD::Resource.
+ resource_limit_cpu 536870912</code></pre>
+
+<h1 id="DESCRIPTION">DESCRIPTION</h1>
+
+<p>This module leverages BSD::Resource to assure your spamd child processes do not exceed specified CPU or memory limit. If this happens, the child process will die. See the <a>BSD::Resource</a> for more details.</p>
+
+<p>NOTE: Because this plugin uses BSD::Resource, it will not function on Windows.</p>
+
+<h1 id="ADMINISTRATOR-SETTINGS">ADMINISTRATOR SETTINGS</h1>
+
+<dl>
+
+<dt id="resource_limit_cpu-120-default:-0-or-no-limit">resource_limit_cpu 120 (default: 0 or no limit)</dt>
+<dd>
+
+<p>How many cpu cycles are allowed on this process before it dies.</p>
+
+</dd>
+<dt id="resource_limit_mem-536870912-default:-0-or-no-limit">resource_limit_mem 536870912 (default: 0 or no limit)</dt>
+<dd>
+
+<p>The maximum number of bytes of memory allowed both for:</p>
+
+<ul>
+
+<li><p>(virtual) address space bytes</p>
+
+</li>
+<li><p>resident set size</p>
+
+</li>
+</ul>
+
+</dd>
+</dl>
+
+
+</body>
+
+</html>
+
+
Added: spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_ResourceLimits.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_ResourceLimits.txt?rev=1841017&view=auto
==============================================================================
--- spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_ResourceLimits.txt (added)
+++ spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_ResourceLimits.txt Sun Sep 16 14:36:10 2018
@@ -0,0 +1,33 @@
+NAME
+ Mail::SpamAssassin::Plugin::ResourceLimits - Limit the memory and/or CPU
+ of child spamd processes
+
+SYNOPSIS
+ # This plugin is for admin only and cannot be specified in user config.
+ loadplugin Mail::SpamAssassin::Plugin::ResourceLimits
+
+ # Sets to RLIMIT_CPU from BSD::Resource. The quota is based on max CPU Time seconds.
+ resource_limit_cpu 120
+
+ # Sets to RLIMIT_RSS and RLIMIT_AS via BSD::Resource.
+ resource_limit_cpu 536870912
+
+DESCRIPTION
+ This module leverages BSD::Resource to assure your spamd child processes
+ do not exceed specified CPU or memory limit. If this happens, the child
+ process will die. See the BSD::Resource for more details.
+
+ NOTE: Because this plugin uses BSD::Resource, it will not function on
+ Windows.
+
+ADMINISTRATOR SETTINGS
+ resource_limit_cpu 120 (default: 0 or no limit)
+ How many cpu cycles are allowed on this process before it dies.
+
+ resource_limit_mem 536870912 (default: 0 or no limit)
+ The maximum number of bytes of memory allowed both for:
+
+ * (virtual) address space bytes
+
+ * resident set size
+
Added: spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Reuse.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Reuse.html?rev=1841017&view=auto
==============================================================================
--- spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Reuse.html (added)
+++ spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Reuse.html Sun Sep 16 14:36:10 2018
@@ -0,0 +1,43 @@
+<?xml version="1.0" ?>
+<!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></title>
+<meta http-equiv="content-type" content="text/html; charset=utf-8" />
+<link rev="made" href="mailto:root@localhost" />
+</head>
+
+<body style="background-color: white">
+
+
+
+<ul id="index">
+ <li><a href="#NAME">NAME</a></li>
+ <li><a href="#SYNOPSIS">SYNOPSIS</a></li>
+ <li><a href="#DESCRIPTION">DESCRIPTION</a></li>
+</ul>
+
+<h1 id="NAME">NAME</h1>
+
+<p>Mail::SpamAssassin::Plugin::Reuse - For reusing old rule hits during a mass-check</p>
+
+<h1 id="SYNOPSIS">SYNOPSIS</h1>
+
+<pre><code> loadplugin Mail::SpamAssassin::Plugin::Reuse
+
+ ifplugin Mail::SpamAssassin::Plugin::Reuse
+
+ reuse NETWORK_RULE [ NETWORK_RULE_OLD_NAME ]
+
+ endif</code></pre>
+
+<h1 id="DESCRIPTION">DESCRIPTION</h1>
+
+<p>The purpose of this plugin is to work in conjunction with <b>mass-check --reuse</b> to map rules hit in input messages to rule hits in the mass-check output.</p>
+
+
+</body>
+
+</html>
+
+
Added: spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Reuse.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Reuse.txt?rev=1841017&view=auto
==============================================================================
--- spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Reuse.txt (added)
+++ spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Reuse.txt Sun Sep 16 14:36:10 2018
@@ -0,0 +1,18 @@
+NAME
+ Mail::SpamAssassin::Plugin::Reuse - For reusing old rule hits during a
+ mass-check
+
+SYNOPSIS
+ loadplugin Mail::SpamAssassin::Plugin::Reuse
+
+ ifplugin Mail::SpamAssassin::Plugin::Reuse
+
+ reuse NETWORK_RULE [ NETWORK_RULE_OLD_NAME ]
+
+ endif
+
+DESCRIPTION
+ The purpose of this plugin is to work in conjunction with mass-check
+ --reuse to map rules hit in input messages to rule hits in the
+ mass-check output.
+
Added: spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Rule2XSBody.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Rule2XSBody.html?rev=1841017&view=auto
==============================================================================
--- spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Rule2XSBody.html (added)
+++ spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Rule2XSBody.html Sun Sep 16 14:36:10 2018
@@ -0,0 +1,39 @@
+<?xml version="1.0" ?>
+<!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></title>
+<meta http-equiv="content-type" content="text/html; charset=utf-8" />
+<link rev="made" href="mailto:root@localhost" />
+</head>
+
+<body style="background-color: white">
+
+
+
+<ul id="index">
+ <li><a href="#NAME">NAME</a></li>
+ <li><a href="#SYNOPSIS">SYNOPSIS</a></li>
+ <li><a href="#DESCRIPTION">DESCRIPTION</a></li>
+</ul>
+
+<h1 id="NAME">NAME</h1>
+
+<p>Mail::SpamAssassin::Plugin::Rule2XSBody - speed up SpamAssassin by compiling regexps</p>
+
+<h1 id="SYNOPSIS">SYNOPSIS</h1>
+
+<pre><code> loadplugin Mail::SpamAssassin::Plugin::Rule2XSBody</code></pre>
+
+<h1 id="DESCRIPTION">DESCRIPTION</h1>
+
+<p>This plugin will use native-code object files representing the ruleset, in order to provide significant speedups in rule evaluation.</p>
+
+<p>Note that <code>sa-compile</code> must be run in advance, in order to compile the ruleset using <code>re2c</code> and the C compiler. See the <code>sa-compile</code> documentation for more details.</p>
+
+
+</body>
+
+</html>
+
+
Added: spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Rule2XSBody.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Rule2XSBody.txt?rev=1841017&view=auto
==============================================================================
--- spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Rule2XSBody.txt (added)
+++ spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Rule2XSBody.txt Sun Sep 16 14:36:10 2018
@@ -0,0 +1,15 @@
+NAME
+ Mail::SpamAssassin::Plugin::Rule2XSBody - speed up SpamAssassin by
+ compiling regexps
+
+SYNOPSIS
+ loadplugin Mail::SpamAssassin::Plugin::Rule2XSBody
+
+DESCRIPTION
+ This plugin will use native-code object files representing the ruleset,
+ in order to provide significant speedups in rule evaluation.
+
+ Note that "sa-compile" must be run in advance, in order to compile the
+ ruleset using "re2c" and the C compiler. See the "sa-compile"
+ documentation for more details.
+
Added: spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_SPF.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_SPF.html?rev=1841017&view=auto
==============================================================================
--- spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_SPF.html (added)
+++ spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_SPF.html Sun Sep 16 14:36:10 2018
@@ -0,0 +1,118 @@
+<?xml version="1.0" ?>
+<!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></title>
+<meta http-equiv="content-type" content="text/html; charset=utf-8" />
+<link rev="made" href="mailto:root@localhost" />
+</head>
+
+<body style="background-color: white">
+
+
+
+<ul id="index">
+ <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-SETTINGS">USER SETTINGS</a></li>
+ <li><a href="#ADMINISTRATOR-OPTIONS">ADMINISTRATOR OPTIONS</a></li>
+</ul>
+
+<h1 id="NAME">NAME</h1>
+
+<p>Mail::SpamAssassin::Plugin::SPF - perform SPF verification tests</p>
+
+<h1 id="SYNOPSIS">SYNOPSIS</h1>
+
+<pre><code> loadplugin Mail::SpamAssassin::Plugin::SPF</code></pre>
+
+<h1 id="DESCRIPTION">DESCRIPTION</h1>
+
+<p>This plugin checks a message against Sender Policy Framework (SPF) records published by the domain owners in DNS to fight email address forgery and make it easier to identify spams.</p>
+
+<h1 id="USER-SETTINGS">USER SETTINGS</h1>
+
+<dl>
+
+<dt id="whitelist_from_spf-user-example.com">whitelist_from_spf user@example.com</dt>
+<dd>
+
+<p>Works similarly to whitelist_from, except that in addition to matching a sender address, a check against the domain's SPF record must pass. The first parameter is an address to whitelist, and the second is a string to match the relay's rDNS.</p>
+
+<p>Just like whitelist_from, multiple addresses per line, separated by spaces, are OK. Multiple <code>whitelist_from_spf</code> lines are also OK.</p>
+
+<p>The headers checked for whitelist_from_spf addresses are the same headers used for SPF checks (Envelope-From, Return-Path, X-Envelope-From, etc).</p>
+
+<p>Since this whitelist requires an SPF check to be made, network tests must be enabled. It is also required that your trust path be correctly configured. See the section on <code>trusted_networks</code> for more info on trust paths.</p>
+
+<p>e.g.</p>
+
+<pre><code> whitelist_from_spf joe@example.com fred@example.com
+ whitelist_from_spf *@example.com</code></pre>
+
+</dd>
+<dt id="def_whitelist_from_spf-user-example.com">def_whitelist_from_spf user@example.com</dt>
+<dd>
+
+<p>Same as <code>whitelist_from_spf</code>, but used for the default whitelist entries in the SpamAssassin distribution. The whitelist score is lower, because these are often targets for spammer spoofing.</p>
+
+</dd>
+</dl>
+
+<h1 id="ADMINISTRATOR-OPTIONS">ADMINISTRATOR OPTIONS</h1>
+
+<dl>
+
+<dt id="spf_timeout-n-default:-5">spf_timeout n (default: 5)</dt>
+<dd>
+
+<p>How many seconds to wait for an SPF query to complete, before scanning continues without the SPF result. A numeric value is optionally suffixed by a time unit (s, m, h, d, w, indicating seconds (default), minutes, hours, days, weeks).</p>
+
+</dd>
+<dt id="do_not_use_mail_spf-0-1-default:-0">do_not_use_mail_spf (0|1) (default: 0)</dt>
+<dd>
+
+<p>By default the plugin will try to use the Mail::SPF module for SPF checks if it can be loaded. If Mail::SPF cannot be used the plugin will fall back to using the legacy Mail::SPF::Query module if it can be loaded.</p>
+
+<p>Use this option to stop the plugin from using Mail::SPF and cause it to try to use Mail::SPF::Query instead.</p>
+
+</dd>
+<dt id="do_not_use_mail_spf_query-0-1-default:-0">do_not_use_mail_spf_query (0|1) (default: 0)</dt>
+<dd>
+
+<p>As above, but instead stop the plugin from trying to use Mail::SPF::Query and cause it to only try to use Mail::SPF.</p>
+
+</dd>
+<dt id="ignore_received_spf_header-0-1-default:-0">ignore_received_spf_header (0|1) (default: 0)</dt>
+<dd>
+
+<p>By default, to avoid unnecessary DNS lookups, the plugin will try to use the SPF results found in any <code>Received-SPF</code> headers it finds in the message that could only have been added by an internal relay.</p>
+
+<p>Set this option to 1 to ignore any <code>Received-SPF</code> headers present and to have the plugin perform the SPF check itself.</p>
+
+<p>Note that unless the plugin finds an <code>identity=helo</code>, or some unsupported identity, it will assume that the result is a mfrom SPF check result. The only identities supported are <code>mfrom</code>, <code>mailfrom</code> and <code>helo</code>.</p>
+
+</dd>
+<dt id="use_newest_received_spf_header-0-1-default:-0">use_newest_received_spf_header (0|1) (default: 0)</dt>
+<dd>
+
+<p>By default, when using <code>Received-SPF</code> headers, the plugin will attempt to use the oldest (bottom most) <code>Received-SPF</code> headers, that were added by internal relays, that it can parse results from since they are the most likely to be accurate. This is done so that if you have an incoming mail setup where one of your primary MXes doesn't know about a secondary MX (or your MXes don't know about some sort of forwarding relay that SA considers trusted+internal) but SA is aware of the actual domain boundary (internal_networks setting) SA will use the results that are most accurate.</p>
+
+<p>Use this option to start with the newest (top most) <code>Received-SPF</code> headers, working downwards until results are successfully parsed.</p>
+
+</dd>
+<dt id="has_check_for_spf_errors">has_check_for_spf_errors</dt>
+<dd>
+
+<p>Adds capability check for "if can()" for check_for_spf_permerror, check_for_spf_temperror, check_for_spf_helo_permerror and check_for_spf_helo_permerror</p>
+
+</dd>
+</dl>
+
+
+</body>
+
+</html>
+
+
Added: spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_SPF.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_SPF.txt?rev=1841017&view=auto
==============================================================================
--- spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_SPF.txt (added)
+++ spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_SPF.txt Sun Sep 16 14:36:10 2018
@@ -0,0 +1,92 @@
+NAME
+ Mail::SpamAssassin::Plugin::SPF - perform SPF verification tests
+
+SYNOPSIS
+ loadplugin Mail::SpamAssassin::Plugin::SPF
+
+DESCRIPTION
+ This plugin checks a message against Sender Policy Framework (SPF)
+ records published by the domain owners in DNS to fight email address
+ forgery and make it easier to identify spams.
+
+USER SETTINGS
+ whitelist_from_spf user@example.com
+ Works similarly to whitelist_from, except that in addition to
+ matching a sender address, a check against the domain's SPF record
+ must pass. The first parameter is an address to whitelist, and the
+ second is a string to match the relay's rDNS.
+
+ Just like whitelist_from, multiple addresses per line, separated by
+ spaces, are OK. Multiple "whitelist_from_spf" lines are also OK.
+
+ The headers checked for whitelist_from_spf addresses are the same
+ headers used for SPF checks (Envelope-From, Return-Path,
+ X-Envelope-From, etc).
+
+ Since this whitelist requires an SPF check to be made, network tests
+ must be enabled. It is also required that your trust path be
+ correctly configured. See the section on "trusted_networks" for more
+ info on trust paths.
+
+ e.g.
+
+ whitelist_from_spf joe@example.com fred@example.com
+ whitelist_from_spf *@example.com
+
+ def_whitelist_from_spf user@example.com
+ Same as "whitelist_from_spf", but used for the default whitelist
+ entries in the SpamAssassin distribution. The whitelist score is
+ lower, because these are often targets for spammer spoofing.
+
+ADMINISTRATOR OPTIONS
+ spf_timeout n (default: 5)
+ How many seconds to wait for an SPF query to complete, before
+ scanning continues without the SPF result. A numeric value is
+ optionally suffixed by a time unit (s, m, h, d, w, indicating
+ seconds (default), minutes, hours, days, weeks).
+
+ do_not_use_mail_spf (0|1) (default: 0)
+ By default the plugin will try to use the Mail::SPF module for SPF
+ checks if it can be loaded. If Mail::SPF cannot be used the plugin
+ will fall back to using the legacy Mail::SPF::Query module if it can
+ be loaded.
+
+ Use this option to stop the plugin from using Mail::SPF and cause it
+ to try to use Mail::SPF::Query instead.
+
+ do_not_use_mail_spf_query (0|1) (default: 0)
+ As above, but instead stop the plugin from trying to use
+ Mail::SPF::Query and cause it to only try to use Mail::SPF.
+
+ ignore_received_spf_header (0|1) (default: 0)
+ By default, to avoid unnecessary DNS lookups, the plugin will try to
+ use the SPF results found in any "Received-SPF" headers it finds in
+ the message that could only have been added by an internal relay.
+
+ Set this option to 1 to ignore any "Received-SPF" headers present
+ and to have the plugin perform the SPF check itself.
+
+ Note that unless the plugin finds an "identity=helo", or some
+ unsupported identity, it will assume that the result is a mfrom SPF
+ check result. The only identities supported are "mfrom", "mailfrom"
+ and "helo".
+
+ use_newest_received_spf_header (0|1) (default: 0)
+ By default, when using "Received-SPF" headers, the plugin will
+ attempt to use the oldest (bottom most) "Received-SPF" headers, that
+ were added by internal relays, that it can parse results from since
+ they are the most likely to be accurate. This is done so that if you
+ have an incoming mail setup where one of your primary MXes doesn't
+ know about a secondary MX (or your MXes don't know about some sort
+ of forwarding relay that SA considers trusted+internal) but SA is
+ aware of the actual domain boundary (internal_networks setting) SA
+ will use the results that are most accurate.
+
+ Use this option to start with the newest (top most) "Received-SPF"
+ headers, working downwards until results are successfully parsed.
+
+ has_check_for_spf_errors
+ Adds capability check for "if can()" for check_for_spf_permerror,
+ check_for_spf_temperror, check_for_spf_helo_permerror and
+ check_for_spf_helo_permerror
+
Added: spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Shortcircuit.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Shortcircuit.html?rev=1841017&view=auto
==============================================================================
--- spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Shortcircuit.html (added)
+++ spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Shortcircuit.html Sun Sep 16 14:36:10 2018
@@ -0,0 +1,134 @@
+<?xml version="1.0" ?>
+<!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></title>
+<meta http-equiv="content-type" content="text/html; charset=utf-8" />
+<link rev="made" href="mailto:root@localhost" />
+</head>
+
+<body style="background-color: white">
+
+
+
+<ul id="index">
+ <li><a href="#NAME">NAME</a></li>
+ <li><a href="#SYNOPSIS">SYNOPSIS</a></li>
+ <li><a href="#DESCRIPTION">DESCRIPTION</a></li>
+ <li><a href="#CONFIGURATION-SETTINGS">CONFIGURATION SETTINGS</a></li>
+ <li><a href="#TAGS">TAGS</a></li>
+ <li><a href="#SEE-ALSO">SEE ALSO</a></li>
+</ul>
+
+<h1 id="NAME">NAME</h1>
+
+<p>Mail::SpamAssassin::Plugin::Shortcircuit - short-circuit evaluation for certain rules</p>
+
+<h1 id="SYNOPSIS">SYNOPSIS</h1>
+
+<pre><code> loadplugin Mail::SpamAssassin::Plugin::Shortcircuit
+
+ report Content analysis details: (_SCORE_ points, _REQD_ required, s/c _SCTYPE_)
+
+ add_header all Status "_YESNO_, score=_SCORE_ required=_REQD_ tests=_TESTS_ shortcircuit=_SCTYPE_ autolearn=_AUTOLEARN_ version=_VERSION_"</code></pre>
+
+<h1 id="DESCRIPTION">DESCRIPTION</h1>
+
+<p>This plugin implements simple, test-based shortcircuiting. Shortcircuiting a test will force all other pending rules to be skipped, if that test is hit. In addition, a symbolic rule, <code>SHORTCIRCUIT</code>, will fire.</p>
+
+<p>Recomended usage is to use <code>priority</code> to set rules with strong S/O values (ie. 1.0) to be run first, and make instant spam or ham classification based on that.</p>
+
+<h1 id="CONFIGURATION-SETTINGS">CONFIGURATION SETTINGS</h1>
+
+<p>The following configuration settings are used to control shortcircuiting:</p>
+
+<dl>
+
+<dt id="shortcircuit-SYMBOLIC_TEST_NAME-ham-spam-on-off">shortcircuit SYMBOLIC_TEST_NAME {ham|spam|on|off}</dt>
+<dd>
+
+<p>Shortcircuiting a test will force all other pending rules to be skipped, if that test is hit.</p>
+
+<p>Recomended usage is to use <code>priority</code> to set rules with strong S/O values (ie. 1.0) to be run first, and make instant spam or ham classification based on that.</p>
+
+<p>To override a test that uses shortcircuiting, you can set the classification type to <code>off</code>.</p>
+
+<dl>
+
+<dt id="on">on</dt>
+<dd>
+
+<p>Shortcircuits the rest of the tests, but does not make a strict classification of spam or ham. Rather, it uses the default score for the rule being shortcircuited. This would allow you, for example, to define a rule such as</p>
+
+<pre><code> body TEST /test/
+ describe TEST test rule that scores barely over spam threshold
+ score TEST 5.5
+ priority TEST -100
+ shortcircuit TEST on</code></pre>
+
+<p>The result of a message hitting the above rule would be a final score of 5.5, as opposed to 100 (default) if it were classified as spam.</p>
+
+</dd>
+<dt id="off">off</dt>
+<dd>
+
+<p>Disables shortcircuiting on said rule.</p>
+
+</dd>
+<dt id="spam">spam</dt>
+<dd>
+
+<p>Shortcircuit the rule using a set of defaults; override the default score of this rule with the score from <code>shortcircuit_spam_score</code>, set the <code>noautolearn</code> tflag, and set priority to <code>-100</code>. In other words, equivalent to:</p>
+
+<pre><code> shortcircuit TEST on
+ priority TEST -100
+ score TEST 100
+ tflags TEST noautolearn</code></pre>
+
+</dd>
+<dt id="ham">ham</dt>
+<dd>
+
+<p>Shortcircuit the rule using a set of defaults; override the default score of this rule with the score from <code>shortcircuit_ham_score</code>, set the <code>noautolearn</code> and <code>nice</code> tflags, and set priority to <code>-100</code>. In other words, equivalent to:</p>
+
+<pre><code> shortcircuit TEST on
+ priority TEST -100
+ score TEST -100
+ tflags TEST noautolearn nice</code></pre>
+
+</dd>
+</dl>
+
+</dd>
+<dt id="shortcircuit_spam_score-n.nn-default:-100">shortcircuit_spam_score n.nn (default: 100)</dt>
+<dd>
+
+<p>When shortcircuit is used on a rule, and the shortcircuit classification type is set to <code>spam</code>, this value should be applied in place of the default score for that rule.</p>
+
+</dd>
+<dt id="shortcircuit_ham_score-n.nn-default:--100">shortcircuit_ham_score n.nn (default: -100)</dt>
+<dd>
+
+<p>When shortcircuit is used on a rule, and the shortcircuit classification type is set to <code>ham</code>, this value should be applied in place of the default score for that rule.</p>
+
+</dd>
+</dl>
+
+<h1 id="TAGS">TAGS</h1>
+
+<p>The following tags are added to the set available for use in reports, headers etc.:</p>
+
+<pre><code> _SC_ shortcircuit status (classification and rule name)
+ _SCRULE_ rulename that caused the shortcircuit
+ _SCTYPE_ shortcircuit classification ("spam", "ham", "default", "none")</code></pre>
+
+<h1 id="SEE-ALSO">SEE ALSO</h1>
+
+<p><code>http://issues.apache.org/SpamAssassin/show_bug.cgi?id=3109</code></p>
+
+
+</body>
+
+</html>
+
+
Added: spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Shortcircuit.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Shortcircuit.txt?rev=1841017&view=auto
==============================================================================
--- spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Shortcircuit.txt (added)
+++ spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Shortcircuit.txt Sun Sep 16 14:36:10 2018
@@ -0,0 +1,95 @@
+NAME
+ Mail::SpamAssassin::Plugin::Shortcircuit - short-circuit evaluation for
+ certain rules
+
+SYNOPSIS
+ loadplugin Mail::SpamAssassin::Plugin::Shortcircuit
+
+ report Content analysis details: (_SCORE_ points, _REQD_ required, s/c _SCTYPE_)
+
+ add_header all Status "_YESNO_, score=_SCORE_ required=_REQD_ tests=_TESTS_ shortcircuit=_SCTYPE_ autolearn=_AUTOLEARN_ version=_VERSION_"
+
+DESCRIPTION
+ This plugin implements simple, test-based shortcircuiting.
+ Shortcircuiting a test will force all other pending rules to be skipped,
+ if that test is hit. In addition, a symbolic rule, "SHORTCIRCUIT", will
+ fire.
+
+ Recomended usage is to use "priority" to set rules with strong S/O
+ values (ie. 1.0) to be run first, and make instant spam or ham
+ classification based on that.
+
+CONFIGURATION SETTINGS
+ The following configuration settings are used to control
+ shortcircuiting:
+
+ shortcircuit SYMBOLIC_TEST_NAME {ham|spam|on|off}
+ Shortcircuiting a test will force all other pending rules to be
+ skipped, if that test is hit.
+
+ Recomended usage is to use "priority" to set rules with strong S/O
+ values (ie. 1.0) to be run first, and make instant spam or ham
+ classification based on that.
+
+ To override a test that uses shortcircuiting, you can set the
+ classification type to "off".
+
+ on Shortcircuits the rest of the tests, but does not make a strict
+ classification of spam or ham. Rather, it uses the default score
+ for the rule being shortcircuited. This would allow you, for
+ example, to define a rule such as
+
+ body TEST /test/
+ describe TEST test rule that scores barely over spam threshold
+ score TEST 5.5
+ priority TEST -100
+ shortcircuit TEST on
+
+ The result of a message hitting the above rule would be a final
+ score of 5.5, as opposed to 100 (default) if it were classified
+ as spam.
+
+ off Disables shortcircuiting on said rule.
+
+ spam
+ Shortcircuit the rule using a set of defaults; override the
+ default score of this rule with the score from
+ "shortcircuit_spam_score", set the "noautolearn" tflag, and set
+ priority to -100. In other words, equivalent to:
+
+ shortcircuit TEST on
+ priority TEST -100
+ score TEST 100
+ tflags TEST noautolearn
+
+ ham Shortcircuit the rule using a set of defaults; override the
+ default score of this rule with the score from
+ "shortcircuit_ham_score", set the "noautolearn" and "nice"
+ tflags, and set priority to -100. In other words, equivalent to:
+
+ shortcircuit TEST on
+ priority TEST -100
+ score TEST -100
+ tflags TEST noautolearn nice
+
+ shortcircuit_spam_score n.nn (default: 100)
+ When shortcircuit is used on a rule, and the shortcircuit
+ classification type is set to "spam", this value should be applied
+ in place of the default score for that rule.
+
+ shortcircuit_ham_score n.nn (default: -100)
+ When shortcircuit is used on a rule, and the shortcircuit
+ classification type is set to "ham", this value should be applied in
+ place of the default score for that rule.
+
+TAGS
+ The following tags are added to the set available for use in reports,
+ headers etc.:
+
+ _SC_ shortcircuit status (classification and rule name)
+ _SCRULE_ rulename that caused the shortcircuit
+ _SCTYPE_ shortcircuit classification ("spam", "ham", "default", "none")
+
+SEE ALSO
+ "http://issues.apache.org/SpamAssassin/show_bug.cgi?id=3109"
+
Added: spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_SpamCop.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_SpamCop.html?rev=1841017&view=auto
==============================================================================
--- spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_SpamCop.html (added)
+++ spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_SpamCop.html Sun Sep 16 14:36:10 2018
@@ -0,0 +1,66 @@
+<?xml version="1.0" ?>
+<!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></title>
+<meta http-equiv="content-type" content="text/html; charset=utf-8" />
+<link rev="made" href="mailto:root@localhost" />
+</head>
+
+<body style="background-color: white">
+
+
+
+<ul id="index">
+ <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-OPTIONS">USER OPTIONS</a></li>
+</ul>
+
+<h1 id="NAME">NAME</h1>
+
+<p>Mail::SpamAssassin::Plugin::SpamCop - perform SpamCop reporting of messages</p>
+
+<h1 id="SYNOPSIS">SYNOPSIS</h1>
+
+<pre><code> loadplugin Mail::SpamAssassin::Plugin::SpamCop</code></pre>
+
+<h1 id="DESCRIPTION">DESCRIPTION</h1>
+
+<p>SpamCop is a service for reporting spam. SpamCop determines the origin of unwanted email and reports it to the relevant Internet service providers. By reporting spam, you have a positive impact on the problem. Reporting unsolicited email also helps feed spam filtering systems, including, but not limited to, the SpamCop blacklist used in SpamAssassin as a DNSBL.</p>
+
+<p>Note that spam reports sent by this plugin to SpamCop each include the entire spam message.</p>
+
+<p>See http://www.spamcop.net/ for more information about SpamCop.</p>
+
+<h1 id="USER-OPTIONS">USER OPTIONS</h1>
+
+<dl>
+
+<dt id="spamcop_from_address-user-example.com-default:-none">spamcop_from_address user@example.com (default: none)</dt>
+<dd>
+
+<p>This address is used during manual reports to SpamCop as the From: address. You can use your normal email address. If this is not set, a guess will be used as the From: address in SpamCop reports.</p>
+
+</dd>
+<dt id="spamcop_to_address-user-example.com-default:-generic-reporting-address">spamcop_to_address user@example.com (default: generic reporting address)</dt>
+<dd>
+
+<p>Your customized SpamCop report submission address. You need to obtain this address by registering at <code>http://www.spamcop.net/</code>. If this is not set, SpamCop reports will go to a generic reporting address for SpamAssassin users and your reports will probably have less weight in the SpamCop system.</p>
+
+</dd>
+<dt id="spamcop_max_report_size-default:-50">spamcop_max_report_size (default: 50)</dt>
+<dd>
+
+<p>Messages larger than this size (in kilobytes) will be truncated in report messages sent to SpamCop. The default setting is the maximum size that SpamCop will accept at the time of release.</p>
+
+</dd>
+</dl>
+
+
+</body>
+
+</html>
+
+
Added: spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_SpamCop.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_SpamCop.txt?rev=1841017&view=auto
==============================================================================
--- spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_SpamCop.txt (added)
+++ spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_SpamCop.txt Sun Sep 16 14:36:10 2018
@@ -0,0 +1,38 @@
+NAME
+ Mail::SpamAssassin::Plugin::SpamCop - perform SpamCop reporting of
+ messages
+
+SYNOPSIS
+ loadplugin Mail::SpamAssassin::Plugin::SpamCop
+
+DESCRIPTION
+ SpamCop is a service for reporting spam. SpamCop determines the origin
+ of unwanted email and reports it to the relevant Internet service
+ providers. By reporting spam, you have a positive impact on the problem.
+ Reporting unsolicited email also helps feed spam filtering systems,
+ including, but not limited to, the SpamCop blacklist used in
+ SpamAssassin as a DNSBL.
+
+ Note that spam reports sent by this plugin to SpamCop each include the
+ entire spam message.
+
+ See http://www.spamcop.net/ for more information about SpamCop.
+
+USER OPTIONS
+ spamcop_from_address user@example.com (default: none)
+ This address is used during manual reports to SpamCop as the From:
+ address. You can use your normal email address. If this is not set,
+ a guess will be used as the From: address in SpamCop reports.
+
+ spamcop_to_address user@example.com (default: generic reporting address)
+ Your customized SpamCop report submission address. You need to
+ obtain this address by registering at "http://www.spamcop.net/". If
+ this is not set, SpamCop reports will go to a generic reporting
+ address for SpamAssassin users and your reports will probably have
+ less weight in the SpamCop system.
+
+ spamcop_max_report_size (default: 50)
+ Messages larger than this size (in kilobytes) will be truncated in
+ report messages sent to SpamCop. The default setting is the maximum
+ size that SpamCop will accept at the time of release.
+
Added: spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Test.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Test.html?rev=1841017&view=auto
==============================================================================
--- spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Test.html (added)
+++ spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Test.html Sun Sep 16 14:36:10 2018
@@ -0,0 +1,38 @@
+<?xml version="1.0" ?>
+<!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></title>
+<meta http-equiv="content-type" content="text/html; charset=utf-8" />
+<link rev="made" href="mailto:root@localhost" />
+</head>
+
+<body style="background-color: white">
+
+
+
+<ul id="index">
+ <li><a href="#NAME">NAME</a></li>
+ <li><a href="#SYNOPSIS">SYNOPSIS</a></li>
+ <li><a href="#DESCRIPTION">DESCRIPTION</a></li>
+</ul>
+
+<h1 id="NAME">NAME</h1>
+
+<p>Test - test plugin</p>
+
+<h1 id="SYNOPSIS">SYNOPSIS</h1>
+
+<pre><code> loadplugin Mail::SpamAssassin::Plugin::Test
+ header MY_TEST_PLUGIN eval:check_test_plugin()</code></pre>
+
+<h1 id="DESCRIPTION">DESCRIPTION</h1>
+
+<p>To try this plugin, write the above two lines in the synopsis to <code>/etc/mail/spamassassin/plugintest.cf</code>.</p>
+
+
+</body>
+
+</html>
+
+
Added: spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Test.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Test.txt?rev=1841017&view=auto
==============================================================================
--- spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Test.txt (added)
+++ spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_Test.txt Sun Sep 16 14:36:10 2018
@@ -0,0 +1,11 @@
+NAME
+ Test - test plugin
+
+SYNOPSIS
+ loadplugin Mail::SpamAssassin::Plugin::Test
+ header MY_TEST_PLUGIN eval:check_test_plugin()
+
+DESCRIPTION
+ To try this plugin, write the above two lines in the synopsis to
+ "/etc/mail/spamassassin/plugintest.cf".
+
Added: spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_TextCat.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_TextCat.html?rev=1841017&view=auto
==============================================================================
--- spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_TextCat.html (added)
+++ spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_TextCat.html Sun Sep 16 14:36:10 2018
@@ -0,0 +1,394 @@
+<?xml version="1.0" ?>
+<!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></title>
+<meta http-equiv="content-type" content="text/html; charset=utf-8" />
+<link rev="made" href="mailto:root@localhost" />
+</head>
+
+<body style="background-color: white">
+
+
+
+<ul id="index">
+ <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-OPTIONS">USER OPTIONS</a></li>
+</ul>
+
+<h1 id="NAME">NAME</h1>
+
+<p>Mail::SpamAssassin::Plugin::TextCat - TextCat language guesser</p>
+
+<h1 id="SYNOPSIS">SYNOPSIS</h1>
+
+<pre><code> loadplugin Mail::SpamAssassin::Plugin::TextCat</code></pre>
+
+<h1 id="DESCRIPTION">DESCRIPTION</h1>
+
+<p>This plugin will try to guess the language used in the message body text.</p>
+
+<p>You can use the "ok_languages" directive to set which languages are considered okay for incoming mail and if the guessed language is not okay, <code>UNWANTED_LANGUAGE_BODY</code> is triggered.</p>
+
+<p>It will always add the results to a "X-Language" name-value pair in the message metadata data structure. This may be useful as Bayes tokens and can also be used in rules for scoring. The results can also be added to marked-up messages using "add_header", with the _LANGUAGES_ tag. See <a>Mail::SpamAssassin::Conf</a> for details.</p>
+
+<p>Note: the language cannot always be recognized with sufficient confidence. In that case, no action is taken.</p>
+
+<p>You can use _TEXTCATRESULTS_ tag to view the internal ngram-scoring, it might help fine-tuning settings.</p>
+
+<h1 id="USER-OPTIONS">USER OPTIONS</h1>
+
+<dl>
+
+<dt id="ok_languages-xx-yy-zz-...-default:-all">ok_languages xx [ yy zz ... ] (default: all)</dt>
+<dd>
+
+<p>This option is used to specify which languages are considered okay for incoming mail. SpamAssassin will try to detect the language used in the message body text.</p>
+
+<p>Note that the language cannot always be recognized with sufficient confidence. In that case, no action is taken.</p>
+
+<p>The rule <code>UNWANTED_LANGUAGE_BODY</code> is triggered if none of the languages detected are in the "ok" list. Note that this is the only effect of the "ok" list. It does not act as a whitelist against any other form of spam scanning.</p>
+
+<p>In your configuration, you must use the two or three letter language specifier in lowercase, not the English name for the language. You may also specify <code>all</code> if a desired language is not listed, or if you want to allow any language. The default setting is <code>all</code>.</p>
+
+<p>Examples:</p>
+
+<pre><code> ok_languages all (allow all languages)
+ ok_languages en (only allow English)
+ ok_languages en ja zh (allow English, Japanese, and Chinese)</code></pre>
+
+<p>Note: if there are multiple ok_languages lines, only the last one is used.</p>
+
+<p>Select the languages to allow from the list below:</p>
+
+<dl>
+
+<dt id="af---Afrikaans">af - Afrikaans</dt>
+<dd>
+
+</dd>
+<dt id="am---Amharic">am - Amharic</dt>
+<dd>
+
+</dd>
+<dt id="ar---Arabic">ar - Arabic</dt>
+<dd>
+
+</dd>
+<dt id="be---Byelorussian">be - Byelorussian</dt>
+<dd>
+
+</dd>
+<dt id="bg---Bulgarian">bg - Bulgarian</dt>
+<dd>
+
+</dd>
+<dt id="bs---Bosnian">bs - Bosnian</dt>
+<dd>
+
+</dd>
+<dt id="ca---Catalan">ca - Catalan</dt>
+<dd>
+
+</dd>
+<dt id="cs---Czech">cs - Czech</dt>
+<dd>
+
+</dd>
+<dt id="cy---Welsh">cy - Welsh</dt>
+<dd>
+
+</dd>
+<dt id="da---Danish">da - Danish</dt>
+<dd>
+
+</dd>
+<dt id="de---German">de - German</dt>
+<dd>
+
+</dd>
+<dt id="el---Greek">el - Greek</dt>
+<dd>
+
+</dd>
+<dt id="en---English">en - English</dt>
+<dd>
+
+</dd>
+<dt id="eo---Esperanto">eo - Esperanto</dt>
+<dd>
+
+</dd>
+<dt id="es---Spanish">es - Spanish</dt>
+<dd>
+
+</dd>
+<dt id="et---Estonian">et - Estonian</dt>
+<dd>
+
+</dd>
+<dt id="eu---Basque">eu - Basque</dt>
+<dd>
+
+</dd>
+<dt id="fa---Persian">fa - Persian</dt>
+<dd>
+
+</dd>
+<dt id="fi---Finnish">fi - Finnish</dt>
+<dd>
+
+</dd>
+<dt id="fr---French">fr - French</dt>
+<dd>
+
+</dd>
+<dt id="fy---Frisian">fy - Frisian</dt>
+<dd>
+
+</dd>
+<dt id="ga---Irish-Gaelic">ga - Irish Gaelic</dt>
+<dd>
+
+</dd>
+<dt id="gd---Scottish-Gaelic">gd - Scottish Gaelic</dt>
+<dd>
+
+</dd>
+<dt id="he---Hebrew">he - Hebrew</dt>
+<dd>
+
+</dd>
+<dt id="hi---Hindi">hi - Hindi</dt>
+<dd>
+
+</dd>
+<dt id="hr---Croatian">hr - Croatian</dt>
+<dd>
+
+</dd>
+<dt id="hu---Hungarian">hu - Hungarian</dt>
+<dd>
+
+</dd>
+<dt id="hy---Armenian">hy - Armenian</dt>
+<dd>
+
+</dd>
+<dt id="id---Indonesian">id - Indonesian</dt>
+<dd>
+
+</dd>
+<dt id="is---Icelandic">is - Icelandic</dt>
+<dd>
+
+</dd>
+<dt id="it---Italian">it - Italian</dt>
+<dd>
+
+</dd>
+<dt id="ja---Japanese">ja - Japanese</dt>
+<dd>
+
+</dd>
+<dt id="ka---Georgian">ka - Georgian</dt>
+<dd>
+
+</dd>
+<dt id="ko---Korean">ko - Korean</dt>
+<dd>
+
+</dd>
+<dt id="la---Latin">la - Latin</dt>
+<dd>
+
+</dd>
+<dt id="lt---Lithuanian">lt - Lithuanian</dt>
+<dd>
+
+</dd>
+<dt id="lv---Latvian">lv - Latvian</dt>
+<dd>
+
+</dd>
+<dt id="mr---Marathi">mr - Marathi</dt>
+<dd>
+
+</dd>
+<dt id="ms---Malay">ms - Malay</dt>
+<dd>
+
+</dd>
+<dt id="ne---Nepali">ne - Nepali</dt>
+<dd>
+
+</dd>
+<dt id="nl---Dutch">nl - Dutch</dt>
+<dd>
+
+</dd>
+<dt id="no---Norwegian">no - Norwegian</dt>
+<dd>
+
+</dd>
+<dt id="pl---Polish">pl - Polish</dt>
+<dd>
+
+</dd>
+<dt id="pt---Portuguese">pt - Portuguese</dt>
+<dd>
+
+</dd>
+<dt id="qu---Quechua">qu - Quechua</dt>
+<dd>
+
+</dd>
+<dt id="rm---Rhaeto-Romance">rm - Rhaeto-Romance</dt>
+<dd>
+
+</dd>
+<dt id="ro---Romanian">ro - Romanian</dt>
+<dd>
+
+</dd>
+<dt id="ru---Russian">ru - Russian</dt>
+<dd>
+
+</dd>
+<dt id="sa---Sanskrit">sa - Sanskrit</dt>
+<dd>
+
+</dd>
+<dt id="sco---Scots">sco - Scots</dt>
+<dd>
+
+</dd>
+<dt id="sk---Slovak">sk - Slovak</dt>
+<dd>
+
+</dd>
+<dt id="sl---Slovenian">sl - Slovenian</dt>
+<dd>
+
+</dd>
+<dt id="sq---Albanian">sq - Albanian</dt>
+<dd>
+
+</dd>
+<dt id="sr---Serbian">sr - Serbian</dt>
+<dd>
+
+</dd>
+<dt id="sv---Swedish">sv - Swedish</dt>
+<dd>
+
+</dd>
+<dt id="sw---Swahili">sw - Swahili</dt>
+<dd>
+
+</dd>
+<dt id="ta---Tamil">ta - Tamil</dt>
+<dd>
+
+</dd>
+<dt id="th---Thai">th - Thai</dt>
+<dd>
+
+</dd>
+<dt id="tl---Tagalog">tl - Tagalog</dt>
+<dd>
+
+</dd>
+<dt id="tr---Turkish">tr - Turkish</dt>
+<dd>
+
+</dd>
+<dt id="uk---Ukrainian">uk - Ukrainian</dt>
+<dd>
+
+</dd>
+<dt id="vi---Vietnamese">vi - Vietnamese</dt>
+<dd>
+
+</dd>
+<dt id="yi---Yiddish">yi - Yiddish</dt>
+<dd>
+
+</dd>
+<dt id="zh---Chinese-both-Traditional-and-Simplified">zh - Chinese (both Traditional and Simplified)</dt>
+<dd>
+
+</dd>
+<dt id="zh.big5---Chinese-Traditional-only">zh.big5 - Chinese (Traditional only)</dt>
+<dd>
+
+</dd>
+<dt id="zh.gb2312---Chinese-Simplified-only">zh.gb2312 - Chinese (Simplified only)</dt>
+<dd>
+
+</dd>
+</dl>
+
+<p></p>
+
+</dd>
+<dt id="inactive_languages-xx-yy-zz-...-default:-see-below">inactive_languages xx [ yy zz ... ] (default: see below)</dt>
+<dd>
+
+<p>This option is used to specify which languages will not be considered when trying to guess the language. For performance reasons, supported languages that have fewer than about 5 million speakers are disabled by default. Note that listing a language in <code>ok_languages</code> automatically enables it for that user.</p>
+
+<p>The default setting is:</p>
+
+<dl>
+
+<dt id="bs-cy-eo-et-eu-fy-ga-gd-is-la-lt-lv-rm-sa-sco-sl-yi">bs cy eo et eu fy ga gd is la lt lv rm sa sco sl yi</dt>
+<dd>
+
+</dd>
+</dl>
+
+<p>That list is Bosnian, Welsh, Esperanto, Estonian, Basque, Frisian, Irish Gaelic, Scottish Gaelic, Icelandic, Latin, Lithuanian, Latvian, Rhaeto-Romance, Sanskrit, Scots, Slovenian, and Yiddish.</p>
+
+</dd>
+<dt id="textcat_max_languages-N-default:-3">textcat_max_languages N (default: 3)</dt>
+<dd>
+
+<p>The maximum number of languages any one message can simultaneously match before its classification is considered unknown. You can try reducing this to 2 or possibly even 1 for more confident results, as it's unusual for a message to contain multiple languages.</p>
+
+<p>Read description for textcat_acceptable_score also, as these settings are closely related. Scoring affects how many languages might be matched and here we set the "false positive limit" where we think the engine can't decide what languages message really contain.</p>
+
+</dd>
+<dt id="textcat_optimal_ngrams-N-default:-0">textcat_optimal_ngrams N (default: 0)</dt>
+<dd>
+
+<p>If the number of ngrams is lower than this number then they will be removed. This can be used to speed up the program for longer inputs. For shorter inputs, this should be set to 0.</p>
+
+</dd>
+<dt id="textcat_max_ngrams-N-default:-400">textcat_max_ngrams N (default: 400)</dt>
+<dd>
+
+<p>The maximum number of ngrams that should be compared with each of the languages models (note that each of those models is used completely).</p>
+
+</dd>
+<dt id="textcat_acceptable_score-N-default:-1.02">textcat_acceptable_score N (default: 1.02)</dt>
+<dd>
+
+<p>Include any language that scores at least <code>textcat_acceptable_score</code> in the returned list of languages.</p>
+
+<p>This setting is basically a percentile range. Any language having internal ngram-score within N-percent of the best score is included into results. Larger values than 1.05 are not recommended as it can generate many false matches. A setting of 1.00 would mean a single best scoring language is always forcibly selected, but this is not recommended as then textcat_max_languages can't do its job classifying language as uncertain.</p>
+
+<p>Read the description for textcat_max_languages, as these are settings are closely related.</p>
+
+<p>You can use _TEXTCATRESULTS_ tag to view the internal ngram-scoring, it might help fine-tuning settings.</p>
+
+</dd>
+</dl>
+
+
+</body>
+
+</html>
+
+
Added: spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_TextCat.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_TextCat.txt?rev=1841017&view=auto
==============================================================================
--- spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_TextCat.txt (added)
+++ spamassassin/site/full/3.4.x/doc/Mail_SpamAssassin_Plugin_TextCat.txt Sun Sep 16 14:36:10 2018
@@ -0,0 +1,179 @@
+NAME
+ Mail::SpamAssassin::Plugin::TextCat - TextCat language guesser
+
+SYNOPSIS
+ loadplugin Mail::SpamAssassin::Plugin::TextCat
+
+DESCRIPTION
+ This plugin will try to guess the language used in the message body
+ text.
+
+ You can use the "ok_languages" directive to set which languages are
+ considered okay for incoming mail and if the guessed language is not
+ okay, "UNWANTED_LANGUAGE_BODY" is triggered.
+
+ It will always add the results to a "X-Language" name-value pair in the
+ message metadata data structure. This may be useful as Bayes tokens and
+ can also be used in rules for scoring. The results can also be added to
+ marked-up messages using "add_header", with the _LANGUAGES_ tag. See
+ Mail::SpamAssassin::Conf for details.
+
+ Note: the language cannot always be recognized with sufficient
+ confidence. In that case, no action is taken.
+
+ You can use _TEXTCATRESULTS_ tag to view the internal ngram-scoring, it
+ might help fine-tuning settings.
+
+USER OPTIONS
+ ok_languages xx [ yy zz ... ] (default: all)
+ This option is used to specify which languages are considered okay
+ for incoming mail. SpamAssassin will try to detect the language used
+ in the message body text.
+
+ Note that the language cannot always be recognized with sufficient
+ confidence. In that case, no action is taken.
+
+ The rule "UNWANTED_LANGUAGE_BODY" is triggered if none of the
+ languages detected are in the "ok" list. Note that this is the only
+ effect of the "ok" list. It does not act as a whitelist against any
+ other form of spam scanning.
+
+ In your configuration, you must use the two or three letter language
+ specifier in lowercase, not the English name for the language. You
+ may also specify "all" if a desired language is not listed, or if
+ you want to allow any language. The default setting is "all".
+
+ Examples:
+
+ ok_languages all (allow all languages)
+ ok_languages en (only allow English)
+ ok_languages en ja zh (allow English, Japanese, and Chinese)
+
+ Note: if there are multiple ok_languages lines, only the last one is
+ used.
+
+ Select the languages to allow from the list below:
+
+ af - Afrikaans
+ am - Amharic
+ ar - Arabic
+ be - Byelorussian
+ bg - Bulgarian
+ bs - Bosnian
+ ca - Catalan
+ cs - Czech
+ cy - Welsh
+ da - Danish
+ de - German
+ el - Greek
+ en - English
+ eo - Esperanto
+ es - Spanish
+ et - Estonian
+ eu - Basque
+ fa - Persian
+ fi - Finnish
+ fr - French
+ fy - Frisian
+ ga - Irish Gaelic
+ gd - Scottish Gaelic
+ he - Hebrew
+ hi - Hindi
+ hr - Croatian
+ hu - Hungarian
+ hy - Armenian
+ id - Indonesian
+ is - Icelandic
+ it - Italian
+ ja - Japanese
+ ka - Georgian
+ ko - Korean
+ la - Latin
+ lt - Lithuanian
+ lv - Latvian
+ mr - Marathi
+ ms - Malay
+ ne - Nepali
+ nl - Dutch
+ no - Norwegian
+ pl - Polish
+ pt - Portuguese
+ qu - Quechua
+ rm - Rhaeto-Romance
+ ro - Romanian
+ ru - Russian
+ sa - Sanskrit
+ sco - Scots
+ sk - Slovak
+ sl - Slovenian
+ sq - Albanian
+ sr - Serbian
+ sv - Swedish
+ sw - Swahili
+ ta - Tamil
+ th - Thai
+ tl - Tagalog
+ tr - Turkish
+ uk - Ukrainian
+ vi - Vietnamese
+ yi - Yiddish
+ zh - Chinese (both Traditional and Simplified)
+ zh.big5 - Chinese (Traditional only)
+ zh.gb2312 - Chinese (Simplified only)
+
+
+
+ inactive_languages xx [ yy zz ... ] (default: see below)
+ This option is used to specify which languages will not be
+ considered when trying to guess the language. For performance
+ reasons, supported languages that have fewer than about 5 million
+ speakers are disabled by default. Note that listing a language in
+ "ok_languages" automatically enables it for that user.
+
+ The default setting is:
+
+ bs cy eo et eu fy ga gd is la lt lv rm sa sco sl yi
+
+ That list is Bosnian, Welsh, Esperanto, Estonian, Basque, Frisian,
+ Irish Gaelic, Scottish Gaelic, Icelandic, Latin, Lithuanian,
+ Latvian, Rhaeto-Romance, Sanskrit, Scots, Slovenian, and Yiddish.
+
+ textcat_max_languages N (default: 3)
+ The maximum number of languages any one message can simultaneously
+ match before its classification is considered unknown. You can try
+ reducing this to 2 or possibly even 1 for more confident results, as
+ it's unusual for a message to contain multiple languages.
+
+ Read description for textcat_acceptable_score also, as these
+ settings are closely related. Scoring affects how many languages
+ might be matched and here we set the "false positive limit" where we
+ think the engine can't decide what languages message really contain.
+
+ textcat_optimal_ngrams N (default: 0)
+ If the number of ngrams is lower than this number then they will be
+ removed. This can be used to speed up the program for longer inputs.
+ For shorter inputs, this should be set to 0.
+
+ textcat_max_ngrams N (default: 400)
+ The maximum number of ngrams that should be compared with each of
+ the languages models (note that each of those models is used
+ completely).
+
+ textcat_acceptable_score N (default: 1.02)
+ Include any language that scores at least "textcat_acceptable_score"
+ in the returned list of languages.
+
+ This setting is basically a percentile range. Any language having
+ internal ngram-score within N-percent of the best score is included
+ into results. Larger values than 1.05 are not recommended as it can
+ generate many false matches. A setting of 1.00 would mean a single
+ best scoring language is always forcibly selected, but this is not
+ recommended as then textcat_max_languages can't do its job
+ classifying language as uncertain.
+
+ Read the description for textcat_max_languages, as these are
+ settings are closely related.
+
+ You can use _TEXTCATRESULTS_ tag to view the internal ngram-scoring,
+ it might help fine-tuning settings.
+