1Mail::SpamAssassin::PluUgsienr::CDoCnCt(r3i)buted Perl DMoaciulm:e:nStpaatmiAosnsassin::Plugin::DCC(3)
2
6 Mail::SpamAssassin::Plugin::DCC - perform DCC check of messages
7
9 loadplugin Mail::SpamAssassin::Plugin::DCC
10 full DCC_CHECK eval:check_dcc()
12 full DCC_CHECK_50_79 eval:check_dcc_reputation_range('50','79')
13
15 The DCC or Distributed Checksum Clearinghouse is a system of servers
16 collecting and counting checksums of millions of mail messages. The
17 counts can be used by SpamAssassin to detect and filter spam.
18 See https://www.dcc-servers.net/dcc/ for more information about DCC.
20 Note that DCC is disabled by default in "v310.pre" because its use
22 requires software that is not distributed with SpamAssassin and that
23 has license restrictions for certain commercial uses. See the DCC
24 license at https://www.dcc-servers.net/dcc/LICENSE for details.
25 Enable it by uncommenting the "loadplugin
27 Mail::SpamAssassin::Plugin::DCC" confdir/v310.pre or by adding this
28 line to your local.pre. It might also be necessary to install a DCC
29 package, port, rpm, or equivalent from your operating system
30 distributor or a tarball from the primary DCC source at
31 https://www.dcc-servers.net/dcc/#download See also
32 https://www.dcc-servers.net/dcc/INSTALL.html
33
35 The following tags are added to the set, available for use in reports,
36 header fields, other plugins, etc.:
37 _DCCB_ DCC server ID in X-DCC-*-Metrics header field name
39 _DCCR_ X-DCC-*-Metrics header field body
40 _DCCREP_ DCC Reputation or percent bulk mail (0..100) from
41 commercial DCC software
42
44 use_dcc (0|1) (default: 1)
45 Whether to use DCC, if it is available.
46 dcc_body_max NUMBER
48 dcc_fuz1_max NUMBER
49 dcc_fuz2_max NUMBER
50 Sets how often a message's body/fuz1/fuz2 checksum must have been
51 reported to the DCC server before SpamAssassin will consider the
52 DCC check hit. 999999 is DCC's MANY count.
53 The default is 999999 for all these options.
55 dcc_rep_percent NUMBER
57 Only the commercial DCC software provides DCC Reputations. A DCC
58 Reputation is the percentage of bulk mail received from the last
59 untrusted relay in the path taken by a mail message as measured by
60 all commercial DCC installations. See
61 http://www.rhyolite.com/dcc/reputations.html You "must" whitelist
62 your trusted relays or MX servers with MX or MXDCC lines in
63 /var/dcc/whiteclnt as described in the main DCC man page to avoid
64 seeing your own MX servers as sources of bulk mail. See
65 https://www.dcc-servers.net/dcc/dcc-tree/dcc.html#White-and-Blacklists
66 The default is 90.
67
69 dcc_timeout n (default: 8)
70 How many seconds you wait for DCC to complete, before scanning
71 continues without the DCC results. A numeric value is optionally
72 suffixed by a time unit (s, m, h, d, w, indicating seconds
73 (default), minutes, hours, days, weeks).
74 dcc_home STRING
76 This option tells SpamAssassin where to find the dcc homedir. If
77 not specified, try to use the locally configured directory from the
78 "cdcc homedir" command. Try /var/dcc if that command fails.
79 dcc_dccifd_path STRING
81 This option tells SpamAssassin where to find the dccifd socket
82 instead of a local Unix socket named "dccifd" in the "dcc_home"
83 directory. If a socket is specified or found, use it instead of
84 "dccproc".
85 If specified, "dcc_dccifd_path" is the absolute path of local Unix
87 socket or an INET socket specified as "[Host]:Port" or "Host:Port".
88 Host can be an IPv4 or IPv6 address or a host name Port is a TCP
89 port number. The brackets are required for an IPv6 address.
90 The default is "undef".
92 dcc_path STRING
94 Where to find the "dccproc" client program instead of relying on
95 SpamAssassin to find it in the current PATH or "dcc_home/bin". This
96 must often be set, because the current PATH is cleared by taint
97 mode in the Perl interpreter,
98 If a "dccifd" socket is found in "dcc_home" or specified explicitly
100 with "dcc_dccifd_path", use the dccifd(8) interface instead of
101 "dccproc".
102 The default is "undef".
104 dcc_options options
106 Specify additional options to the dccproc(8) command. Only
107 characters in the range [0-9A-Za-z ,._/-] are allowed for security
108 reasons.
109 The default is "undef".
111 dccifd_options options
113 Specify additional options to send to the dccifd daemon with the
114 ASCII protocol described on the dccifd(8) man page. Only
115 characters in the range [0-9A-Za-z ,._/-] are allowed for security
116 reasons.
117 The default is "undef".
119 dcc_learn_score n (default: undef)
121 Report messages with total scores this much larger than the
122 SpamAssassin spam threshold to DCC as spam.
123perl v5.34.0 2021-07-23Mail::SpamAssassin::Plugin::DCC(3)