svn commit: rev 46068 - spamassassin/branches/3.0/lib/Mail/SpamAssassin

[fe...@apache.org]

Author: felicity
Date: Tue Sep 14 19:46:09 2004
New Revision: 46068

Modified:
   spamassassin/branches/3.0/lib/Mail/SpamAssassin/Plugin.pm
Log:
added documentation for the standard arguments passed to plugins of different types

Modified: spamassassin/branches/3.0/lib/Mail/SpamAssassin/Plugin.pm
==============================================================================
--- spamassassin/branches/3.0/lib/Mail/SpamAssassin/Plugin.pm	(original)
+++ spamassassin/branches/3.0/lib/Mail/SpamAssassin/Plugin.pm	Tue Sep 14 19:46:09 2004
@@ -477,7 +477,9 @@
 
 =item The C<Mail::SpamAssassin::PerMsgStatus> object calling the rule
 
-=item any and all arguments specified in the configuration file
+=item standard arguments for the rule type in use
+
+=item any and all arguments as specified in the configuration file
 
 =back
 
@@ -500,6 +502,26 @@
 State for a single message being scanned should be stored on the C<$checker>
 object, not on the C<$self> object, since C<$self> persists between scan
 operations.  See the 'lifecycle note' on the C<check_start()> method above.
+
+=head2 STANDARD ARGUMENTS FOR RULE TYPES
+
+Plugins will be called with the same arguments as a standard EvalTest.
+Different rule types receive different information by default:
+
+=over 4
+
+=item header tests, no extra arguments
+
+=item body tests, fully rendered message as array reference
+
+=item rawbody tests, fully decoded message as array reference
+
+=item full tests, pristine message as scalar reference
+
+=back
+
+The configuration file arguments will be passed in after the standard
+arguments.
 
 =cut