svn commit: r169594 - /spamassassin/trunk/lib/Mail/SpamAssassin/Plugin.pm

[jm...@apache.org]

Author: jm
Date: Wed May 11 00:19:25 2005
New Revision: 169594

URL: http://svn.apache.org/viewcvs?rev=169594&view=rev
Log:
bug 4312: fix doco for plugin_report and plugin_revoke APIs

Modified:
    spamassassin/trunk/lib/Mail/SpamAssassin/Plugin.pm

Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Plugin.pm
URL: http://svn.apache.org/viewcvs/spamassassin/trunk/lib/Mail/SpamAssassin/Plugin.pm?rev=169594&r1=169593&r2=169594&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Plugin.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Plugin.pm Wed May 11 00:19:25 2005
@@ -547,41 +547,50 @@
 
 =item $plugin->plugin_report ( { options ... } )
 
-Called if the message is to be reported as spam.
+Called if the message is to be reported as spam.  If the reporting system is
+available, the variable C<$options-<gt>{report}-><gt>report_available}> should
+be set to C<1>; if the reporting system successfully reported the message, the
+variable C<$options-<gt>{report}-><gt>report_return}> should be set to C<1>.
 
 =over 4
 
 =item report
 
-Reference to the Reporter object
+Reference to the Reporter object (C<$options-<gt>{report}> in the
+paragraph above.)
 
 =item text
 
-Reference to a markup removed copy of the message in scalar format
+Reference to a markup removed copy of the message in scalar string format.
 
 =item msg
 
-Reference to the original message object
+Reference to the original message object.
 
 =back
 
 =item $plugin->plugin_revoke ( { options ... } )
 
-Called if the message is to be reported as ham (revokes a spam report).
+Called if the message is to be reported as ham (revokes a spam report). If the
+reporting system is available, the variable
+C<$options-<gt>{revoke}-><gt>revoke_available}> should be set to C<1>; if the
+reporting system successfully revoked the message, the variable
+C<$options-<gt>{revoke}-><gt>revoke_return}> should be set to C<1>.
 
 =over 4
 
 =item revoke
 
-Reference to the Reporter object
+Reference to the Reporter object (C<$options-<gt>{revoke}> in the
+paragraph above.)
 
 =item text
 
-Reference to a markup removed copy of the message in scalar format
+Reference to a markup removed copy of the message in scalar string format.
 
 =item msg
 
-Reference to the original message object
+Reference to the original message object.
 
 =back