spamassassin-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From j.@apache.org
Subject svn commit: r534420 [9/13] - in /spamassassin/site/full/3.2.x: ./ doc/
Date Wed, 02 May 2007 12:33:14 GMT
Added: spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_DomainKeys.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_DomainKeys.html?view=auto&rev=534420
==============================================================================
--- spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_DomainKeys.html (added)
+++ spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_DomainKeys.html Wed May  2 05:33:04 2007
@@ -0,0 +1,142 @@
+<!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::DomainKeys - perform DomainKeys verification tests</title>
+<link rev="made" href="mailto:jm@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::DomainKeys - perform DomainKeys verification tests</p>
+<p>
+</p>
+<hr />
+<h1><a name="synopsis">SYNOPSIS</a></h1>
+<pre>
+ loadplugin Mail::SpamAssassin::Plugin::DomainKeys [/path/to/DomainKeys.pm]</pre>
+<p>Signature:
+ header DK_SIGNED                eval:check_domainkeys_signed()
+ header DK_VERIFIED              eval:check_domainkeys_verified()</p>
+<p>Policy:
+   Note that DK policy record is only fetched if DK_VERIFIED is
+   false to save a signing domain from unnecessary DNS queries,
+   as recommended (SHOULD) by draft-delany-domainkeys-base.
+   Rules DK_POLICY_* should preferably not be relied upon when
+   DK_VERIFIED is true, although they will return false in current
+   implementation when a policy record is not fetched, except for
+   DK_POLICY_TESTING, which is true if t=y appears in a public key
+   record OR in a policy record (when available).
+ header DK_POLICY_TESTING        eval:check_domainkeys_testing()
+ header DK_POLICY_SIGNSOME       eval:check_domainkeys_signsome()
+ header DK_POLICY_SIGNALL        eval:check_domainkeys_signall()</p>
+<p>Whitelisting based on verified signature:
+ header USER_IN_DK_WHITELIST     eval:check_for_dk_whitelist_from()
+ header USER_IN_DEF_DK_WL        eval:check_for_def_dk_whitelist_from()</p>
+<p>
+</p>
+<hr />
+<h1><a name="description">DESCRIPTION</a></h1>
+<p>This is the DomainKeys plugin and it needs lots more documentation.</p>
+<p>Note that if the <code>Mail::SpamAssassin::Plugin::DKIM</code> plugin is installed with
+<code>Mail::DKIM</code> version 0.20 or later, that plugin will also perform Domain Key
+lookups on DomainKey-Signature headers, in which case this plugin is redundant.</p>
+<p>Here is author's note from module <code>Mail::DomainKeys</code> version 1.0:</p>
+<pre>
+  THIS MODULE IS OFFICIALLY UNSUPPORTED.</pre>
+<pre>
+  Please move on to DKIM like a responsible Internet user.  I have.</pre>
+<pre>
+  I will leave this module here on CPAN for a while, just in case someone
+  has grown to depend on it.  It is apparent that DK will not be the way
+  of the future. Thus, it is time to put this module to ground before it
+  causes any further harm.</pre>
+<pre>
+  Thanks for your support,
+  Anthony</pre>
+<p>
+</p>
+<hr />
+<h1><a name="user_settings">USER SETTINGS</a></h1>
+<dl>
+<dt><strong><a name="item_whitelist_from_dk_add_40ress_2ecom__5bsigning_doma">whitelist_from_dk <a href="mailto:add@ress.com">add@ress.com</a> [signing domain name]</a></strong><br />
+</dt>
+<dd>
+Use this to supplement the whitelist_from addresses with a check to make sure
+the message has been signed by a DomainKeys signature that can be verified
+against the From: domain's DomainKeys public key.
+</dd>
+<dd>
+<p>In order to support signing domain names that differ from the address domain
+name, only one whitelist entry is allowed per line, exactly like
+<code>whitelist_from_rcvd</code>.  Multiple <code>whitelist_from_dk</code> lines are allowed.  
+File-glob style meta characters are allowed for the From: address, just like
+with <code>whitelist_from_rcvd</code>.  The optional signing domain name parameter must
+match from the right-most side, also like in <code>whitelist_from_rcvd</code>.</p>
+</dd>
+<dd>
+<p>If no signing domain name parameter is specified the domain of the address
+parameter specified will be used instead.</p>
+</dd>
+<dd>
+<p>The From: address is obtained from a signed part of the message (ie. the
+``From:'' header), not from envelope data that is possible to forge.</p>
+</dd>
+<dd>
+<p>Since this whitelist requires a DomainKeys check to be made, network tests must
+be enabled.</p>
+</dd>
+<dd>
+<p>Examples:</p>
+</dd>
+<dd>
+<pre>
+  whitelist_from_dk joe@example.com
+  whitelist_from_dk *@corp.example.com</pre>
+</dd>
+<dd>
+<pre>
+  whitelist_from_dk bob@it.example.net  example.net
+  whitelist_from_dk *@eng.example.net   example.net</pre>
+</dd>
+<p></p>
+<dt><strong><a name="item_def_whitelist_from_dk_add_40ress_2ecom__5bsigning_">def_whitelist_from_dk <a href="mailto:add@ress.com">add@ress.com</a> [signing domain name]</a></strong><br />
+</dt>
+<dd>
+Same as <code>whitelist_from_dk</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_settings">ADMINISTRATOR SETTINGS</a></h1>
+<dl>
+<dt><strong><a name="item_n">domainkeys_timeout n             (default: 5)</a></strong><br />
+</dt>
+<dd>
+How many seconds to wait for a DomainKeys query to complete, before
+scanning continues without the DomainKeys result.
+</dd>
+</dl>
+
+</body>
+
+</html>

