Mailing List Archive

Author: jm
Date: Fri Jan 19 04:29:25 2007
New Revision: 497791

URL: http://svn.apache.org/viewvc?view=rev&rev=497791
Log:
hmm. we'd forgotten to document the 'have_shortcircuited' plugin hook; I wonder if we can hook up some greppy magic in the test suite to catch this kind of omission in future

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

Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Plugin.pm
URL: http://svn.apache.org/viewvc/spamassassin/trunk/lib/Mail/SpamAssassin/Plugin.pm?view=diff&rev=497791&r1=497790&r2=497791
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Plugin.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Plugin.pm Fri Jan 19 04:29:25 2007
@@ -557,6 +557,24 @@

=back

+
+=item $plugin->have_shortcircuited ( { options ... } )
+
+Has the current scan operation 'short-circuited'? In other words, can
+further scanning be skipped, since the message is already definitively
+classified as either spam or ham?
+
+Plugins should return C<0> to indicate that scanning should continue,
+or C<1> to indicate that short-circuiting has taken effect.
+
+=over 4
+
+=item permsgstatus
+
+The C<Mail::SpamAssassin::PerMsgStatus> context object for this scan.
+
+=back
+
=item $plugin->bayes_learn ( { options ... } )

Called at the end of a bayes learn operation.