Mail::SpamAssassin::Plugin::Shortcircuit(3pm)

1Mail::SpamAssassin::PluUgsienr::CSohnotrrticbiurtMceaudiiltP:(e:3rS)lpaDmoAcsusmaesnstiant:i:oPnlugin::Shortcircuit(3)
2
3
4

NAME

6       Mail::SpamAssassin::Plugin::Shortcircuit - short-circuit evaluation for
7       certain rules
8

SYNOPSIS

10         loadplugin     Mail::SpamAssassin::Plugin::Shortcircuit
11
12         report Content analysis details:   (_SCORE_ points, _REQD_ required, s/c _SCTYPE_)
13
14         add_header all Status "_YESNO_, score=_SCORE_ required=_REQD_ tests=_TESTS_ shortcircuit=_SCTYPE_ autolearn=_AUTOLEARN_ version=_VERSION_"
15

DESCRIPTION

17       This plugin implements simple, test-based shortcircuiting.
18       Shortcircuiting a test will force all other pending rules to be
19       skipped, if that test is hit.  In addition, a symbolic rule,
20       "SHORTCIRCUIT", will fire.
21
22       Recommended usage is to use "priority" to set rules with strong S/O
23       values (ie.  1.0) to be run first, and make instant spam or ham
24       classification based on that.
25

CONFIGURATION SETTINGS

27       The following configuration settings are used to control
28       shortcircuiting:
29
30       shortcircuit SYMBOLIC_TEST_NAME {ham|spam|on|off}
31           Shortcircuiting a test will force all other pending rules to be
32           skipped, if that test is hit.
33
34           Recommended usage is to use "priority" to set rules with strong S/O
35           values (ie.  1.0) to be run first, and make instant spam or ham
36           classification based on that.
37
38           To override a test that uses shortcircuiting, you can set the
39           classification type to "off".
40
41           on  Shortcircuits the rest of the tests, but does not make a strict
42               classification of spam or ham.  Rather, it uses the default
43               score for the rule being shortcircuited.  This would allow you,
44               for example, to define a rule such as
45
46                 body TEST /test/
47                 describe TEST test rule that scores barely over spam threshold
48                 score TEST 5.5
49                 priority TEST -100
50                 shortcircuit TEST on
51
52               The result of a message hitting the above rule would be a final
53               score of 5.5, as opposed to 100 (default) if it were classified
54               as spam.
55
56           off Disables shortcircuiting on said rule.
57
58           spam
59               Shortcircuit the rule using a set of defaults; override the
60               default score of this rule with the score from
61               "shortcircuit_spam_score", set the "noautolearn" tflag, and set
62               priority to "-100".  In other words, equivalent to:
63
64                 shortcircuit TEST on
65                 priority TEST -100
66                 score TEST 100
67                 tflags TEST noautolearn
68
69           ham Shortcircuit the rule using a set of defaults; override the
70               default score of this rule with the score from
71               "shortcircuit_ham_score", set the "noautolearn" and "nice"
72               tflags, and set priority to "-100".   In other words,
73               equivalent to:
74
75                 shortcircuit TEST on
76                 priority TEST -100
77                 score TEST -100
78                 tflags TEST noautolearn nice
79
80       shortcircuit_spam_score n.nn (default: 100)
81           When shortcircuit is used on a rule, and the shortcircuit
82           classification type is set to "spam", this value should be applied
83           in place of the default score for that rule.
84
85       shortcircuit_ham_score n.nn (default: -100)
86           When shortcircuit is used on a rule, and the shortcircuit
87           classification type is set to "ham", this value should be applied
88           in place of the default score for that rule.
89

NAME

SYNOPSIS

DESCRIPTION

CONFIGURATION SETTINGS

TAGS

SEE ALSO