1Mail::SpamAssassin::PluUgsienr::CPoynztorri(b3u)ted PerlMaDiolc:u:mSepnatmaAtsisoanssin::Plugin::Pyzor(3)
2
3
4
6 Mail::SpamAssassin::Plugin::Pyzor - perform Pyzor check of messages
7
9 loadplugin Mail::SpamAssassin::Plugin::Pyzor
10
12 Pyzor is a collaborative, networked system to detect and block spam
13 using identifying digests of messages.
14
15 See http://pyzor.org/ for more information about Pyzor.
16
18 use_pyzor (0|1) (default: 1)
19 Whether to use Pyzor, if it is available.
20
21 pyzor_fork (0|1) (default: 1)
22 Instead of running Pyzor synchronously, fork separate process for
23 it and read the results in later (similar to async DNS lookups).
24 Increases throughput. Considered experimental on Windows, where
25 default is 0.
26
27 pyzor_count_min NUMBER (default: 5)
28 This option sets how often a message's body checksum must have been
29 reported to the Pyzor server before SpamAssassin will consider the
30 Pyzor check as matched.
31
32 As most clients should not be auto-reporting these checksums, you
33 should set this to a relatively low value, e.g. 5.
34
35 pyzor_welcomelist_min NUMBER (default: 10)
36 Previously pyzor_whitelist_min which will work interchangeably
37 until 4.1.
38
39 This option sets how often a message's body checksum must have been
40 welcomelisted to the Pyzor server for SpamAssassin to consider
41 ignoring the result. Final decision is made by
42 pyzor_welcomelist_factor.
43
44 pyzor_welcomelist_factor NUMBER (default: 0.2)
45 Previously pyzor_whitelist_factor which will work interchangeably
46 until 4.1.
47
48 Ignore Pyzor result if REPORTCOUNT x NUMBER >=
49 pyzor_welcomelist_min. For default setting this means: 50 reports
50 requires 10 welcomelistings.
51
53 pyzor_timeout n (default: 5)
54 How many seconds you wait for Pyzor to complete, before scanning
55 continues without the Pyzor results. A numeric value is optionally
56 suffixed by a time unit (s, m, h, d, w, indicating seconds
57 (default), minutes, hours, days, weeks).
58
59 You can configure Pyzor to have its own per-server timeout. Set
60 this plugin's timeout with that in mind. This plugin's timeout is
61 a maximum ceiling. If Pyzor takes longer than this to complete its
62 communication with all servers, no results are used by
63 SpamAssassin.
64
65 Pyzor servers do not yet synchronize their servers, so it can be
66 beneficial to check and report to more than one. See the pyzor-
67 users mailing list for alternate servers that are not published via
68 'pyzor discover'.
69
70 If you are using multiple Pyzor servers, a good rule of thumb would
71 be to set the SpamAssassin plugin's timeout to be the same or just
72 a bit more than the per-server Pyzor timeout (e.g., 3.5 and 2 for
73 two Pyzor servers). If more than one of your Pyzor servers is
74 always timing out, consider removing one of them.
75
76 pyzor_options options
77 Specify additional options to the pyzor(1) command. Please note
78 that only characters in the range [0-9A-Za-z =,._/-] are allowed
79 for security reasons.
80
81 pyzor_path STRING
82 This option tells SpamAssassin specifically where to find the
83 "pyzor" client instead of relying on SpamAssassin to find it in the
84 current PATH. Note that if taint mode is enabled in the Perl
85 interpreter, you should use this, as the current PATH will have
86 been cleared.
87
88
89
90perl v5.36.0 2023-01-2M1ail::SpamAssassin::Plugin::Pyzor(3)