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.  Shortcir‐
18       cuiting a test will force all other pending rules to be skipped, if
19       that test is hit.
20
21       Recomended usage is to use "priority" to set rules with strong S/O val‐
22       ues (ie.  1.0) to be run first, and make instant spam or ham classifi‐
23       cation based on that.
24

CONFIGURATION SETTINGS

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

TAGS

88       The following tags are added to the set available for use in reports,
89       headers etc.:
90
91         _SC_              shortcircuit status (classification and rule name)
92         _SCRULE_          rulename that caused the shortcircuit
93         _SCTYPE_          shortcircuit classification ("spam", "ham", "default", "none")
94

SEE ALSO

96       "http://issues.apache.org/SpamAssassin/show_bug.cgi?id=3109"
97
98
99
100perl v5.8.8                       20M0a8i-l0:1:-S0p5amAssassin::Plugin::Shortcircuit(3)
Impressum