1Mail::SpamAssassin::PluUgsienr::CSohnotrrticbiurtMceaudiiltP:(e:3rS)lpaDmoAcsusmaesnstiant:i:oPnlugin::Shortcircuit(3)
2
6 Mail::SpamAssassin::Plugin::Shortcircuit - short-circuit evaluation for
7 certain rules
8
10 loadplugin Mail::SpamAssassin::Plugin::Shortcircuit
11 report Content analysis details: (_SCORE_ points, _REQD_ required, s/c _SCTYPE_)
13 add_header all Status "_YESNO_, score=_SCORE_ required=_REQD_ tests=_TESTS_ shortcircuit=_SCTYPE_ autolearn=_AUTOLEARN_ version=_VERSION_"
15
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 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
27 The following configuration settings are used to control
28 shortcircuiting:
29 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 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 To override a test that uses shortcircuiting, you can set the
39 classification type to "off".
40 Note that DNS and other network lookups are launched when SA
42 reaches priority -100. If you want to shortcircuit scanning before
43 any network queries are sent, you need to set lower than -100
44 priority to any such rule, like -200 as in the examples below.
45 Shortcircuited test will be automatically set to priority -200, but
47 only if the original priority is unchanged at default 0.
48 on Shortcircuits the rest of the tests, but does not make a strict
50 classification of spam or ham. Rather, it uses the default
51 score for the rule being shortcircuited. This would allow you,
52 for example, to define a rule such as
53 body TEST /test/
55 describe TEST test rule that scores barely over spam threshold
56 score TEST 5.5
57 priority TEST -200
58 shortcircuit TEST on
59 The result of a message hitting the above rule would be a final
61 score of 5.5, as opposed to 100 (default) if it were classified
62 as spam.
63 off Disables shortcircuiting on said rule.
65 spam
67 Shortcircuit the rule using a set of defaults; override the
68 default score of this rule with the score from
69 "shortcircuit_spam_score", set the "noautolearn" tflag, and set
70 priority to -200. In other words, equivalent to:
71 shortcircuit TEST on
73 priority TEST -200
74 score TEST 100
75 tflags TEST noautolearn
76 ham Shortcircuit the rule using a set of defaults; override the
78 default score of this rule with the score from
79 "shortcircuit_ham_score", set the "noautolearn" and "nice"
80 tflags, and set priority to -200. In other words, equivalent
81 to:
82 shortcircuit TEST on
84 priority TEST -200
85 score TEST -100
86 tflags TEST noautolearn nice
87 shortcircuit_spam_score n.nn (default: 100)
89 When shortcircuit is used on a rule, and the shortcircuit
90 classification type is set to "spam", this value should be applied
91 in place of the default score for that rule.
92 shortcircuit_ham_score n.nn (default: -100)
94 When shortcircuit is used on a rule, and the shortcircuit
95 classification type is set to "ham", this value should be applied
96 in place of the default score for that rule.
97
99 The following tags are added to the set available for use in reports,
100 headers etc.:
101 _SC_ shortcircuit status (classification and rule name)
103 _SCRULE_ rulename that caused the shortcircuit
104 _SCTYPE_ shortcircuit classification ("spam", "ham", "default", "none")
105
107 "https://issues.apache.org/SpamAssassin/show_bug.cgi?id=3109"
108perl v5.36.0 20M2a3i-l0:1:-S2p1amAssassin::Plugin::Shortcircuit(3)