Added: spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_DomainKeys.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_DomainKeys.txt?view=auto&rev=534420
==============================================================================
--- spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_DomainKeys.txt (added)
+++ spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_DomainKeys.txt Wed May  2 05:33:04 2007
@@ -0,0 +1,89 @@
+NAME
+    Mail::SpamAssassin::Plugin::DomainKeys - perform DomainKeys verification
+    tests
+
+SYNOPSIS
+     loadplugin Mail::SpamAssassin::Plugin::DomainKeys [/path/to/DomainKeys.pm]
+
+    Signature: header DK_SIGNED eval:check_domainkeys_signed() header
+    DK_VERIFIED eval:check_domainkeys_verified()
+
+    Policy: Note that DK policy record is only fetched if DK_VERIFIED is
+    false to save a signing domain from unnecessary DNS queries, as
+    recommended (SHOULD) by draft-delany-domainkeys-base. Rules DK_POLICY_*
+    should preferably not be relied upon when DK_VERIFIED is true, although
+    they will return false in current implementation when a policy record is
+    not fetched, except for DK_POLICY_TESTING, which is true if t=y appears
+    in a public key record OR in a policy record (when available). header
+    DK_POLICY_TESTING eval:check_domainkeys_testing() header
+    DK_POLICY_SIGNSOME eval:check_domainkeys_signsome() header
+    DK_POLICY_SIGNALL eval:check_domainkeys_signall()
+
+    Whitelisting based on verified signature: header USER_IN_DK_WHITELIST
+    eval:check_for_dk_whitelist_from() header USER_IN_DEF_DK_WL
+    eval:check_for_def_dk_whitelist_from()
+
+DESCRIPTION
+    This is the DomainKeys plugin and it needs lots more documentation.
+
+    Note that if the "Mail::SpamAssassin::Plugin::DKIM" plugin is installed
+    with "Mail::DKIM" version 0.20 or later, that plugin will also perform
+    Domain Key lookups on DomainKey-Signature headers, in which case this
+    plugin is redundant.
+
+    Here is author's note from module "Mail::DomainKeys" version 1.0:
+
+      THIS MODULE IS OFFICIALLY UNSUPPORTED.
+
+      Please move on to DKIM like a responsible Internet user.  I have.
+
+      I will leave this module here on CPAN for a while, just in case someone
+      has grown to depend on it.  It is apparent that DK will not be the way
+      of the future. Thus, it is time to put this module to ground before it
+      causes any further harm.
+
+      Thanks for your support,
+      Anthony
+
+USER SETTINGS
+    whitelist_from_dk add@ress.com [signing domain name]
+        Use this to supplement the whitelist_from addresses with a check to
+        make sure the message has been signed by a DomainKeys signature that
+        can be verified against the From: domain's DomainKeys public key.
+
+        In order to support signing domain names that differ from the
+        address domain name, only one whitelist entry is allowed per line,
+        exactly like "whitelist_from_rcvd". Multiple "whitelist_from_dk"
+        lines are allowed. File-glob style meta characters are allowed for
+        the From: address, just like with "whitelist_from_rcvd". The
+        optional signing domain name parameter must match from the
+        right-most side, also like in "whitelist_from_rcvd".
+
+        If no signing domain name parameter is specified the domain of the
+        address parameter specified will be used instead.
+
+        The From: address is obtained from a signed part of the message (ie.
+        the "From:" header), not from envelope data that is possible to
+        forge.
+
+        Since this whitelist requires a DomainKeys check to be made, network
+        tests must be enabled.
+
+        Examples:
+
+          whitelist_from_dk joe@example.com
+          whitelist_from_dk *@corp.example.com
+
+          whitelist_from_dk bob@it.example.net  example.net
+          whitelist_from_dk *@eng.example.net   example.net
+
+    def_whitelist_from_dk add@ress.com [signing domain name]
+        Same as "whitelist_from_dk", 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 SETTINGS
+    domainkeys_timeout n (default: 5)
+        How many seconds to wait for a DomainKeys query to complete, before
+        scanning continues without the DomainKeys result.
+

