svn commit: r462702 - /spamassassin/branches/check_plugin/lib/Mail/SpamAssassin/Plugin.pm

[pa...@apache.org]

Author: parker
Date: Tue Oct 10 22:51:31 2006
New Revision: 462702

URL: http://svn.apache.org/viewvc?view=rev&rev=462702
Log:
update some documentation

Modified:
    spamassassin/branches/check_plugin/lib/Mail/SpamAssassin/Plugin.pm

Modified: spamassassin/branches/check_plugin/lib/Mail/SpamAssassin/Plugin.pm
URL: http://svn.apache.org/viewvc/spamassassin/branches/check_plugin/lib/Mail/SpamAssassin/Plugin.pm?view=diff&rev=462702&r1=462701&r2=462702
==============================================================================
--- spamassassin/branches/check_plugin/lib/Mail/SpamAssassin/Plugin.pm (original)
+++ spamassassin/branches/check_plugin/lib/Mail/SpamAssassin/Plugin.pm Tue Oct 10 22:51:31 2006
@@ -329,23 +329,9 @@
 
 =back
 
-=item $plugin->extract_metadata ( { options ... } )
-
-Signals that a message is being mined for metadata.  Some plugins may wish
-to add their own metadata as well.
-
-=over 4
-
-=item msg
-
-The C<Mail::SpamAssassin::Message> object for this message.
+=item $plugin->check_main ( { options ... } )
 
-=back
-
-=item $plugin->parsed_metadata ( { options ... } )
-
-Signals that a message's metadata has been parsed, and can now be
-accessed by the plugin.
+Signals that a message should be checked.
 
 =over 4
 
@@ -396,6 +382,59 @@
 
 =back
 
+=item $plugin->check_end ( { options ... } )
+
+Signals that a message check operation has just finished, and the
+results are about to be returned to the caller.
+
+=over 4
+
+=item permsgstatus
+
+The C<Mail::SpamAssassin::PerMsgStatus> context object for this scan.
+The current score, names of rules that hit, etc. can be retrieved
+using the public APIs on this object.
+
+=back
+
+=item $plugin->finish_tests ( { options ... } )
+
+Called via SpamAssassin::finish and should clear up any tests that a plugin
+has added to the namespace.
+
+=over 4
+
+=item conf
+
+The C<Mail::SpamAssassin::Conf> object on which the configuration
+data should be stored.
+
+=item $plugin->extract_metadata ( { options ... } )
+
+Signals that a message is being mined for metadata.  Some plugins may wish
+to add their own metadata as well.
+
+=over 4
+
+=item msg
+
+The C<Mail::SpamAssassin::Message> object for this message.
+
+=back
+
+=item $plugin->parsed_metadata ( { options ... } )
+
+Signals that a message's metadata has been parsed, and can now be
+accessed by the plugin.
+
+=over 4
+
+=item permsgstatus
+
+The C<Mail::SpamAssassin::PerMsgStatus> context object for this scan.
+
+=back
+
 =item $plugin->start_rules ( { options ... } )
 
 Called before testing a set of rules of a given type and priority.
@@ -454,21 +493,6 @@
 =item rulename
 
 The name of the rule that was tested.
-
-=back
-
-=item $plugin->check_end ( { options ... } )
-
-Signals that a message check operation has just finished, and the
-results are about to be returned to the caller.
-
-=over 4
-
-=item permsgstatus
-
-The C<Mail::SpamAssassin::PerMsgStatus> context object for this scan.
-The current score, names of rules that hit, etc. can be retrieved
-using the public APIs on this object.
 
 =back