svn commit: r469849 - /spamassassin/branches/3.1/lib/Mail/SpamAssassin/Conf.pm

[jm...@apache.org]

Author: jm
Date: Wed Nov  1 02:35:09 2006
New Revision: 469849

URL: http://svn.apache.org/viewvc?view=rev&rev=469849
Log:
trivial: add more documentation about the 'X-Spam-Relays-*' pseudo-headers, which were woefully under-docced in the POD

Modified:
    spamassassin/branches/3.1/lib/Mail/SpamAssassin/Conf.pm

Modified: spamassassin/branches/3.1/lib/Mail/SpamAssassin/Conf.pm
URL: http://svn.apache.org/viewvc/spamassassin/branches/3.1/lib/Mail/SpamAssassin/Conf.pm?view=diff&rev=469849&r1=469848&r2=469849
==============================================================================
--- spamassassin/branches/3.1/lib/Mail/SpamAssassin/Conf.pm (original)
+++ spamassassin/branches/3.1/lib/Mail/SpamAssassin/Conf.pm Wed Nov  1 02:35:09 2006
@@ -1740,6 +1740,13 @@
 or 'X-Message-Id', then uses its own one in the 'Message-Id' header.  The value
 returned for this symbol is the text from all 3 headers, separated by newlines.
 
+=item C<X-Spam-Relays-Untrusted>, C<X-Spam-Relays-Trusted>,
+C<X-Spam-Relays-Internal> and C<X-Spam-Relays-External> represent a portable,
+pre-parsed representation of the message's network path, as recorded in the
+Received headers, divided into 'trusted' vs 'untrusted' and 'internal' vs
+'external' sets.  See C<http://wiki.apache.org/spamassassin/TrustedRelays> for
+more details.
+
 =back
 
 C<op> is either C<=~> (contains regular expression) or C<!~> (does not contain
@@ -2647,10 +2654,14 @@
  _DATE_            rfc-2822 date of scan
  _STARS(*)_        one "*" (use any character) for each full score point
                    (note: limited to 50 'stars')
- _RELAYSTRUSTED_   relays used and deemed to be trusted
- _RELAYSUNTRUSTED_ relays used that can not be trusted
- _RELAYSINTERNAL_  relays used and deemed to be internal
- _RELAYSEXTERNAL_  relays used and deemed to be external
+ _RELAYSTRUSTED_   relays used and deemed to be trusted (see the
+                   'X-Spam-Relays-Trusted' pseudo-header)
+ _RELAYSUNTRUSTED_ relays used that can not be trusted (see the
+                   'X-Spam-Relays-Untrusted' pseudo-header)
+ _RELAYSINTERNAL_  relays used and deemed to be internal (see the
+                   'X-Spam-Relays-Internal' pseudo-header)
+ _RELAYSEXTERNAL_  relays used and deemed to be external (see the
+                   'X-Spam-Relays-External' pseudo-header)
  _AUTOLEARN_       autolearn status ("ham", "no", "spam", "disabled",
                    "failed", "unavailable")
  _TESTS(,)_        tests hit separated by "," (or other separator)