Added: spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_Hashcash.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_Hashcash.html?view=auto&rev=534420
==============================================================================
--- spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_Hashcash.html (added)
+++ spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_Hashcash.html Wed May  2 05:33:04 2007
@@ -0,0 +1,99 @@
+<!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::Hashcash - perform hashcash verification tests</title>
+<link rev="made" href="mailto:jm@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>
+</ul>
+<!-- INDEX END -->
+
+<hr />
+<p>
+</p>
+<h1><a name="name">NAME</a></h1>
+<p>Mail::SpamAssassin::Plugin::Hashcash - perform hashcash verification tests</p>
+<p>
+</p>
+<hr />
+<h1><a name="synopsis">SYNOPSIS</a></h1>
+<pre>
+  loadplugin     Mail::SpamAssassin::Plugin::Hashcash</pre>
+<p>
+</p>
+<hr />
+<h1><a name="description">DESCRIPTION</a></h1>
+<p>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.</p>
+<p>
+</p>
+<hr />
+<h1><a name="user_settings">USER SETTINGS</a></h1>
+<dl>
+<dt><strong><a name="item_use_hashcash__7b_1__7c_0__7d__28default_3a_1_29">use_hashcash { 1 | 0 }   (default: 1)</a></strong><br />
+</dt>
+<dd>
+Whether to use hashcash, if it is available.
+</dd>
+<p></p>
+<dt><strong><a name="item_hashcash_accept_add_40ress_2ecom__2e_2e_2e">hashcash_accept <a href="mailto:add@ress.com">add@ress.com</a> ...</a></strong><br />
+</dt>
+<dd>
+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.
+</dd>
+<dd>
+<p>Like whitelist and blacklist entries, the addresses are file-glob-style
+patterns, so <code>friend@somewhere.com</code>, <code>*@isp.com</code>, or <code>*.domain.net</code> will all
+work.  Specifically, <code>*</code> and <code>?</code> are allowed, but all other metacharacters
+are not.  Regular expressions are not used for security reasons.</p>
+</dd>
+<dd>
+<p>The sequence <code>%u</code> is replaced with the current user's username, which
+is useful for ISPs or multi-user domains.</p>
+</dd>
+<dd>
+<p>Multiple addresses per line, separated by spaces, is OK.  Multiple
+<code>hashcash_accept</code> lines is also OK.</p>
+</dd>
+<p></p>
+<dt><strong><a name="item_file">hashcash_doublespend_path /path/to/file   (default: ~/.spamassassin/hashcash_seen)</a></strong><br />
+</dt>
+<dd>
+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.
+</dd>
+<dd>
+<p>By default, each user has their own, in their <code>~/.spamassassin</code> 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.</p>
+</dd>
+<p></p>
+<dt><strong><a name="item_hashcash_doublespend_file_mode">hashcash_doublespend_file_mode            (default: 0700)</a></strong><br />
+</dt>
+<dd>
+The file mode bits used for the HashCash double-spend database file.
+</dd>
+<dd>
+<p>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).</p>
+</dd>
+<p></p></dl>
+
+</body>
+
+</html>

