aboutsummaryrefslogtreecommitdiffstats
path: root/mail/mailscanner/files/patch-docs:man:MailScanner.conf.5
blob: 94401810ece28d453b6ca74dbc61e90b0a0d0905 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
--- ../MailScanner-install-4.44.6.orig/docs/man/MailScanner.conf.5  Mon Aug 22 16:18:05 2005
+++ docs/man/MailScanner.conf.5 Mon Aug 22 16:18:27 2005
@@ -1,4 +1,4 @@
-.TH "MailScanner.conf" "5" "4.42.9" "Julian Field" "Mail"
+.TH "MailScanner.conf" "5" "4.44.6" "Julian Field" "Mail"
 .SH "NAME"
 .LP 
 MailScanner.conf \- Main configuration for MailScanner
@@ -326,6 +326,16 @@
 .br 
 If more messages are found in the queue than this, then switch to an "accelerated" mode of processing messages. This will cause it to stop scanning messages in strict date order, but in the order it finds them in the queue. If your queue is bigger than this size a lot of the time, then some messages could be greatly delayed. So treat this option as "in emergency only".
 
+
+.TP 
+\fBScan Messages\fR
+Default: yes
+.br 
+
+.br 
+If this is set to yes, then email messages passing through MailScanner will be processed and checked, and all the other options in this file will be used to control what checks are made on the message. If this is set to no, then email messages will NOT be processed or checked *at all*, and so any viruses or other problems will be ignored.
+
+
 .TP 
 \fBMaximum Attachments Per Message\fR
 Default: 200
@@ -1701,12 +1711,64 @@
 .br 
 
 .br 
-# The Bayesian database rebuild and expiry may take a 2 or 3 minutes
-# to complete. During this time you can either wait, or simply
-# disable SpamAssassin checks until it has completed.
-WaitDuringBayesRebuild = no
+The Bayesian database rebuild and expiry may take a 2 or 3 minutes to complete. During this time you can either wait, or simply disable SpamAssassin checks until it has completed.
+
+
+
+.SH "Custom Spam Scanner Plugin"
+.TP 
+\fBUse Custom Spam Scanner\fR
+Default: no
+.br 
+
+.br 
+Use the Custom Spam Scanner. This is code you will have to write yourself, a function called "GenericSpamScanner" stored in the file "MailScanner/lib/MailScanner/CustomFunctions/GenericSpamScanner.pm". A sample function is given in the correct file in the distribution. This sample function also includes code to show you how to make it run an external program to produce a spam score. This can also be the filename of a ruleset. The function will be passed
+.br 
+.RS 7
+.IP  \(bu 4
+$IP        \- the numeric IP address of the system on the remote end of the SMTP connections
+.IP  \(bu 4
+$From  \- the address of the envelope sender of the message
+.IP  \(bu 4
+$To        \- a perl reference to the envelope recipients of the message
+.IP  \(bu 4
+$Message   \- a perl reference to the list of line of the message
+.RE
+.br 
 
 
+.TP 
+\fBMax Custom Spam Scanner Size\fR
+Default: 20000
+.br 
+
+.br 
+How much of the message should be passed tot he Custom Spam Scanner. Most spam tools only need the first 20kbytes of the message to determine if it is spam or not. Passing more than is necessary only slows things down. This can also be the filename of a ruleset.
+
+.TP 
+\fBCustom Spam Scanner Timeout\fR
+Default: 20
+.br 
+
+.br 
+How long should the custom spam scanner take to run? If it takes more seconds than this, then it should be considered to have crashed and should be killed. This stops denial\-of\-service attacks.
+
+
+.TP 
+\fBMax Custom Spam Scanner Timeouts\fR
+Default: 10
+.br 
+
+.br 
+If the Custom Spam Scanner times out more times in a row than this, then it will be marked as "unavailable" until MailScanner next re\-starts itself.
+
+.TP 
+\fBCustom Spam Scanner Timeout History\fR
+Default: 20
+.br 
+
+.br 
+The total number of Custom Spam Scanner attempts during which "Max Custom Spam Scanner Timeouts" will cause the Custom Spam Scanner to be marked as "unavailable". See the previous comment for more information. The default values of 10 and 20 mean that 10 timeouts in any sequence of 20 attempts will trigger the behaviour described above, until the next periodic restart (see "Restart Every").
 .SH "What to do with spam"
 .TP 
 \fBSpam Actions\fR