You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@spamassassin.apache.org by fe...@apache.org on 2005/04/25 04:11:55 UTC
svn commit: r164517 -
/spamassassin/branches/3.0/lib/Mail/SpamAssassin/PerMsgStatus.pm
/spamassassin/branches/3.0/lib/Mail/SpamAssassin/Plugin.pm
Author: felicity
Date: Sun Apr 24 19:11:54 2005
New Revision: 164517
URL: http://svn.apache.org/viewcvs?rev=164517&view=rev
Log:
bug 4092: plugin API for set_tag wasn't documented, get_tag was missing.
Modified:
spamassassin/branches/3.0/lib/Mail/SpamAssassin/PerMsgStatus.pm
spamassassin/branches/3.0/lib/Mail/SpamAssassin/Plugin.pm
Modified: spamassassin/branches/3.0/lib/Mail/SpamAssassin/PerMsgStatus.pm
URL: http://svn.apache.org/viewcvs/spamassassin/branches/3.0/lib/Mail/SpamAssassin/PerMsgStatus.pm?rev=164517&r1=164516&r2=164517&view=diff
==============================================================================
--- spamassassin/branches/3.0/lib/Mail/SpamAssassin/PerMsgStatus.pm (original)
+++ spamassassin/branches/3.0/lib/Mail/SpamAssassin/PerMsgStatus.pm Sun Apr 24 19:11:54 2005
@@ -1032,6 +1032,17 @@
} @{$info}[0..$amt-1];
}
+###########################################################################
+
+# public API for plugins
+=item $status->set_tag($tagname, $value)
+
+Set a template tag, as used in C<add_header>, report templates, etc. This API
+is intended for use by plugins. Tag names will be converted to an
+all-uppercase representation internally. See C<Mail::SpamAssassin::Conf>'s
+C<TEMPLATE TAGS> section for more details on tags.
+
+=cut
sub set_tag {
my $self = shift;
@@ -1041,6 +1052,23 @@
$self->{tag_data}->{$tag} = $val;
}
+# public API for plugins
+=item $string = $status->get_tag($tagname)
+
+Get the current value of a template tag, as used in C<add_header>, report
+templates, etc. This API is intended for use by plugins. Tag names will be
+converted to an all-uppercase representation internally. See
+C<Mail::SpamAssassin::Conf>'s C<TEMPLATE TAGS> section for more details on
+tags.
+
+=cut
+
+sub get_tag {
+ # expose this previously-private API
+ return shift->_get_tag(uc shift);
+}
+
+###########################################################################
sub _get_tag_value_for_yesno {
my $self = shift;
Modified: spamassassin/branches/3.0/lib/Mail/SpamAssassin/Plugin.pm
URL: http://svn.apache.org/viewcvs/spamassassin/branches/3.0/lib/Mail/SpamAssassin/Plugin.pm?rev=164517&r1=164516&r2=164517&view=diff
==============================================================================
--- spamassassin/branches/3.0/lib/Mail/SpamAssassin/Plugin.pm (original)
+++ spamassassin/branches/3.0/lib/Mail/SpamAssassin/Plugin.pm Sun Apr 24 19:11:54 2005
@@ -598,6 +598,8 @@
C<Mail::SpamAssassin::PerMsgStatus>
+http://wiki.apache.org/spamassassin/PluginWritingTips
+
http://bugzilla.spamassassin.org/show_bug.cgi?id=2163
=cut