Added: spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_Hashcash.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_Hashcash.txt?view=auto&rev=534420
==============================================================================
--- spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_Hashcash.txt (added)
+++ spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_Hashcash.txt Wed May  2 05:33:04 2007
@@ -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.2.x/doc/Mail_SpamAssassin_Plugin_MIMEHeader.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_MIMEHeader.html?view=auto&rev=534420
==============================================================================
--- spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_MIMEHeader.html (added)
+++ spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_MIMEHeader.html Wed May  2 05:33:04 2007
@@ -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@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.2.x/doc/Mail_SpamAssassin_Plugin_MIMEHeader.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_MIMEHeader.txt?view=auto&rev=534420
==============================================================================
--- spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_MIMEHeader.txt (added)
+++ spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_MIMEHeader.txt Wed May  2 05:33:04 2007
@@ -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.2.x/doc/Mail_SpamAssassin_Plugin_NetCache.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_NetCache.html?view=auto&rev=534420
==============================================================================
--- spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_NetCache.html (added)
+++ spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_NetCache.html Wed May  2 05:33:04 2007
@@ -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@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.2.x/doc/Mail_SpamAssassin_Plugin_NetCache.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_NetCache.txt?view=auto&rev=534420
==============================================================================
--- spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_NetCache.txt (added)
+++ spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_NetCache.txt Wed May  2 05:33:04 2007
@@ -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.2.x/doc/Mail_SpamAssassin_Plugin_OneLineBodyRuleType.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_OneLineBodyRuleType.html?view=auto&rev=534420
==============================================================================
--- spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_OneLineBodyRuleType.html (added)
+++ spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_OneLineBodyRuleType.html Wed May  2 05:33:04 2007
@@ -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@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.2.x/doc/Mail_SpamAssassin_Plugin_OneLineBodyRuleType.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_OneLineBodyRuleType.txt?view=auto&rev=534420
==============================================================================
--- spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_OneLineBodyRuleType.txt (added)
+++ spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_OneLineBodyRuleType.txt Wed May  2 05:33:04 2007
@@ -0,0 +1,3 @@
+NAME
+    Mail::SpamAssassin::Plugin::OneLineBodyRuleType
+

