You are viewing a plain text version of this content. The canonical link for it is here.
Posted to users@spamassassin.apache.org by Olivier Nicole <on...@cs.ait.ac.th> on 2007/11/02 13:14:46 UTC

What is ruletype? What is type?

Hi,

I am trying to figure out how to use the method got_hit in
Mail::SpamAssassin::PerMsgStatus.

I am searching for the value to use with the ruletype bellow, as per
the documenttation on the web
(http://search.cpan.org/~jmason/Mail-SpamAssassin-3.2.3/lib/Mail/SpamAssassin/PerMsgStatus.pm)
but I found no other definition for the ruletype.

TIA,

Olivier

$status->got_hit ($rulename, $desc_prepend [, name => value, ...])

    Register a hit against a rule in the ruleset.

    There are two mandatory arguments. These are $rulename, the name
    of the rule that fired, and $desc_prepend, which is a short string
    that will be prepended to the rules describe string in output
    reports.

    In addition, callers can supplement that with the following
    optional data:

    score => $num

        Optional: the score to use for the rule hit. If unspecified,
        the value from the Mail::SpamAssassin::Conf object's {scores}
        hash will be used.

    value => $num

        Optional: the value to assign to the rule; the default value
        is 1. tflags multiple rules use values of greater than 1 to
        indicate multiple hits. This value is accessible to meta
        rules.

    ruletype => $type

        Optional, but recommended: the rule type string. This is used
        in the hit_rule plugin call, called by this method. If unset,
        'unknown' is used.