summaryrefslogtreecommitdiff
path: root/mail/mailscanner/files/patch-docs:man:MailScanner.conf.5.html
diff options
context:
space:
mode:
authorPav Lucistnik <pav@FreeBSD.org>2005-07-08 20:31:40 +0000
committerPav Lucistnik <pav@FreeBSD.org>2005-07-08 20:31:40 +0000
commitcd3d9e6455e2dd75b37d8e28d8502b20fd4e7eae (patch)
tree59d858e19c69ae2218bac91c44dae152c4e52eef /mail/mailscanner/files/patch-docs:man:MailScanner.conf.5.html
parent775ddef518e5da0c879b922f665de0c8fe3a0263 (diff)
Notes
Diffstat (limited to 'mail/mailscanner/files/patch-docs:man:MailScanner.conf.5.html')
-rw-r--r--mail/mailscanner/files/patch-docs:man:MailScanner.conf.5.html402
1 files changed, 141 insertions, 261 deletions
diff --git a/mail/mailscanner/files/patch-docs:man:MailScanner.conf.5.html b/mail/mailscanner/files/patch-docs:man:MailScanner.conf.5.html
index 72a307d09392..f7d67eb8710a 100644
--- a/mail/mailscanner/files/patch-docs:man:MailScanner.conf.5.html
+++ b/mail/mailscanner/files/patch-docs:man:MailScanner.conf.5.html
@@ -1,70 +1,43 @@
---- ../MailScanner-install-4.42.9.orig/docs/man/MailScanner.conf.5.html Wed Jun 1 11:24:25 2005
-+++ docs/man/MailScanner.conf.5.html Wed Jun 1 11:30:17 2005
+--- ../MailScanner-install-4.43.8.orig/docs/man/MailScanner.conf.5.html Fri Jul 8 14:17:05 2005
++++ docs/man/MailScanner.conf.5.html Fri Jul 8 14:17:25 2005
@@ -1,5 +1,5 @@
<!-- Creator : groff version 1.19 -->
--<!-- CreationDate: Mon Jan 17 15:53:41 2005 -->
-+<!-- CreationDate: Wed Jun 1 11:29:47 2005 -->
+-<!-- CreationDate: Wed Jun 1 11:29:47 2005 -->
++<!-- CreationDate: Fri Jul 8 14:16:24 2005 -->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
-@@ -120,13 +120,15 @@
- directories within the MailScanner installation and in the
- section &quot;RULESETS&quot; later in this manpage.</p>
+@@ -34,6 +34,7 @@
+ <a href="#Definitions of virus scanners and spam detectors">Definitions of virus scanners and spam detectors</a><br>
+ <a href="#Spam detection and spam lists (DNS blocklists)">Spam detection and spam lists (DNS blocklists)</a><br>
+ <a href="#SpamAssassin">SpamAssassin</a><br>
++<a href="#Custom Spam Scanner Plugin">Custom Spam Scanner Plugin</a><br>
+ <a href="#What to do with spam">What to do with spam</a><br>
+ <a href="#System logging">System logging</a><br>
+ <a href="#Advanced SpamAssassin Settings">Advanced SpamAssassin Settings</a><br>
+@@ -4909,10 +4910,239 @@
+ <td width="78%">
+ <p>Default: no</p>
<!-- INDENTATION -->
--<p>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&rsquo;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.</p>
-+<p>The options are best listed in a few categories. If this
-+list looks very large then don&rsquo;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.</p>
-+<!-- INDENTATION -->
-+<p>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.</p>
- <!-- INDENTATION -->
- <p>You should define the following variables:</p>
- </td>
-@@ -220,6 +222,54 @@
- headers.</p>
- </td>
- </table>
-+<!-- INDENTATION -->
-+<table width="100%" border=0 rules="none" frame="void"
-+ cols="2" cellspacing="0" cellpadding="0">
-+<tr valign="top" align="left">
-+<td width="11%"></td>
-+<td width="89%">
-+<p><b>%org&minus;long&minus;name%</b></p></td>
-+</table>
-+<!-- INDENTATION -->
-+<table width="100%" border=0 rules="none" frame="void"
-+ cols="2" cellspacing="0" cellpadding="0">
-+<tr valign="top" align="left">
-+<td width="22%"></td>
-+<td width="78%">
-+<p>Default: Your Organisation Name Here</p>
-+<!-- INDENTATION -->
-+<p>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 &quot;0 sequences in the text. These will be
-+replaced by line&minus;breaks.</p>
+-<p># 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</p>
++<p>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.</p>
+</td>
+</table>
++<a name="Custom Spam Scanner Plugin"></a>
++<h2>Custom Spam Scanner Plugin</h2>
+<!-- INDENTATION -->
+<table width="100%" border=0 rules="none" frame="void"
+ cols="2" cellspacing="0" cellpadding="0">
+<tr valign="top" align="left">
+<td width="11%"></td>
+<td width="89%">
-+<p><b>%web&minus;site%</b></p></td>
++<p><b>Use Custom Spam Scanner</b></p></td>
+</table>
+<!-- INDENTATION -->
+<table width="100%" border=0 rules="none" frame="void"
@@ -72,170 +45,117 @@
+<tr valign="top" align="left">
+<td width="22%"></td>
+<td width="78%">
-+<p>Default: www.your&minus;organisation.com</p>
++<p>Default: no</p>
+<!-- INDENTATION -->
-+<p>Enter the location of your organisation&rsquo;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.</p>
++<p>Use the Custom Spam Scanner. This is code you will have
++to write yourself, a function called
++&quot;GenericSpamScanner&quot; stored in the file
++&quot;MailScanner/lib/MailScanner/CustomFunctions/GenericSpamScanner.pm&quot;.
++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</p>
+</td>
+</table>
- <a name="System Settings"></a>
- <h2>System Settings</h2>
- <!-- INDENTATION -->
-@@ -1071,6 +1121,54 @@
- <tr valign="top" align="left">
- <td width="11%"></td>
- <td width="89%">
-+<p><b>Unrar Command</b></p></td>
-+</table>
-+<!-- INDENTATION -->
++<!-- TABS -->
+<table width="100%" border=0 rules="none" frame="void"
-+ cols="2" cellspacing="0" cellpadding="0">
++ cols="5" cellspacing="0" cellpadding="0">
+<tr valign="top" align="left">
+<td width="22%"></td>
-+<td width="78%">
-+<p>Default: /usr/bin/unrar</p>
-+<!-- INDENTATION -->
-+<p>Where the &quot;unrar&quot; command is installed. If you
-+haven&rsquo;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&minus;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.</p>
++<td width="1%">
++
++<p>&bull;</p>
++</td>
++<td width="5%"></td>
++<td width="4%">
++
++<p>$IP</p>
++</td>
++<td width="68%">
+</td>
-+</table>
-+<!-- INDENTATION -->
-+<table width="100%" border=0 rules="none" frame="void"
-+ cols="2" cellspacing="0" cellpadding="0">
-+<tr valign="top" align="left">
-+<td width="11%"></td>
-+<td width="89%">
-+<p><b>Unrar Timeout</b></p></td>
-+</table>
-+<!-- INDENTATION -->
-+<table width="100%" border=0 rules="none" frame="void"
-+ cols="2" cellspacing="0" cellpadding="0">
+<tr valign="top" align="left">
+<td width="22%"></td>
-+<td width="78%">
-+<p>Default: 50</p>
-+<!-- INDENTATION -->
-+<p>The maximum length of time the &quot;unrar&quot; command
-+is allowed to run for 1 RAR archive (in seconds)</p>
++<td width="1%"></td>
++<td width="5%"></td>
++<td width="4%">
++</td>
++<td width="68%">
++
++<p>&minus; the numeric IP address of the system on the
++remote end of the SMTP connections</p>
+</td>
+</table>
-+<!-- INDENTATION -->
-+<table width="100%" border=0 rules="none" frame="void"
-+ cols="2" cellspacing="0" cellpadding="0">
-+<tr valign="top" align="left">
-+<td width="11%"></td>
-+<td width="89%">
- <p><b>Block Encrypted Messages</b></p></td>
- </table>
- <!-- INDENTATION -->
-@@ -1638,6 +1736,90 @@
- scanner, not the &quot;clamav&quot; scanner setting.</p>
- </td>
- </table>
-+<!-- INDENTATION -->
-+<table width="100%" border=0 rules="none" frame="void"
-+ cols="2" cellspacing="0" cellpadding="0">
-+<tr valign="top" align="left">
-+<td width="11%"></td>
-+<td width="89%">
-+<p><b>ClamAVmodule Maximum Recursion Level</b></p></td>
-+</table>
-+<!-- INDENTATION -->
++<!-- TABS -->
+<table width="100%" border=0 rules="none" frame="void"
-+ cols="2" cellspacing="0" cellpadding="0">
++ cols="7" cellspacing="0" cellpadding="0">
+<tr valign="top" align="left">
+<td width="22%"></td>
-+<td width="78%">
-+<p>Default: 5</p>
-+<!-- INDENTATION -->
-+<p>ClamAVModule only: The maximum recursion level of
-+archives. This setting *cannot* be the filename of a
-+ruleset, only a simple number.</p>
++<td width="1%">
++
++<p>&bull;</p>
++</td>
++<td width="5%"></td>
++<td width="7%">
++
++<p>$From</p>
++</td>
++<td width="2%"></td>
++<td width="8%">
++
++<p>&minus; the address of the envelope sender of the
++message</p>
++</td>
++<td width="55%">
+</td>
+</table>
-+<!-- INDENTATION -->
-+<table width="100%" border=0 rules="none" frame="void"
-+ cols="2" cellspacing="0" cellpadding="0">
-+<tr valign="top" align="left">
-+<td width="11%"></td>
-+<td width="89%">
-+<p><b>ClamAVmodule Maximum Files</b></p></td>
-+</table>
-+<!-- INDENTATION -->
++<!-- TABS -->
+<table width="100%" border=0 rules="none" frame="void"
-+ cols="2" cellspacing="0" cellpadding="0">
++ cols="6" cellspacing="0" cellpadding="0">
+<tr valign="top" align="left">
+<td width="22%"></td>
-+<td width="78%">
-+<p>Default: 100</p>
-+<!-- INDENTATION -->
-+<p>ClamAVModule only: The maximum number of files per batch.
-+This setting *cannot* be the filename of a ruleset, only a
-+simple number.</p>
++<td width="1%">
++
++<p>&bull;</p>
++</td>
++<td width="5%"></td>
++<td width="9%">
++
++<p>$To</p>
++</td>
++<td width="8%"></td>
++<td width="55%">
+</td>
-+</table>
-+<!-- INDENTATION -->
-+<table width="100%" border=0 rules="none" frame="void"
-+ cols="2" cellspacing="0" cellpadding="0">
-+<tr valign="top" align="left">
-+<td width="11%"></td>
-+<td width="89%">
-+<p><b>ClamAVmodule Maximum File Size</b></p></td>
-+</table>
-+<!-- INDENTATION -->
-+<table width="100%" border=0 rules="none" frame="void"
-+ cols="2" cellspacing="0" cellpadding="0">
+<tr valign="top" align="left">
+<td width="22%"></td>
-+<td width="78%">
-+<p>Default: 10000000</p>
-+<!-- INDENTATION -->
-+<p>ClamAVModule only: The maximum file of each file (Default
-+= 10MB). This setting *cannot* be the filename of a ruleset,
-+only a simple number.</p>
++<td width="1%"></td>
++<td width="5%"></td>
++<td width="9%">
++</td>
++<td width="8%">
++
++<p>&minus; a perl reference to the envelope recipients of
++the message</p>
++</td>
++<td width="55%">
+</td>
+</table>
-+<!-- INDENTATION -->
-+<table width="100%" border=0 rules="none" frame="void"
-+ cols="2" cellspacing="0" cellpadding="0">
-+<tr valign="top" align="left">
-+<td width="11%"></td>
-+<td width="89%">
-+<p>ClamAVmodule Maximum Compression Ratio</p></td>
-+</table>
-+<!-- INDENTATION -->
++<!-- TABS -->
+<table width="100%" border=0 rules="none" frame="void"
-+ cols="2" cellspacing="0" cellpadding="0">
++ cols="5" cellspacing="0" cellpadding="0">
+<tr valign="top" align="left">
+<td width="22%"></td>
-+<td width="78%">
-+<p>Default: 250</p>
-+<!-- INDENTATION -->
-+<p>ClamAVModule only: The maximum compression ration of
-+archives. This setting *cannot* be the filename of a
-+ruleset, only a simple number.</p>
++<td width="1%">
++
++<p>&bull;</p>
++</td>
++<td width="5%"></td>
++<td width="12%">
++
++<p>$Message</p>
++</td>
++<td width="60%">
+</td>
-+</table>
- <a name="Removing/Logging dangerous or potentially offensive content"></a>
- <h2>Removing/Logging dangerous or potentially offensive content</h2>
- <!-- INDENTATION -->
-@@ -1761,6 +1943,33 @@
- <tr valign="top" align="left">
- <td width="11%"></td>
- <td width="89%">
-+<p><b>Phishing Safe Sites File</b></p></td>
+</table>
+<!-- INDENTATION -->
+<table width="100%" border=0 rules="none" frame="void"
@@ -243,18 +163,8 @@
+<tr valign="top" align="left">
+<td width="22%"></td>
+<td width="78%">
-+<p>Default: %etc&minus;dir%/phishing.safe.sites.conf</p>
-+<!-- INDENTATION -->
-+<p>There are some companies, such as banks, that insist on
-+sending out email messages with links in them that are
-+caught by the &quot;Find Phishing Fraud&quot; 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.</p>
-+</td>
++<p>&minus; a perl reference to the list of line of the
++message</p></td>
+</table>
+<!-- INDENTATION -->
+<table width="100%" border=0 rules="none" frame="void"
@@ -262,14 +172,7 @@
+<tr valign="top" align="left">
+<td width="11%"></td>
+<td width="89%">
- <p><b>Allow IFrame Tags</b></p></td>
- </table>
- <!-- INDENTATION -->
-@@ -3617,6 +3826,50 @@
- <tr valign="top" align="left">
- <td width="11%"></td>
- <td width="89%">
-+<p><b>Disarmed Modify Subject</b></p></td>
++<p><b>Max Custom Spam Scanner Size</b></p></td>
+</table>
+<!-- INDENTATION -->
+<table width="100%" border=0 rules="none" frame="void"
@@ -277,13 +180,13 @@
+<tr valign="top" align="left">
+<td width="22%"></td>
+<td width="78%">
-+<p>Default: yes</p>
++<p>Default: 20000</p>
+<!-- INDENTATION -->
-+<p>If HTML tags in the message were &quot;disarmed&quot; by
-+using the HTML &quot;Allow&quot; options above with the
-+&quot;disarm&quot; settings, do you want to modify the
-+subject line? This can also be the filename of a
-+ruleset.</p>
++<p>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.</p>
+</td>
+</table>
+<!-- INDENTATION -->
@@ -292,7 +195,7 @@
+<tr valign="top" align="left">
+<td width="11%"></td>
+<td width="89%">
-+<p><b>Disarmed Subject Text</b></p></td>
++<p><b>Custom Spam Scanner Timeout</b></p></td>
+</table>
+<!-- INDENTATION -->
+<table width="100%" border=0 rules="none" frame="void"
@@ -300,11 +203,12 @@
+<tr valign="top" align="left">
+<td width="22%"></td>
+<td width="78%">
-+<p>Default: {Disarmed}</p>
++<p>Default: 20</p>
+<!-- INDENTATION -->
-+<p>This is the text to add to the start of the subject if
-+the &quot;Disarmed Modify Subject&quot; option is set. This
-+can also be the filename of a ruleset.</p>
++<p>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&minus;of&minus;service attacks.</p>
+</td>
+</table>
+<!-- INDENTATION -->
@@ -313,14 +217,7 @@
+<tr valign="top" align="left">
+<td width="11%"></td>
+<td width="89%">
- <p><b>Spam Modify Subject</b></p></td>
- </table>
- <!-- INDENTATION -->
-@@ -4118,6 +4371,33 @@
- <tr valign="top" align="left">
- <td width="11%"></td>
- <td width="89%">
-+<p><b>Spam Lists To Be Spam</b></p></td>
++<p><b>Max Custom Spam Scanner Timeouts</b></p></td>
+</table>
+<!-- INDENTATION -->
+<table width="100%" border=0 rules="none" frame="void"
@@ -328,17 +225,11 @@
+<tr valign="top" align="left">
+<td width="22%"></td>
+<td width="78%">
-+<p>Default: 1</p>
++<p>Default: 10</p>
+<!-- INDENTATION -->
-+<p>If a message appears in at least this number of
-+&quot;Spam Lists&quot; (as defined above), then the message
-+will be treated as spam and so the &quot;Spam Actions&quot;
-+will happen, unless the message reaches the levels for
-+&quot;High Scoring Spam&quot;. By default this is set to 1
-+to mimic the previous behaviour, which means that appearing
-+in any &quot;Spam Lists&quot; will cause the message to be
-+treated as spam. This can also be the filename of a
-+ruleset.</p>
++<p>If the Custom Spam Scanner times out more times in a row
++than this, then it will be marked as &quot;unavailable&quot;
++until MailScanner next re&minus;starts itself.</p>
+</td>
+</table>
+<!-- INDENTATION -->
@@ -347,22 +238,7 @@
+<tr valign="top" align="left">
+<td width="11%"></td>
+<td width="89%">
- <p><b>Spam Lists To Reach High Score</b></p></td>
- </table>
- <!-- INDENTATION -->
-@@ -5122,6 +5402,28 @@
- <p>Log all occurrences of &quot;Silent Viruses&quot; as
- defined above? This can only be a simple yes/no value, not a
- ruleset.</p>
-+</td>
-+</table>
-+<!-- INDENTATION -->
-+<table width="100%" border=0 rules="none" frame="void"
-+ cols="2" cellspacing="0" cellpadding="0">
-+<tr valign="top" align="left">
-+<td width="11%"></td>
-+<td width="89%">
-+<p><b>Log Dangerous HTML Tags</b></p></td>
++<p><b>Custom Spam Scanner Timeout History</b></p></td>
+</table>
+<!-- INDENTATION -->
+<table width="100%" border=0 rules="none" frame="void"
@@ -370,12 +246,16 @@
+<tr valign="top" align="left">
+<td width="22%"></td>
+<td width="78%">
-+<p>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.</p>
++<p>Default: 20</p>
++<!-- INDENTATION -->
++<p>The total number of Custom Spam Scanner attempts during
++which &quot;Max Custom Spam Scanner Timeouts&quot; will
++cause the Custom Spam Scanner to be marked as
++&quot;unavailable&quot;. 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 &quot;Restart Every&quot;).</p>
</td>
</table>
- <a name="Advanced SpamAssassin Settings"></a>
+ <a name="What to do with spam"></a>