Added: spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_Pyzor.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_Pyzor.html?view=auto&rev=534420
==============================================================================
--- spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_Pyzor.html (added)
+++ spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_Pyzor.html Wed May  2 05:33:04 2007
@@ -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@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.2.x/doc/Mail_SpamAssassin_Plugin_Pyzor.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_Pyzor.txt?view=auto&rev=534420
==============================================================================
--- spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_Pyzor.txt (added)
+++ spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_Pyzor.txt Wed May  2 05:33:04 2007
@@ -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.2.x/doc/Mail_SpamAssassin_Plugin_Razor2.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_Razor2.html?view=auto&rev=534420
==============================================================================
--- spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_Razor2.html (added)
+++ spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_Razor2.html Wed May  2 05:33:04 2007
@@ -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@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.2.x/doc/Mail_SpamAssassin_Plugin_Razor2.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_Razor2.txt?view=auto&rev=534420
==============================================================================
--- spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_Razor2.txt (added)
+++ spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_Razor2.txt Wed May  2 05:33:04 2007
@@ -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.2.x/doc/Mail_SpamAssassin_Plugin_RelayCountry.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_RelayCountry.html?view=auto&rev=534420
==============================================================================
--- spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_RelayCountry.html (added)
+++ spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_RelayCountry.html Wed May  2 05:33:04 2007
@@ -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@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.2.x/doc/Mail_SpamAssassin_Plugin_RelayCountry.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_RelayCountry.txt?view=auto&rev=534420
==============================================================================
--- spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_RelayCountry.txt (added)
+++ spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_RelayCountry.txt Wed May  2 05:33:04 2007
@@ -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.2.x/doc/Mail_SpamAssassin_Plugin_ReplaceTags.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_ReplaceTags.html?view=auto&rev=534420
==============================================================================
--- spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_ReplaceTags.html (added)
+++ spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_ReplaceTags.html Wed May  2 05:33:04 2007
@@ -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@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 replies 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 &lt;
+  replace_end   &gt;</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)&lt;V&gt;+&lt;SP&gt;*&lt;I&gt;+&lt;SP&gt;*&lt;A&gt;+&lt;SP&gt;*&lt;G&gt;+&lt;SP&gt;*&lt;R&gt;+&lt;SP&gt;*&lt;A&gt;+/i
+  describe      VIAGRA_OBFU     Attempt to obfuscate &quot;viagra&quot;</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.2.x/doc/Mail_SpamAssassin_Plugin_ReplaceTags.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_ReplaceTags.txt?view=auto&rev=534420
==============================================================================
--- spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_ReplaceTags.txt (added)
+++ spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_ReplaceTags.txt Wed May  2 05:33:04 2007
@@ -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 replies 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.2.x/doc/Mail_SpamAssassin_Plugin_Rule2XSBody.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_Rule2XSBody.html?view=auto&rev=534420
==============================================================================
--- spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_Rule2XSBody.html (added)
+++ spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_Rule2XSBody.html Wed May  2 05:33:04 2007
@@ -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@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.2.x/doc/Mail_SpamAssassin_Plugin_Rule2XSBody.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_Rule2XSBody.txt?view=auto&rev=534420
==============================================================================
--- spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_Rule2XSBody.txt (added)
+++ spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_Rule2XSBody.txt Wed May  2 05:33:04 2007
@@ -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.2.x/doc/Mail_SpamAssassin_Plugin_SPF.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_SPF.html?view=auto&rev=534420
==============================================================================
--- spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_SPF.html (added)
+++ spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_SPF.html Wed May  2 05:33:04 2007
@@ -0,0 +1,151 @@
+<!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@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>
+Use this to supplement the whitelist_from addresses with a check against the
+domain's SPF record. Aside from the name 'whitelist_from_spf', the syntax is
+exactly the same as the syntax for 'whitelist_from'.
+</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_spq_query">do_not_use_mail_spq_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.2.x/doc/Mail_SpamAssassin_Plugin_SPF.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_SPF.txt?view=auto&rev=534420
==============================================================================
--- spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_SPF.txt (added)
+++ spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_SPF.txt Wed May  2 05:33:04 2007
@@ -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
+        Use this to supplement the whitelist_from addresses with a check
+        against the domain's SPF record. Aside from the name
+        'whitelist_from_spf', the syntax is exactly the same as the syntax
+        for 'whitelist_from'.
+
+        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_spq_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.2.x/doc/Mail_SpamAssassin_Plugin_Shortcircuit.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_Shortcircuit.html?view=auto&rev=534420
==============================================================================
--- spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_Shortcircuit.html (added)
+++ spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_Shortcircuit.html Wed May  2 05:33:04 2007
@@ -0,0 +1,162 @@
+<!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@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 &quot;_YESNO_, score=_SCORE_ required=_REQD_ tests=_TESTS_ shortcircuit=_SCTYPE_ autolearn=_AUTOLEARN_ version=_VERSION_&quot;</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.</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>
+
+=over 4</pre>
+</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>
+<p></p></dl>
+<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>
+<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>
+<pre>
+  shortcircuit TEST on
+  priority TEST -100
+  score TEST 100
+  tflags TEST noautolearn</pre>
+<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>
+<pre>
+  shortcircuit TEST on
+  priority TEST -100
+  score TEST -100
+  tflags TEST noautolearn nice</pre>
+</dl>
+<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 (&quot;spam&quot;, &quot;ham&quot;, &quot;default&quot;, &quot;none&quot;)</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.2.x/doc/Mail_SpamAssassin_Plugin_Shortcircuit.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_Shortcircuit.txt?view=auto&rev=534420
==============================================================================
--- spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_Shortcircuit.txt (added)
+++ spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_Shortcircuit.txt Wed May  2 05:33:04 2007
@@ -0,0 +1,94 @@
+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.
+
+    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.2.x/doc/Mail_SpamAssassin_Plugin_SpamCop.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_SpamCop.html?view=auto&rev=534420
==============================================================================
--- spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_SpamCop.html (added)
+++ spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_SpamCop.html Wed May  2 05:33:04 2007
@@ -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@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.2.x/doc/Mail_SpamAssassin_Plugin_SpamCop.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_SpamCop.txt?view=auto&rev=534420
==============================================================================
--- spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_SpamCop.txt (added)
+++ spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_SpamCop.txt Wed May  2 05:33:04 2007
@@ -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.2.x/doc/Mail_SpamAssassin_Plugin_Test.html
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_Test.html?view=auto&rev=534420
==============================================================================
--- spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_Test.html (added)
+++ spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_Test.html Wed May  2 05:33:04 2007
@@ -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@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.2.x/doc/Mail_SpamAssassin_Plugin_Test.txt
URL: http://svn.apache.org/viewvc/spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_Test.txt?view=auto&rev=534420
==============================================================================
--- spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_Test.txt (added)
+++ spamassassin/site/full/3.2.x/doc/Mail_SpamAssassin_Plugin_Test.txt Wed May  2 05:33:04 2007
@@ -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".
+



Mime
View raw message