diff options
Diffstat (limited to 'mail/mailscanner/files/patch-docs:man:MailScanner.conf.5')
| -rw-r--r-- | mail/mailscanner/files/patch-docs:man:MailScanner.conf.5 | 178 |
1 files changed, 39 insertions, 139 deletions
diff --git a/mail/mailscanner/files/patch-docs:man:MailScanner.conf.5 b/mail/mailscanner/files/patch-docs:man:MailScanner.conf.5 index 46a89f48bd82..2e1ab3bf0ab8 100644 --- a/mail/mailscanner/files/patch-docs:man:MailScanner.conf.5 +++ b/mail/mailscanner/files/patch-docs:man:MailScanner.conf.5 @@ -1,177 +1,77 @@ ---- ../MailScanner-install-4.42.9.orig/docs/man/MailScanner.conf.5 Wed Jun 1 11:24:25 2005 -+++ docs/man/MailScanner.conf.5 Wed Jun 1 11:30:13 2005 +--- ../MailScanner-install-4.43.8.orig/docs/man/MailScanner.conf.5 Fri Jul 8 14:17:05 2005 ++++ docs/man/MailScanner.conf.5 Fri Jul 8 14:17:23 2005 @@ -1,4 +1,4 @@ --.TH "MailScanner.conf" "5" "4.38.2" "Julian Field" "Mail" -+.TH "MailScanner.conf" "5" "4.42.9" "Julian Field" "Mail" +-.TH "MailScanner.conf" "5" "4.42.9" "Julian Field" "Mail" ++.TH "MailScanner.conf" "5" "4.43.8" "Julian Field" "Mail" .SH "NAME" .LP MailScanner.conf \- Main configuration for MailScanner -@@ -27,7 +27,9 @@ - Many of the options can also be the filename of a ruleset, which can be used to control features depending on the addresses of the message, and/or the IP address where the message came from. You will find some examples of rulesets and an explanation of them in the "rules" directories within the MailScanner installation and in the section "RULESETS" later in this manpage. - - .LP --The options are best listed in a few categories. This is also the order in which you will find them in the MailScanner.conf file. If this list looks very large then don't worry, the supplied MailScanner.conf file (or MailScanner.conf.sample) contains sensible defaults for all the values. You will probably only need to change a very few of them to start with. -+The options are best listed in a few categories. If this list looks very large then don't worry, the supplied MailScanner.conf file (or MailScanner.conf.sample) contains sensible defaults for all the values. You will probably only need to change a very few of them to start with. -+ -+Starting with version 4.40.10 of MailScanner you can use shell environment variables such as $HOSTNAME or ${HOSTNAME} in MailScanner.conf and its relatives. - - .LP - You should define the following variables: -@@ -74,6 +76,22 @@ - Enter a short identifying name for your organisation below, this is used to make the X\-MailScanner headers unique for your organisation. Multiple servers within one site should use an identical value here to avoid adding multiple redundant headers where mail has passed through several servers within your organisation. +@@ -1701,12 +1701,64 @@ .br - Note: Some Symantec scanners complain (incorrectly) about "." characters appearing in the names of headers. -+ -+.TP -+\fB%org\-long\-name%\fR -+Default: Your Organisation Name Here -+.br -+ -+.br -+Enter the full name of your organisation below, this is used in the signature placed at the bottom of report messages sent by MailScanner. It can include pretty much any text you like. You can make the result span several lines by including "\n" sequences in the text. These will be replaced by line\-breaks. -+ -+.TP -+\fB%web\-site%\fR -+Default: www.your\-organisation.com -+.br -+ -+.br -+Enter the location of your organisation's web site below. This is used in the signature placed at the bottom of report messages sent by MailScanner. It should preferably be the location of a page that you have written explaining why you might have rejected the mail and what the recipient and/or sender should do about it. - .SH "System Settings" - .TP - \fBMax Children\fR -@@ -370,6 +388,23 @@ + .br - The maximum length of time the "file" command is allowed to run for one batch of messages (in seconds). +-# 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. -+ -+.TP -+\fBUnrar Command\fR -+Default: /usr/bin/unrar -+.br -+ -+.br -+Where the "unrar" command is installed. If you haven't got this command, look at www.rarlab.com. This is used for unpacking rar archives so that the contents can be checked for banned filenames and filetypes, and also that the archive can be tested to see if it is password\-protected. Virus scanning the contents of rar archives is still left to the virus scanner, with one exception: If using the clavavmodule virus scanner, this adds external RAR checking to that scanner which is needed for archives which are RAR version 3. -+ -+.TP -+\fBUnrar Timeout\fR -+Default: 50 -+.br -+ -+.br -+The maximum length of time the "unrar" command is allowed to run for 1 RAR archive (in seconds) -+ - .TP - \fBBlock Encrypted Messages\fR - Default: no -@@ -562,6 +597,41 @@ - .br - ClamAVModule only: monitor each of these files for changes in size to detect when a ClamAV update has happened. This is only used by the "clamavmodule" virus scanner, not the "clamav" scanner setting. + ++.SH "Custom Spam Scanner Plugin" +.TP -+\fBClamAVmodule Maximum Recursion Level\fR -+Default: 5 ++\fBUse Custom Spam Scanner\fR ++Default: no +.br + +.br -+ClamAVModule only: The maximum recursion level of archives. This setting *cannot* be the filename of a ruleset, only a simple number. -+ -+.TP -+\fBClamAVmodule Maximum Files\fR -+Default: 100 ++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 -+ClamAVModule only: The maximum number of files per batch. This setting *cannot* be the filename of a ruleset, only a simple number. + + +.TP -+\fBClamAVmodule Maximum File Size\fR -+Default: 10000000 ++\fBMax Custom Spam Scanner Size\fR ++Default: 20000 +.br + +.br -+ClamAVModule only: The maximum file of each file (Default = 10MB). This setting *cannot* be the filename of a ruleset, only a simple number. -+ ++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 -+\fB\fRClamAVmodule Maximum Compression Ratio -+Default: 250 -+.br -+ -+.br -+ClamAVModule only: The maximum compression ration of archives. This setting *cannot* be the filename of a ruleset, only a simple number. -+ - .SH "Removing/Logging dangerous or potentially offensive content" - .TP - \fBAllow Partial Messages\fR -@@ -601,6 +671,15 @@ - - - .TP -+\fBPhishing Safe Sites File\fR -+Default: %etc\-dir%/phishing.safe.sites.conf ++\fBCustom Spam Scanner Timeout\fR ++Default: 20 +.br + +.br -+There are some companies, such as banks, that insist on sending out email messages with links in them that are caught by the "Find Phishing Fraud" test described above. This is the name of a file which contains a list of link destinations which should be ignored in the test. This may, for example, contain the known websites of some banks. See the file itself for more information. This can only be the name of the file containing the list, it *cannot* be the filename of a ruleset. ++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 - \fBAllow IFrame Tags\fR - Default: no - .br -@@ -1233,6 +1312,23 @@ - .br - This is the text inserted at the start of the "Subject:" line if the "Content Modify Subject" option is set. - -+.TP -+\fBDisarmed Modify Subject\fR -+Default: yes ++\fBMax Custom Spam Scanner Timeouts\fR ++Default: 10 +.br + +.br -+If HTML tags in the message were "disarmed" by using the HTML "Allow" options above with the "disarm" settings, do you want to modify the subject line? This can also be the filename of a ruleset. -+ ++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 -+\fBDisarmed Subject Text\fR -+Default: {Disarmed} ++\fBCustom Spam Scanner Timeout History\fR ++Default: 20 +.br + +.br -+This is the text to add to the start of the subject if the "Disarmed Modify Subject" option is set. This can also be the filename of a ruleset. -+ - ++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 Modify Subject\fR -@@ -1415,6 +1511,15 @@ - This provides a space\-separated list of "Spam Lists" (or RBL's or DNSBL's) which are checked for each message. These lists are based on the domain name of the sender address of each message. Every list used here must be defined in the "Spam List Definitions" file mentioned above. - - .TP -+\fBSpam Lists To Be Spam\fR -+Default: 1 -+.br -+ -+.br -+If a message appears in at least this number of "Spam Lists" (as defined above), then the message will be treated as spam and so the "Spam Actions" will happen, unless the message reaches the levels for "High Scoring Spam". By default this is set to 1 to mimic the previous behaviour, which means that appearing in any "Spam Lists" will cause the message to be treated as spam. This can also be the filename of a ruleset. -+ -+ -+.TP - \fBSpam Lists To Reach High Score\fR - Default: 5 - .br -@@ -1753,6 +1858,12 @@ - - .br - Log all occurrences of "Silent Viruses" as defined above? This can only be a simple yes/no value, not a ruleset. -+ -+.TP -+\fBLog Dangerous HTML Tags\fR -+Default: no -+.br -+Log all occurrences of HTML tags found in messages, that can be blocked. This will help you build up your whitelist of message sources for which particular HTML tags should be allowed, such as mail from newsletters and daily cartoon strips. This can also be the filename of a ruleset. - .SH "Advanced SpamAssassin Settings" - If you are using Postfix you may well need to use some of the settings below, as the home directory for the "postfix" user cannot be written to by the "postfix" user. You may also need to use these if you have installed SpamAssassin somewhere other than the default location. - + \fBSpam Actions\fR |