You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@spamassassin.apache.org by jm...@apache.org on 2010/03/19 17:21:04 UTC
svn commit: r925305 [10/14] - in /spamassassin/site/full/3.3.x: ./ doc/
Added: spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Hashcash.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Hashcash.txt?rev=925305&view=auto
==============================================================================
--- spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Hashcash.txt (added)
+++ spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Hashcash.txt Fri Mar 19 16:21:00 2010
@@ -0,0 +1,53 @@
+NAME
+ Mail::SpamAssassin::Plugin::Hashcash - perform hashcash verification
+ tests
+
+SYNOPSIS
+ loadplugin Mail::SpamAssassin::Plugin::Hashcash
+
+DESCRIPTION
+ Hashcash is a payment system for email where CPU cycles used as the
+ basis for an e-cash system. This plugin makes it possible to use valid
+ hashcash tokens added by mail programs as a bonus for messages.
+
+USER SETTINGS
+ use_hashcash { 1 | 0 } (default: 1)
+ Whether to use hashcash, if it is available.
+
+ hashcash_accept add@ress.com ...
+ Used to specify addresses that we accept HashCash tokens for. You
+ should set it to match all the addresses that you may receive mail
+ at.
+
+ Like whitelist and blacklist entries, the addresses are
+ file-glob-style patterns, so "friend@somewhere.com", "*@isp.com", or
+ "*.domain.net" will all work. Specifically, "*" and "?" are allowed,
+ but all other metacharacters are not. Regular expressions are not
+ used for security reasons.
+
+ The sequence %u is replaced with the current user's username, which
+ is useful for ISPs or multi-user domains.
+
+ Multiple addresses per line, separated by spaces, is OK. Multiple
+ "hashcash_accept" lines is also OK.
+
+ hashcash_doublespend_path /path/to/file (default:
+ ~/.spamassassin/hashcash_seen)
+ Path for HashCash double-spend database. HashCash tokens are only
+ usable once, so their use is tracked in this database to avoid
+ providing a loophole.
+
+ By default, each user has their own, in their "~/.spamassassin"
+ directory with mode 0700/0600. Note that once a token is 'spent' it
+ is written to this file, and double-spending of a hashcash token
+ makes it invalid, so this is not suitable for sharing between
+ multiple users.
+
+ hashcash_doublespend_file_mode (default: 0700)
+ The file mode bits used for the HashCash double-spend database file.
+
+ Make sure you specify this using the 'x' mode bits set, as it may
+ also be used to create directories. However, if a file is created,
+ the resulting file will not have any execute bits set (the umask is
+ set to 111).
+
Added: spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_MIMEHeader.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_MIMEHeader.html?rev=925305&view=auto
==============================================================================
--- spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_MIMEHeader.html (added)
+++ spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_MIMEHeader.html Fri Mar 19 16:21:00 2010
@@ -0,0 +1,71 @@
+<!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>MIMEHeader - perform regexp tests against MIME headers</title>
+<link rev="made" href="mailto:jm@spamassassin.zones.apache.org" />
+</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="#rule_definitions_and_privileged_settings">RULE DEFINITIONS AND PRIVILEGED SETTINGS</a></li>
+</ul>
+<!-- INDEX END -->
+
+<hr />
+<p>
+</p>
+<h1><a name="name">NAME</a></h1>
+<p>MIMEHeader - perform regexp tests against MIME headers</p>
+<p>
+</p>
+<hr />
+<h1><a name="synopsis">SYNOPSIS</a></h1>
+<pre>
+ loadplugin Mail::SpamAssassin::Plugin::MIMEHeader
+ mimeheader NAME_OF_RULE Content-Id =~ /foo/</pre>
+<p>
+</p>
+<hr />
+<h1><a name="description">DESCRIPTION</a></h1>
+<p>This plugin allows regexp rules to be written against MIME headers in the
+message.</p>
+<p>
+</p>
+<hr />
+<h1><a name="rule_definitions_and_privileged_settings">RULE DEFINITIONS AND PRIVILEGED SETTINGS</a></h1>
+<dl>
+<dt><strong><a name="item_mimeheader_name_of_rule_header_2dname__3d_7e__2fpa">mimeheader NAME_OF_RULE Header-Name =~ /pattern/modifiers</a></strong><br />
+</dt>
+<dd>
+Specify a rule. <code>NAME_OF_RULE</code> is the name of the rule to be used,
+<code>Header-Name</code> is the name of the MIME header to check, and
+<code>/pattern/modifiers</code> is the Perl regular expression to match against this.
+</dd>
+<dd>
+<p>Note that in a message of multiple parts, each header will be checked
+against the pattern separately. In other words, if multiple parts
+have a 'Content-Type' header, each header's value will be tested
+individually as a separate string.</p>
+</dd>
+<dd>
+<p>Header names are considered case-insensitive.</p>
+</dd>
+<dd>
+<p>The header values are normally cleaned up a little; for example, whitespace
+around the newline character in ``folded'' headers will be replaced with a single
+space. Append <code>:raw</code> to the header name to retrieve the raw, undecoded value,
+including pristine whitespace, instead.</p>
+</dd>
+<p></p></dl>
+
+</body>
+
+</html>
Added: spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_MIMEHeader.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_MIMEHeader.txt?rev=925305&view=auto
==============================================================================
--- spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_MIMEHeader.txt (added)
+++ spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_MIMEHeader.txt Fri Mar 19 16:21:00 2010
@@ -0,0 +1,31 @@
+NAME
+ MIMEHeader - perform regexp tests against MIME headers
+
+SYNOPSIS
+ loadplugin Mail::SpamAssassin::Plugin::MIMEHeader
+ mimeheader NAME_OF_RULE Content-Id =~ /foo/
+
+DESCRIPTION
+ This plugin allows regexp rules to be written against MIME headers in
+ the message.
+
+RULE DEFINITIONS AND PRIVILEGED SETTINGS
+ mimeheader NAME_OF_RULE Header-Name =~ /pattern/modifiers
+ Specify a rule. "NAME_OF_RULE" is the name of the rule to be used,
+ "Header-Name" is the name of the MIME header to check, and
+ "/pattern/modifiers" is the Perl regular expression to match against
+ this.
+
+ Note that in a message of multiple parts, each header will be
+ checked against the pattern separately. In other words, if multiple
+ parts have a 'Content-Type' header, each header's value will be
+ tested individually as a separate string.
+
+ Header names are considered case-insensitive.
+
+ The header values are normally cleaned up a little; for example,
+ whitespace around the newline character in "folded" headers will be
+ replaced with a single space. Append ":raw" to the header name to
+ retrieve the raw, undecoded value, including pristine whitespace,
+ instead.
+
Added: spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_NetCache.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_NetCache.html?rev=925305&view=auto
==============================================================================
--- spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_NetCache.html (added)
+++ spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_NetCache.html Fri Mar 19 16:21:00 2010
@@ -0,0 +1,48 @@
+<!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::Plugin::NetCache - store network check results in headers</title>
+<link rev="made" href="mailto:jm@spamassassin.zones.apache.org" />
+</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>
+</ul>
+<!-- INDEX END -->
+
+<hr />
+<p>
+</p>
+<h1><a name="name">NAME</a></h1>
+<p>Mail::SpamAssassin::Plugin::NetCache - store network check results in headers</p>
+<p>
+</p>
+<hr />
+<h1><a name="synopsis">SYNOPSIS</a></h1>
+<pre>
+ loadplugin Mail::SpamAssassin::Plugin::NetCache</pre>
+<p>
+</p>
+<hr />
+<h1><a name="description">DESCRIPTION</a></h1>
+<p>This is a work-in-progress experimental plugin not for general use.</p>
+<p>This plugin stores network check results in the message header. The
+idea is to store all results (positive and negative) in the headers,
+then during mass-check, pull the results out and use them for ``live''
+data to give better results during SpamAssassin score generation.</p>
+<p>This needs more plugin hooks as appropriate, needs code to put results
+in header and to pull results back out from said headers, etc.</p>
+<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.3.x/doc/Mail_SpamAssassin_Plugin_NetCache.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_NetCache.txt?rev=925305&view=auto
==============================================================================
--- spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_NetCache.txt (added)
+++ spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_NetCache.txt Fri Mar 19 16:21:00 2010
@@ -0,0 +1,21 @@
+NAME
+ Mail::SpamAssassin::Plugin::NetCache - store network check results in
+ headers
+
+SYNOPSIS
+ loadplugin Mail::SpamAssassin::Plugin::NetCache
+
+DESCRIPTION
+ This is a work-in-progress experimental plugin not for general use.
+
+ This plugin stores network check results in the message header. The idea
+ is to store all results (positive and negative) in the headers, then
+ during mass-check, pull the results out and use them for "live" data to
+ give better results during SpamAssassin score generation.
+
+ This needs more plugin hooks as appropriate, needs code to put results
+ in header and to pull results back out from said headers, etc.
+
+ To try this plugin, write the above two lines in the synopsis to
+ "/etc/mail/spamassassin/plugintest.cf".
+
Added: spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_OneLineBodyRuleType.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_OneLineBodyRuleType.html?rev=925305&view=auto
==============================================================================
--- spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_OneLineBodyRuleType.html (added)
+++ spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_OneLineBodyRuleType.html Fri Mar 19 16:21:00 2010
@@ -0,0 +1,27 @@
+<!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>lib/Mail/SpamAssassin/Plugin/OneLineBodyRuleType.pm</title>
+<link rev="made" href="mailto:jm@spamassassin.zones.apache.org" />
+</head>
+
+<body style="background-color: white">
+
+<p><a name="__index__"></a></p>
+<!-- INDEX BEGIN -->
+
+<ul>
+
+ <li><a href="#name">NAME</a></li>
+</ul>
+<!-- INDEX END -->
+
+<hr />
+<p>
+</p>
+<h1><a name="name">NAME</a></h1>
+<p>Mail::SpamAssassin::Plugin::OneLineBodyRuleType</p>
+
+</body>
+
+</html>
Added: spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_OneLineBodyRuleType.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_OneLineBodyRuleType.txt?rev=925305&view=auto
==============================================================================
--- spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_OneLineBodyRuleType.txt (added)
+++ spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_OneLineBodyRuleType.txt Fri Mar 19 16:21:00 2010
@@ -0,0 +1,3 @@
+NAME
+ Mail::SpamAssassin::Plugin::OneLineBodyRuleType
+
Added: spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_PhishTag.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_PhishTag.html?rev=925305&view=auto
==============================================================================
--- spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_PhishTag.html (added)
+++ spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_PhishTag.html Fri Mar 19 16:21:00 2010
@@ -0,0 +1,100 @@
+<!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>PhishTag - SpamAssassin plugin for redirecting links in incoming emails.</title>
+<link rev="made" href="mailto:jm@spamassassin.zones.apache.org" />
+</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="#options">OPTIONS</a></li>
+ <li><a href="#download">DOWNLOAD</a></li>
+ <li><a href="#see_also">SEE ALSO</a></li>
+ <li><a href="#author">AUTHOR</a></li>
+ <li><a href="#copyright_and_license">COPYRIGHT AND LICENSE</a></li>
+</ul>
+<!-- INDEX END -->
+
+<hr />
+<p>
+</p>
+<h1><a name="name">NAME</a></h1>
+<p>PhishTag - SpamAssassin plugin for redirecting links in incoming emails.</p>
+<p>
+</p>
+<hr />
+<h1><a name="synopsis">SYNOPSIS</a></h1>
+<pre>
+ loadplugin Mail::SpamAssassin::Plugin::PhishTag</pre>
+<pre>
+ trigger_ratio 0.1
+ trigger_target RULE_NAME <a href="http://www.antiphishing.org/consumer_recs.html">http://www.antiphishing.org/consumer_recs.html</a></pre>
+<p>
+</p>
+<hr />
+<h1><a name="description">DESCRIPTION</a></h1>
+<p>PhishTag enables administrators to rewrite links in emails that trigger certain
+tests, preferably anti-phishing blacklist tests. The plugin will inhibit the
+blocking of a portion of the emails that trigger the test by SpamAssassin, and
+let them pass to the users' inbox after the rewrite. It is useful in providing
+training to email users about company policies and general email usage.</p>
+<p>
+</p>
+<hr />
+<h1><a name="options">OPTIONS</a></h1>
+<p>The following options can be set by modifying the configuration file.</p>
+<ul>
+<li><strong><a name="item_trigger_ratio_percentage_value">trigger_ratio percentage_value</a></strong><br />
+</li>
+Sets the probability in percentage that a positive test will trigger the
+email rewrite, e.g. 0.1 will rewrite on the average 1 in 1000 emails that
+match the trigger.
+<p></p>
+<li><strong><a name="item_trigger_target_rule_name_http_url">trigger_target RULE_NAME http_url</a></strong><br />
+</li>
+The name of the test which would trigger the email rewrite; all the URLs
+will be replaced by http_url.
+<p></p></ul>
+<p>
+</p>
+<hr />
+<h1><a name="download">DOWNLOAD</a></h1>
+<p>The source of this plugin is avaliable at:
+<a href="http://umut.topkara.org/PhishTag/PhishTag.pm">http://umut.topkara.org/PhishTag/PhishTag.pm</a>
+a sample configuration file is also available:
+<a href="http://umut.topkara.org/PhishTag/PhishTag.cf">http://umut.topkara.org/PhishTag/PhishTag.cf</a></p>
+<p>
+</p>
+<hr />
+<h1><a name="see_also">SEE ALSO</a></h1>
+<p>Check the list of tests performed by SpamAssassin to modify the
+configuration file to match your needs from
+<a href="http://spamassassin.apache.org/tests.html">http://spamassassin.apache.org/tests.html</a></p>
+<p>
+</p>
+<hr />
+<h1><a name="author">AUTHOR</a></h1>
+<p>Umut Topkara, 2008, <<a href="mailto:umut@topkara.org">umut@topkara.org</a>>
+<a href="http://umut.topkara.org">http://umut.topkara.org</a></p>
+<p>
+</p>
+<hr />
+<h1><a name="copyright_and_license">COPYRIGHT AND LICENSE</a></h1>
+<p>This plugin is free software; you can redistribute it and/or modify
+it under the same terms as SpamAssassin itself, either version 3.2.4
+or, at your option, any later version of SpamAssassin you may have
+available.
+
+</p>
+
+</body>
+
+</html>
Added: spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_PhishTag.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_PhishTag.txt?rev=925305&view=auto
==============================================================================
--- spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_PhishTag.txt (added)
+++ spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_PhishTag.txt Fri Mar 19 16:21:00 2010
@@ -0,0 +1,47 @@
+NAME
+ PhishTag - SpamAssassin plugin for redirecting links in incoming emails.
+
+SYNOPSIS
+ loadplugin Mail::SpamAssassin::Plugin::PhishTag
+
+ trigger_ratio 0.1
+ trigger_target RULE_NAME http://www.antiphishing.org/consumer_recs.html
+
+DESCRIPTION
+ PhishTag enables administrators to rewrite links in emails that trigger
+ certain tests, preferably anti-phishing blacklist tests. The plugin will
+ inhibit the blocking of a portion of the emails that trigger the test by
+ SpamAssassin, and let them pass to the users' inbox after the rewrite.
+ It is useful in providing training to email users about company policies
+ and general email usage.
+
+OPTIONS
+ The following options can be set by modifying the configuration file.
+
+ * trigger_ratio percentage_value
+ Sets the probability in percentage that a positive test will trigger
+ the email rewrite, e.g. 0.1 will rewrite on the average 1 in 1000
+ emails that match the trigger.
+
+ * trigger_target RULE_NAME http_url
+ The name of the test which would trigger the email rewrite; all the
+ URLs will be replaced by http_url.
+
+DOWNLOAD
+ The source of this plugin is avaliable at:
+ http://umut.topkara.org/PhishTag/PhishTag.pm a sample configuration file
+ is also available: http://umut.topkara.org/PhishTag/PhishTag.cf
+
+SEE ALSO
+ Check the list of tests performed by SpamAssassin to modify the
+ configuration file to match your needs from
+ http://spamassassin.apache.org/tests.html
+
+AUTHOR
+ Umut Topkara, 2008, <um...@topkara.org> http://umut.topkara.org
+
+COPYRIGHT AND LICENSE
+ This plugin is free software; you can redistribute it and/or modify it
+ under the same terms as SpamAssassin itself, either version 3.2.4 or, at
+ your option, any later version of SpamAssassin you may have available.
+
Added: spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Pyzor.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Pyzor.html?rev=925305&view=auto
==============================================================================
--- spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Pyzor.html (added)
+++ spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Pyzor.html Fri Mar 19 16:21:00 2010
@@ -0,0 +1,114 @@
+<!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::Plugin::Pyzor - perform Pyzor check of messages</title>
+<link rev="made" href="mailto:jm@spamassassin.zones.apache.org" />
+</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_options">USER OPTIONS</a></li>
+ <li><a href="#administrator_options">ADMINISTRATOR OPTIONS</a></li>
+</ul>
+<!-- INDEX END -->
+
+<hr />
+<p>
+</p>
+<h1><a name="name">NAME</a></h1>
+<p>Mail::SpamAssassin::Plugin::Pyzor - perform Pyzor check of messages</p>
+<p>
+</p>
+<hr />
+<h1><a name="synopsis">SYNOPSIS</a></h1>
+<pre>
+ loadplugin Mail::SpamAssassin::Plugin::Pyzor</pre>
+<p>
+</p>
+<hr />
+<h1><a name="description">DESCRIPTION</a></h1>
+<p>Pyzor is a collaborative, networked system to detect and block spam
+using identifying digests of messages.</p>
+<p>See <a href="http://pyzor.sourceforge.net/">http://pyzor.sourceforge.net/</a> for more information about Pyzor.</p>
+<p>
+</p>
+<hr />
+<h1><a name="user_options">USER OPTIONS</a></h1>
+<dl>
+<dt><strong><a name="item_use_pyzor">use_pyzor (0|1) (default: 1)</a></strong><br />
+</dt>
+<dd>
+Whether to use Pyzor, if it is available.
+</dd>
+<p></p>
+<dt><strong><a name="item_number">pyzor_max NUMBER (default: 5)</a></strong><br />
+</dt>
+<dd>
+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>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>
+<p></p></dl>
+<p>
+</p>
+<hr />
+<h1><a name="administrator_options">ADMINISTRATOR OPTIONS</a></h1>
+<dl>
+<dt><strong><a name="item_n">pyzor_timeout n (default: 3.5)</a></strong><br />
+</dt>
+<dd>
+How many seconds you wait for Pyzor to complete, before scanning continues
+without the Pyzor results.
+</dd>
+<dd>
+<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>
+</dd>
+<dd>
+<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>
+</dd>
+<dd>
+<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>
+<p></p>
+<dt><strong><a name="item_pyzor_options_options">pyzor_options options</a></strong><br />
+</dt>
+<dd>
+Specify additional options to the <code>pyzor(1)</code> command. Please note that only
+characters in the range [0-9A-Za-z ,._/-] are allowed for security reasons.
+</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 <code>pyzor</code>
+client instead of relying on SpamAssassin to find it in the current
+PATH. Note that if <em>taint mode</em> is enabled in the Perl interpreter,
+you should use this, as the current PATH will have been cleared.
+</dd>
+<p></p></dl>
+
+</body>
+
+</html>
Added: spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Pyzor.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Pyzor.txt?rev=925305&view=auto
==============================================================================
--- spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Pyzor.txt (added)
+++ spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Pyzor.txt Fri Mar 19 16:21:00 2010
@@ -0,0 +1,57 @@
+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.sourceforge.net/ 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.
+
+ 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.3.x/doc/Mail_SpamAssassin_Plugin_Razor2.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Razor2.html?rev=925305&view=auto
==============================================================================
--- spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Razor2.html (added)
+++ spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Razor2.html Fri Mar 19 16:21:00 2010
@@ -0,0 +1,80 @@
+<!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::Plugin::Razor2 - perform Razor check of messages</title>
+<link rev="made" href="mailto:jm@spamassassin.zones.apache.org" />
+</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_settings">USER SETTINGS</a></li>
+ <li><a href="#administrator_settings">ADMINISTRATOR SETTINGS</a></li>
+</ul>
+<!-- INDEX END -->
+
+<hr />
+<p>
+</p>
+<h1><a name="name">NAME</a></h1>
+<p>Mail::SpamAssassin::Plugin::Razor2 - perform Razor check of messages</p>
+<p>
+</p>
+<hr />
+<h1><a name="synopsis">SYNOPSIS</a></h1>
+<pre>
+ loadplugin Mail::SpamAssassin::Plugin::Razor2</pre>
+<p>
+</p>
+<hr />
+<h1><a name="description">DESCRIPTION</a></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>Note that Razor2 is disabled by default in <code>init.pre</code> because it is not
+available for unlimited free use. It is currently free for personal
+use, subject to capacity constraints. See the Cloudmark SpamNet Service
+Policy for more details.</p>
+<p>See <a href="http://razor.sourceforge.net/">http://razor.sourceforge.net/</a> for more information about Razor.</p>
+<p>
+</p>
+<hr />
+<h1><a name="user_settings">USER SETTINGS</a></h1>
+<dl>
+<dt><strong><a name="item_use_razor2">use_razor2 (0|1) (default: 1)</a></strong><br />
+</dt>
+<dd>
+Whether to use Razor2, if it is available.
+</dd>
+<p></p></dl>
+<p>
+</p>
+<hr />
+<h1><a name="administrator_settings">ADMINISTRATOR SETTINGS</a></h1>
+<dl>
+<dt><strong><a name="item_n">razor_timeout n (default: 5)</a></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_razor_config_filename">razor_config filename</a></strong><br />
+</dt>
+<dd>
+Define the filename used to store Razor's configuration settings.
+Currently this is left to Razor to decide.
+</dd>
+<p></p></dl>
+
+</body>
+
+</html>
Added: spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Razor2.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Razor2.txt?rev=925305&view=auto
==============================================================================
--- spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Razor2.txt (added)
+++ spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Razor2.txt Fri Mar 19 16:21:00 2010
@@ -0,0 +1,32 @@
+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.
+
+ Note that Razor2 is disabled by default in "init.pre" because it is not
+ available for unlimited free use. It is currently free for personal use,
+ subject to capacity constraints. See the Cloudmark SpamNet Service
+ Policy for more details.
+
+ 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.3.x/doc/Mail_SpamAssassin_Plugin_RelayCountry.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_RelayCountry.html?rev=925305&view=auto
==============================================================================
--- spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_RelayCountry.html (added)
+++ spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_RelayCountry.html Fri Mar 19 16:21:00 2010
@@ -0,0 +1,49 @@
+<!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>RelayCountry - add message metadata indicating the country code of each relay</title>
+<link rev="made" href="mailto:jm@spamassassin.zones.apache.org" />
+</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="#requirement">REQUIREMENT</a></li>
+</ul>
+<!-- INDEX END -->
+
+<hr />
+<p>
+</p>
+<h1><a name="name">NAME</a></h1>
+<p>RelayCountry - add message metadata indicating the country code of each relay</p>
+<p>
+</p>
+<hr />
+<h1><a name="synopsis">SYNOPSIS</a></h1>
+<pre>
+ loadplugin Mail::SpamAssassin::Plugin::RelayCountry</pre>
+<p>
+</p>
+<hr />
+<h1><a name="description">DESCRIPTION</a></h1>
+<p>By 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>
+<p>
+</p>
+<hr />
+<h1><a name="requirement">REQUIREMENT</a></h1>
+<p>This plugin requires the IP::Country module from CPAN.</p>
+
+</body>
+
+</html>
Added: spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_RelayCountry.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_RelayCountry.txt?rev=925305&view=auto
==============================================================================
--- spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_RelayCountry.txt (added)
+++ spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_RelayCountry.txt Fri Mar 19 16:21:00 2010
@@ -0,0 +1,16 @@
+NAME
+ RelayCountry - add message metadata indicating the country code of each
+ relay
+
+SYNOPSIS
+ loadplugin Mail::SpamAssassin::Plugin::RelayCountry
+
+DESCRIPTION
+ By 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 IP::Country module from CPAN.
+
Added: spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_ReplaceTags.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_ReplaceTags.html?rev=925305&view=auto
==============================================================================
--- spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_ReplaceTags.html (added)
+++ spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_ReplaceTags.html Fri Mar 19 16:21:00 2010
@@ -0,0 +1,108 @@
+<!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::Plugin::ReplaceTags - tags for SpamAssassin rules</title>
+<link rev="made" href="mailto:jm@spamassassin.zones.apache.org" />
+</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="#rule_definitions_and_privileged_settings">RULE DEFINITIONS AND PRIVILEGED SETTINGS</a></li>
+</ul>
+<!-- INDEX END -->
+
+<hr />
+<p>
+</p>
+<h1><a name="name">NAME</a></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>
+<p>
+</p>
+<hr />
+<h1><a name="synopsis">SYNOPSIS</a></h1>
+<pre>
+ loadplugin Mail::SpamAssassin::Plugin::ReplaceTags</pre>
+<pre>
+ replace_start <
+ replace_end ></pre>
+<pre>
+ 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~_-]</pre>
+<pre>
+ body VIAGRA_OBFU /(?!viagra)<V>+<SP>*<I>+<SP>*<A>+<SP>*<G>+<SP>*<R>+<SP>*<A>+/i
+ describe VIAGRA_OBFU Attempt to obfuscate "viagra"</pre>
+<pre>
+ replace_rules VIAGRA_OBFU</pre>
+<p>
+</p>
+<hr />
+<h1><a name="rule_definitions_and_privileged_settings">RULE DEFINITIONS AND PRIVILEGED SETTINGS</a></h1>
+<dl>
+<dt><strong><a name="item_replace_tag_tagname_expression">replace_tag tagname expression</a></strong><br />
+</dt>
+<dd>
+Assign a valid regular expression to tagname.
+</dd>
+<dd>
+<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>
+<p></p>
+<dt><strong><a name="item_replace_pre_tagname_expression">replace_pre tagname expression</a></strong><br />
+</dt>
+<dd>
+Assign a valid regular expression to tagname. The expression will be
+placed before each tag that is replaced.
+</dd>
+<p></p>
+<dt><strong><a name="item_replace_inter_tagname_expression">replace_inter tagname expression</a></strong><br />
+</dt>
+<dd>
+Assign a valid regular expression to tagname. The expression will be
+placed between each two immediately adjacent tags that are replaced.
+</dd>
+<p></p>
+<dt><strong><a name="item_replace_post_tagname_expression">replace_post tagname expression</a></strong><br />
+</dt>
+<dd>
+Assign a valid regular expression to tagname. The expression will be
+placed after each tag that is replaced.
+</dd>
+<p></p>
+<dt><strong><a name="item_replace_rules_list_of_tests">replace_rules list_of_tests</a></strong><br />
+</dt>
+<dd>
+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.
+</dd>
+<p></p>
+<dt><strong><a name="item_replace_start_string">replace_start string</a></strong><br />
+</dt>
+<dt><strong><a name="item_replace_end_string">replace_end string</a></strong><br />
+</dt>
+<dd>
+<code>String(s)</code> 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.
+</dd>
+<p></p></dl>
+
+</body>
+
+</html>
Added: spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_ReplaceTags.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_ReplaceTags.txt?rev=925305&view=auto
==============================================================================
--- spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_ReplaceTags.txt (added)
+++ spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_ReplaceTags.txt Fri Mar 19 16:21:00 2010
@@ -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.3.x/doc/Mail_SpamAssassin_Plugin_Reuse.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Reuse.html?rev=925305&view=auto
==============================================================================
--- spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Reuse.html (added)
+++ spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Reuse.html Fri Mar 19 16:21:00 2010
@@ -0,0 +1,48 @@
+<!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::Plugin::Reuse - For reusing old rule hits during a mass-check</title>
+<link rev="made" href="mailto:jm@spamassassin.zones.apache.org" />
+</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>
+</ul>
+<!-- INDEX END -->
+
+<hr />
+<p>
+</p>
+<h1><a name="name">NAME</a></h1>
+<p>Mail::SpamAssassin::Plugin::Reuse - For reusing old rule hits during a mass-check</p>
+<p>
+</p>
+<hr />
+<h1><a name="synopsis">SYNOPSIS</a></h1>
+<pre>
+ loadplugin Mail::SpamAssassin::Plugin::Reuse</pre>
+<pre>
+ ifplugin Mail::SpamAssassin::Plugin::Reuse</pre>
+<pre>
+ reuse NETWORK_RULE [ NETWORK_RULE_OLD_NAME ]</pre>
+<pre>
+ endif</pre>
+<p>
+</p>
+<hr />
+<h1><a name="description">DESCRIPTION</a></h1>
+<p>The purpose of this plugin is to work in conjunction with <strong>mass-check
+--reuse</strong> to map rules hit in input messages to rule hits in the
+mass-check output.</p>
+
+</body>
+
+</html>
Added: spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Reuse.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Reuse.txt?rev=925305&view=auto
==============================================================================
--- spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Reuse.txt (added)
+++ spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Reuse.txt Fri Mar 19 16:21:00 2010
@@ -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.3.x/doc/Mail_SpamAssassin_Plugin_Rule2XSBody.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Rule2XSBody.html?rev=925305&view=auto
==============================================================================
--- spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Rule2XSBody.html (added)
+++ spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Rule2XSBody.html Fri Mar 19 16:21:00 2010
@@ -0,0 +1,44 @@
+<!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::Plugin::Rule2XSBody - speed up SpamAssassin by compiling regexps</title>
+<link rev="made" href="mailto:jm@spamassassin.zones.apache.org" />
+</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>
+</ul>
+<!-- INDEX END -->
+
+<hr />
+<p>
+</p>
+<h1><a name="name">NAME</a></h1>
+<p>Mail::SpamAssassin::Plugin::Rule2XSBody - speed up SpamAssassin by compiling regexps</p>
+<p>
+</p>
+<hr />
+<h1><a name="synopsis">SYNOPSIS</a></h1>
+<pre>
+ loadplugin Mail::SpamAssassin::Plugin::Rule2XSBody</pre>
+<p>
+</p>
+<hr />
+<h1><a name="description">DESCRIPTION</a></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.3.x/doc/Mail_SpamAssassin_Plugin_Rule2XSBody.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Rule2XSBody.txt?rev=925305&view=auto
==============================================================================
--- spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Rule2XSBody.txt (added)
+++ spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Rule2XSBody.txt Fri Mar 19 16:21:00 2010
@@ -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.3.x/doc/Mail_SpamAssassin_Plugin_SPF.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_SPF.html?rev=925305&view=auto
==============================================================================
--- spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_SPF.html (added)
+++ spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_SPF.html Fri Mar 19 16:21:00 2010
@@ -0,0 +1,152 @@
+<!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::Plugin::SPF - perform SPF verification tests</title>
+<link rev="made" href="mailto:jm@spamassassin.zones.apache.org" />
+</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_settings">USER SETTINGS</a></li>
+ <li><a href="#administrator_options">ADMINISTRATOR OPTIONS</a></li>
+</ul>
+<!-- INDEX END -->
+
+<hr />
+<p>
+</p>
+<h1><a name="name">NAME</a></h1>
+<p>Mail::SpamAssassin::Plugin::SPF - perform SPF verification tests</p>
+<p>
+</p>
+<hr />
+<h1><a name="synopsis">SYNOPSIS</a></h1>
+<pre>
+ loadplugin Mail::SpamAssassin::Plugin::SPF</pre>
+<p>
+</p>
+<hr />
+<h1><a name="description">DESCRIPTION</a></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>
+<p>
+</p>
+<hr />
+<h1><a name="user_settings">USER SETTINGS</a></h1>
+<dl>
+<dt><strong><a name="item_whitelist_from_spf_add_40ress_2ecom">whitelist_from_spf <a href="mailto:add@ress.com">add@ress.com</a></a></strong><br />
+</dt>
+<dd>
+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.
+</dd>
+<dd>
+<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>
+</dd>
+<dd>
+<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>
+</dd>
+<dd>
+<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>
+</dd>
+<dd>
+<p>e.g.</p>
+</dd>
+<dd>
+<pre>
+ whitelist_from_spf joe@example.com fred@example.com
+ whitelist_from_spf *@example.com</pre>
+</dd>
+<p></p>
+<dt><strong><a name="item_def_whitelist_from_spf_add_40ress_2ecom">def_whitelist_from_spf <a href="mailto:add@ress.com">add@ress.com</a></a></strong><br />
+</dt>
+<dd>
+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.
+</dd>
+<p></p></dl>
+<p>
+</p>
+<hr />
+<h1><a name="administrator_options">ADMINISTRATOR OPTIONS</a></h1>
+<dl>
+<dt><strong><a name="item_n">spf_timeout n (default: 5)</a></strong><br />
+</dt>
+<dd>
+How many seconds to wait for an SPF query to complete, before scanning
+continues without the SPF result.
+</dd>
+<p></p>
+<dt><strong><a name="item_do_not_use_mail_spf">do_not_use_mail_spf (0|1) (default: 0)</a></strong><br />
+</dt>
+<dd>
+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.
+</dd>
+<dd>
+<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>
+<p></p>
+<dt><strong><a name="item_do_not_use_mail_spf_query">do_not_use_mail_spf_query (0|1) (default: 0)</a></strong><br />
+</dt>
+<dd>
+As above, but instead stop the plugin from trying to use Mail::SPF::Query and
+cause it to only try to use Mail::SPF.
+</dd>
+<p></p>
+<dt><strong><a name="item_ignore_received_spf_header">ignore_received_spf_header (0|1) (default: 0)</a></strong><br />
+</dt>
+<dd>
+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.
+</dd>
+<dd>
+<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>
+</dd>
+<dd>
+<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>
+<p></p>
+<dt><strong><a name="item_use_newest_received_spf_header">use_newest_received_spf_header (0|1) (default: 0)</a></strong><br />
+</dt>
+<dd>
+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.
+</dd>
+<dd>
+<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>
+<p></p></dl>
+
+</body>
+
+</html>
Added: spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_SPF.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_SPF.txt?rev=925305&view=auto
==============================================================================
--- spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_SPF.txt (added)
+++ spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_SPF.txt Fri Mar 19 16:21:00 2010
@@ -0,0 +1,85 @@
+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 add@ress.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 add@ress.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.
+
+ 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.
+
Added: spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Shortcircuit.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Shortcircuit.html?rev=925305&view=auto
==============================================================================
--- spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Shortcircuit.html (added)
+++ spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Shortcircuit.html Fri Mar 19 16:21:00 2010
@@ -0,0 +1,163 @@
+<!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::Plugin::Shortcircuit - short-circuit evaluation for certain rules</title>
+<link rev="made" href="mailto:jm@spamassassin.zones.apache.org" />
+</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="#configuration_settings">CONFIGURATION SETTINGS</a></li>
+ <li><a href="#tags">TAGS</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::Plugin::Shortcircuit - short-circuit evaluation for certain rules</p>
+<p>
+</p>
+<hr />
+<h1><a name="synopsis">SYNOPSIS</a></h1>
+<pre>
+ loadplugin Mail::SpamAssassin::Plugin::Shortcircuit</pre>
+<pre>
+ report Content analysis details: (_SCORE_ points, _REQD_ required, s/c _SCTYPE_)</pre>
+<pre>
+ add_header all Status "_YESNO_, score=_SCORE_ required=_REQD_ tests=_TESTS_ shortcircuit=_SCTYPE_ autolearn=_AUTOLEARN_ version=_VERSION_"</pre>
+<p>
+</p>
+<hr />
+<h1><a name="description">DESCRIPTION</a></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>
+<p>
+</p>
+<hr />
+<h1><a name="configuration_settings">CONFIGURATION SETTINGS</a></h1>
+<p>The following configuration settings are used to control shortcircuiting:</p>
+<dl>
+<dt><strong><a name="item_shortcircuit_symbolic_test_name__7bham_7cspam_7con">shortcircuit SYMBOLIC_TEST_NAME {ham|spam|on|off}</a></strong><br />
+</dt>
+<dd>
+Shortcircuiting a test will force all other pending rules to be skipped, if
+that test is hit.
+</dd>
+<dd>
+<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>
+</dd>
+<dd>
+<p>To override a test that uses shortcircuiting, you can set the classification
+type to <a href="#item_off"><code>off</code></a>.</p>
+</dd>
+<dl>
+<dt><strong><a name="item_on">on</a></strong><br />
+</dt>
+<dd>
+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
+</dd>
+<dd>
+<pre>
+ body TEST /test/
+ describe TEST test rule that scores barely over spam threshold
+ score TEST 5.5
+ priority TEST -100
+ shortcircuit TEST on</pre>
+</dd>
+<dd>
+<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>
+<p></p>
+<dt><strong><a name="item_off">off</a></strong><br />
+</dt>
+<dd>
+Disables shortcircuiting on said rule.
+</dd>
+<p></p>
+<dt><strong><a name="item_spam">spam</a></strong><br />
+</dt>
+<dd>
+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:
+</dd>
+<dd>
+<pre>
+ shortcircuit TEST on
+ priority TEST -100
+ score TEST 100
+ tflags TEST noautolearn</pre>
+</dd>
+<p></p>
+<dt><strong><a name="item_ham">ham</a></strong><br />
+</dt>
+<dd>
+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:
+</dd>
+<dd>
+<pre>
+ shortcircuit TEST on
+ priority TEST -100
+ score TEST -100
+ tflags TEST noautolearn nice</pre>
+</dd>
+<p></p></dl>
+<dt><strong><a name="item_nn">shortcircuit_spam_score n.nn (default: 100)</a></strong><br />
+</dt>
+<dd>
+When shortcircuit is used on a rule, and the shortcircuit classification type
+is set to <a href="#item_spam"><code>spam</code></a>, this value should be applied in place of the default score
+for that rule.
+</dd>
+<p></p>
+<dt><strong>shortcircuit_ham_score n.nn (default: -100)</strong><br />
+</dt>
+<dd>
+When shortcircuit is used on a rule, and the shortcircuit classification type
+is set to <a href="#item_ham"><code>ham</code></a>, this value should be applied in place of the default score
+for that rule.
+</dd>
+<p></p></dl>
+<p>
+</p>
+<hr />
+<h1><a name="tags">TAGS</a></h1>
+<p>The following tags are added to the set available for use in reports, headers
+etc.:</p>
+<pre>
+ _SC_ shortcircuit status (classification and rule name)
+ _SCRULE_ rulename that caused the shortcircuit
+ _SCTYPE_ shortcircuit classification ("spam", "ham", "default", "none")</pre>
+<p>
+</p>
+<hr />
+<h1><a name="see_also">SEE ALSO</a></h1>
+<p><code>http://issues.apache.org/SpamAssassin/show_bug.cgi?id=3109</code></p>
+
+</body>
+
+</html>
Added: spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Shortcircuit.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Shortcircuit.txt?rev=925305&view=auto
==============================================================================
--- spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Shortcircuit.txt (added)
+++ spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Shortcircuit.txt Fri Mar 19 16:21:00 2010
@@ -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.3.x/doc/Mail_SpamAssassin_Plugin_SpamCop.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_SpamCop.html?rev=925305&view=auto
==============================================================================
--- spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_SpamCop.html (added)
+++ spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_SpamCop.html Fri Mar 19 16:21:00 2010
@@ -0,0 +1,80 @@
+<!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::Plugin::SpamCop - perform SpamCop reporting of messages</title>
+<link rev="made" href="mailto:jm@spamassassin.zones.apache.org" />
+</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_options">USER OPTIONS</a></li>
+</ul>
+<!-- INDEX END -->
+
+<hr />
+<p>
+</p>
+<h1><a name="name">NAME</a></h1>
+<p>Mail::SpamAssassin::Plugin::SpamCop - perform SpamCop reporting of messages</p>
+<p>
+</p>
+<hr />
+<h1><a name="synopsis">SYNOPSIS</a></h1>
+<pre>
+ loadplugin Mail::SpamAssassin::Plugin::SpamCop</pre>
+<p>
+</p>
+<hr />
+<h1><a name="description">DESCRIPTION</a></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 <a href="http://www.spamcop.net/">http://www.spamcop.net/</a> for more information about SpamCop.</p>
+<p>
+</p>
+<hr />
+<h1><a name="user_options">USER OPTIONS</a></h1>
+<dl>
+<dt><strong><a name="item_com">spamcop_from_address <a href="mailto:add@ress.com">add@ress.com</a> (default: none)</a></strong><br />
+</dt>
+<dd>
+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.
+</dd>
+<p></p>
+<dt><strong>spamcop_to_address <a href="mailto:add@ress.com">add@ress.com</a> (default: generic reporting address)</strong><br />
+</dt>
+<dd>
+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.
+</dd>
+<p></p>
+<dt><strong><a name="item_spamcop_max_report_size">spamcop_max_report_size (default: 50)</a></strong><br />
+</dt>
+<dd>
+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.
+</dd>
+<p></p></dl>
+
+</body>
+
+</html>
Added: spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_SpamCop.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_SpamCop.txt?rev=925305&view=auto
==============================================================================
--- spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_SpamCop.txt (added)
+++ spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_SpamCop.txt Fri Mar 19 16:21:00 2010
@@ -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 add@ress.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 add@ress.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.3.x/doc/Mail_SpamAssassin_Plugin_Test.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Test.html?rev=925305&view=auto
==============================================================================
--- spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Test.html (added)
+++ spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Test.html Fri Mar 19 16:21:00 2010
@@ -0,0 +1,42 @@
+<!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>Test - test plugin</title>
+<link rev="made" href="mailto:jm@spamassassin.zones.apache.org" />
+</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>
+</ul>
+<!-- INDEX END -->
+
+<hr />
+<p>
+</p>
+<h1><a name="name">NAME</a></h1>
+<p>Test - test plugin</p>
+<p>
+</p>
+<hr />
+<h1><a name="synopsis">SYNOPSIS</a></h1>
+<pre>
+ loadplugin Mail::SpamAssassin::Plugin::Test
+ header MY_TEST_PLUGIN eval:check_test_plugin()</pre>
+<p>
+</p>
+<hr />
+<h1><a name="description">DESCRIPTION</a></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.3.x/doc/Mail_SpamAssassin_Plugin_Test.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Test.txt?rev=925305&view=auto
==============================================================================
--- spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Test.txt (added)
+++ spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_Test.txt Fri Mar 19 16:21:00 2010
@@ -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.3.x/doc/Mail_SpamAssassin_Plugin_TextCat.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_TextCat.html?rev=925305&view=auto
==============================================================================
--- spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_TextCat.html (added)
+++ spamassassin/site/full/3.3.x/doc/Mail_SpamAssassin_Plugin_TextCat.html Fri Mar 19 16:21:00 2010
@@ -0,0 +1,273 @@
+<!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::Plugin::TextCat - TextCat language guesser</title>
+<link rev="made" href="mailto:jm@spamassassin.zones.apache.org" />
+</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_options">USER OPTIONS</a></li>
+</ul>
+<!-- INDEX END -->
+
+<hr />
+<p>
+</p>
+<h1><a name="name">NAME</a></h1>
+<p>Mail::SpamAssassin::Plugin::TextCat - TextCat language guesser</p>
+<p>
+</p>
+<hr />
+<h1><a name="synopsis">SYNOPSIS</a></h1>
+<pre>
+ loadplugin Mail::SpamAssassin::Plugin::TextCat</pre>
+<p>
+</p>
+<hr />
+<h1><a name="description">DESCRIPTION</a></h1>
+<p>This plugin will try to guess the language used in the message text.</p>
+<p>You can then specify 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. The results can also be added to marked-up messages using
+``add_header'', with the _LANGUAGES_ tag. See
+<a href="/Mail/SpamAssassin/Conf.html">the Mail::SpamAssassin::Conf manpage</a> for details.</p>
+<p>Note: the language cannot always be recognized with sufficient
+confidence. In that case, <code>UNWANTED_LANGUAGE_BODY</code> will not trigger.</p>
+<p>
+</p>
+<hr />
+<h1><a name="user_options">USER OPTIONS</a></h1>
+<dl>
+<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>
+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 text.
+</dd>
+<dd>
+<p>Note that the language cannot always be recognized with sufficient
+confidence. In that case, no points will be assigned.</p>
+</dd>
+<dd>
+<p>The rule <code>UNWANTED_LANGUAGE_BODY</code> is triggered based on how this is set.</p>
+</dd>
+<dd>
+<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>
+</dd>
+<dd>
+<p>Examples:</p>
+</dd>
+<dd>
+<pre>
+ ok_languages all (allow all languages)
+ ok_languages en (only allow English)
+ ok_languages en ja zh (allow English, Japanese, and Chinese)</pre>
+</dd>
+<dd>
+<p>Note: if there are multiple ok_languages lines, only the last one is used.</p>
+</dd>
+<dd>
+<p>Select the languages to allow from the list below:</p>
+</dd>
+<dl>
+<dt><strong><a name="item_af__2d_afrikaans">af - Afrikaans</a></strong><br />
+</dt>
+<dt><strong><a name="item_am__2d_amharic">am - Amharic</a></strong><br />
+</dt>
+<dt><strong><a name="item_ar__2d_arabic">ar - Arabic</a></strong><br />
+</dt>
+<dt><strong><a name="item_be__2d_byelorussian">be - Byelorussian</a></strong><br />
+</dt>
+<dt><strong><a name="item_bg__2d_bulgarian">bg - Bulgarian</a></strong><br />
+</dt>
+<dt><strong><a name="item_bs__2d_bosnian">bs - Bosnian</a></strong><br />
+</dt>
+<dt><strong><a name="item_ca__2d_catalan">ca - Catalan</a></strong><br />
+</dt>
+<dt><strong><a name="item_cs__2d_czech">cs - Czech</a></strong><br />
+</dt>
+<dt><strong><a name="item_cy__2d_welsh">cy - Welsh</a></strong><br />
+</dt>
+<dt><strong><a name="item_da__2d_danish">da - Danish</a></strong><br />
+</dt>
+<dt><strong><a name="item_de__2d_german">de - German</a></strong><br />
+</dt>
+<dt><strong><a name="item_el__2d_greek">el - Greek</a></strong><br />
+</dt>
+<dt><strong><a name="item_en__2d_english">en - English</a></strong><br />
+</dt>
+<dt><strong><a name="item_eo__2d_esperanto">eo - Esperanto</a></strong><br />
+</dt>
+<dt><strong><a name="item_es__2d_spanish">es - Spanish</a></strong><br />
+</dt>
+<dt><strong><a name="item_et__2d_estonian">et - Estonian</a></strong><br />
+</dt>
+<dt><strong><a name="item_eu__2d_basque">eu - Basque</a></strong><br />
+</dt>
+<dt><strong><a name="item_fa__2d_persian">fa - Persian</a></strong><br />
+</dt>
+<dt><strong><a name="item_fi__2d_finnish">fi - Finnish</a></strong><br />
+</dt>
+<dt><strong><a name="item_fr__2d_french">fr - French</a></strong><br />
+</dt>
+<dt><strong><a name="item_fy__2d_frisian">fy - Frisian</a></strong><br />
+</dt>
+<dt><strong><a name="item_ga__2d_irish_gaelic">ga - Irish Gaelic</a></strong><br />
+</dt>
+<dt><strong><a name="item_gd__2d_scottish_gaelic">gd - Scottish Gaelic</a></strong><br />
+</dt>
+<dt><strong><a name="item_he__2d_hebrew">he - Hebrew</a></strong><br />
+</dt>
+<dt><strong><a name="item_hi__2d_hindi">hi - Hindi</a></strong><br />
+</dt>
+<dt><strong><a name="item_hr__2d_croatian">hr - Croatian</a></strong><br />
+</dt>
+<dt><strong><a name="item_hu__2d_hungarian">hu - Hungarian</a></strong><br />
+</dt>
+<dt><strong><a name="item_hy__2d_armenian">hy - Armenian</a></strong><br />
+</dt>
+<dt><strong><a name="item_id__2d_indonesian">id - Indonesian</a></strong><br />
+</dt>
+<dt><strong><a name="item_is__2d_icelandic">is - Icelandic</a></strong><br />
+</dt>
+<dt><strong><a name="item_it__2d_italian">it - Italian</a></strong><br />
+</dt>
+<dt><strong><a name="item_ja__2d_japanese">ja - Japanese</a></strong><br />
+</dt>
+<dt><strong><a name="item_ka__2d_georgian">ka - Georgian</a></strong><br />
+</dt>
+<dt><strong><a name="item_ko__2d_korean">ko - Korean</a></strong><br />
+</dt>
+<dt><strong><a name="item_la__2d_latin">la - Latin</a></strong><br />
+</dt>
+<dt><strong><a name="item_lt__2d_lithuanian">lt - Lithuanian</a></strong><br />
+</dt>
+<dt><strong><a name="item_lv__2d_latvian">lv - Latvian</a></strong><br />
+</dt>
+<dt><strong><a name="item_mr__2d_marathi">mr - Marathi</a></strong><br />
+</dt>
+<dt><strong><a name="item_ms__2d_malay">ms - Malay</a></strong><br />
+</dt>
+<dt><strong><a name="item_ne__2d_nepali">ne - Nepali</a></strong><br />
+</dt>
+<dt><strong><a name="item_nl__2d_dutch">nl - Dutch</a></strong><br />
+</dt>
+<dt><strong><a name="item_no__2d_norwegian">no - Norwegian</a></strong><br />
+</dt>
+<dt><strong><a name="item_pl__2d_polish">pl - Polish</a></strong><br />
+</dt>
+<dt><strong><a name="item_pt__2d_portuguese">pt - Portuguese</a></strong><br />
+</dt>
+<dt><strong><a name="item_qu__2d_quechua">qu - Quechua</a></strong><br />
+</dt>
+<dt><strong><a name="item_rm__2d_rhaeto_2dromance">rm - Rhaeto-Romance</a></strong><br />
+</dt>
+<dt><strong><a name="item_ro__2d_romanian">ro - Romanian</a></strong><br />
+</dt>
+<dt><strong><a name="item_ru__2d_russian">ru - Russian</a></strong><br />
+</dt>
+<dt><strong><a name="item_sa__2d_sanskrit">sa - Sanskrit</a></strong><br />
+</dt>
+<dt><strong><a name="item_sco__2d_scots">sco - Scots</a></strong><br />
+</dt>
+<dt><strong><a name="item_sk__2d_slovak">sk - Slovak</a></strong><br />
+</dt>
+<dt><strong><a name="item_sl__2d_slovenian">sl - Slovenian</a></strong><br />
+</dt>
+<dt><strong><a name="item_sq__2d_albanian">sq - Albanian</a></strong><br />
+</dt>
+<dt><strong><a name="item_sr__2d_serbian">sr - Serbian</a></strong><br />
+</dt>
+<dt><strong><a name="item_sv__2d_swedish">sv - Swedish</a></strong><br />
+</dt>
+<dt><strong><a name="item_sw__2d_swahili">sw - Swahili</a></strong><br />
+</dt>
+<dt><strong><a name="item_ta__2d_tamil">ta - Tamil</a></strong><br />
+</dt>
+<dt><strong><a name="item_th__2d_thai">th - Thai</a></strong><br />
+</dt>
+<dt><strong><a name="item_tl__2d_tagalog">tl - Tagalog</a></strong><br />
+</dt>
+<dt><strong><a name="item_tr__2d_turkish">tr - Turkish</a></strong><br />
+</dt>
+<dt><strong><a name="item_uk__2d_ukrainian">uk - Ukrainian</a></strong><br />
+</dt>
+<dt><strong><a name="item_vi__2d_vietnamese">vi - Vietnamese</a></strong><br />
+</dt>
+<dt><strong><a name="item_yi__2d_yiddish">yi - Yiddish</a></strong><br />
+</dt>
+<dt><strong><a name="item_chinese">zh - Chinese (both Traditional and Simplified)</a></strong><br />
+</dt>
+<dt><strong>zh.big5 - Chinese (Traditional only)</strong><br />
+</dt>
+<dt><strong>zh.gb2312 - Chinese (Simplified only)</strong><br />
+</dt>
+</dl>
+<p></p>
+<dt><strong><a name="item_inactive_languages_xx__5b_yy_zz__2e_2e_2e__5d__28d">inactive_languages xx [ yy zz ... ] (default: see below)</a></strong><br />
+</dt>
+<dd>
+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.
+</dd>
+<dd>
+<p>The default setting is:</p>
+</dd>
+<dl>
+<dt><strong><a name="item_bs_cy_eo_et_eu_fy_ga_gd_is_la_lt_lv_rm_sa_sco_sl_y">bs cy eo et eu fy ga gd is la lt lv rm sa sco sl yi</a></strong><br />
+</dt>
+</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>
+<dt><strong><a name="item_n">textcat_max_languages N (default: 5)</a></strong><br />
+</dt>
+<dd>
+The maximum number of languages before the classification is considered unknown.
+</dd>
+<p></p>
+<dt><strong>textcat_optimal_ngrams N (default: 0)</strong><br />
+</dt>
+<dd>
+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.
+</dd>
+<p></p>
+<dt><strong>textcat_max_ngrams N (default: 400)</strong><br />
+</dt>
+<dd>
+The maximum number of ngrams that should be compared with each of the languages
+models (note that each of those models is used completely).
+</dd>
+<p></p>
+<dt><strong>textcat_acceptable_score N (default: 1.05)</strong><br />
+</dt>
+<dd>
+Include any language that scores at least <code>textcat_acceptable_score</code> in the
+returned list of languages
+</dd>
+<p></p></dl>
+
+</body>
+
+</html>