~ubuntu-branches/ubuntu/lucid/mailscanner/lucid

« back to all changes in this revision

Viewing changes to docs/man/MailScanner.conf.5

  • Committer: Bazaar Package Importer
  • Author(s): Matthias Klose
  • Date: 2006-03-06 00:16:43 UTC
  • mfrom: (1.1.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20060306001643-oiu6lxjx90bmkual
Tags: 4.51.5-1
* New upstream version.
* etc/reports/pt_br.old: Remove from source, repackage source due to
  wrong permissions in archive.
* Update dependencies.
* debian/patches/awk-location, debian/patches/filetype.rules.conf: Remove.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.TH "MailScanner.conf" "5" "4.42.9" "Julian Field" "Mail"
 
1
.TH "MailScanner.conf" "5" "4.50.1" "Julian Field" "Mail"
2
2
.SH "NAME"
3
3
.LP 
4
4
MailScanner.conf \- Main configuration for MailScanner
326
326
.br 
327
327
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".
328
328
 
 
329
 
 
330
.TP 
 
331
\fBScan Messages\fR
 
332
Default: yes
 
333
.br 
 
334
 
 
335
.br 
 
336
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.
 
337
 
 
338
.TP 
 
339
\fBReject Messages\fR
 
340
Default: no
 
341
.br 
 
342
 
 
343
.br 
 
344
You may not want to receive mail from certain addresses and/or to certain addresses. If so, you can do this with your email transport (sendmail, Postfix, etc) but that will just send a one\-line message which is not helpful to the user sending the message. If this is set to yes, then the message set by the "Rejection Report" will be sent instead, and the incoming message will be deleted. If you want to store a copy of the original incoming message then use the "Archive Mail" setting to archive a copy of it. The purpose of this option is to set it to be a ruleset, so that you can reject messages from a few offending addresses where you need to  send a polite reply instead of just a brief 1\-line rejection message.
 
345
 
329
346
.TP 
330
347
\fBMaximum Attachments Per Message\fR
331
348
Default: 200
819
836
Do you want to allow <Form> tags in email messages? This is a bad idea as these are used as scams to pursuade people to part with credit card information and other personal data. This can also be the filename of a ruleset.
820
837
.SH "Attachment filename checking"
821
838
.TP 
 
839
\fBAllow Filenames\fR
 
840
Default:
 
841
.br 
 
842
 
 
843
.br 
 
844
Allow any attachment filenames matching any of the patters listed here. If this setting is empty, it is ignored and no matches are made. This can also be the filename of a ruleset.
 
845
.br 
 
846
 
 
847
.br 
 
848
To simplify web\-based configuration systems, there are now two extra settings here. They are both intended for use with normal rulesets that you would expect to find in %rules\-dir%. The first gives a list of patterns to match against the attachment filenames, and a filename is allowed if it matches any of these patterns. The second gives the the equivalent list for patterns that are used to deny filenames. If either of these match at all, then filename.rules.conf is ignored  for that filename. So you can easily have a set like this:
 
849
.br 
 
850
 
 
851
.br 
 
852
Allow Filenames = \.txt$ \.pdf$
 
853
.br 
 
854
Deny  Filenames = \.com$ \.exe$ \.cpl$ \.pif$
 
855
.br 
 
856
 
 
857
.br 
 
858
which is a lot simpler than having to handle filename.rules.conf! It is far simpler when you want to change the allowed+denied list for different domains/addresses, as you can use the filename of a simple ruleset here instead.
 
859
 
 
860
.TP 
 
861
\fBDeny Filenames\fR
 
862
Default: 
 
863
.br 
 
864
 
 
865
.br 
 
866
Deny any attachment filenames matching any of the patters listed here. If this setting is empty, it is ignored and no matches are made. This can also be the filename of a ruleset.
 
867
 
 
868
.TP 
822
869
\fBFilename Rules\fR
823
870
Default: %etc\-dir%/filename.rules.conf
824
871
.br 
827
874
File in which to store the attachment filename ruleset. This can be a ruleset allowing different filename rules to apply to different users or domains. The syntax of this file is described in section "Attachment Filename Ruleset".
828
875
 
829
876
.TP 
 
877
\fBAllow Filetypes\fR
 
878
Default: 
 
879
.br 
 
880
 
 
881
.br 
 
882
Allow any attachment filetypes matching any of the patters listed here. If this setting is empty, it is ignored and no matches are made. This can also be the filetype of a ruleset.
 
883
.br 
 
884
 
 
885
.br 
 
886
To simplify web\-based configuration systems, there are now two extra settings here. They are both intended for use with normal rulesets that you would expect to find in %rules\-dir%. The first gives a list of patterns to match against the attachment filetypes, and a filetype is allowed if it matches any of these patterns. The second gives the the equivalent list for patterns that are used to deny filetypes. If either of these match at all, then filetype.rules.conf is ignored for that filetype. So you can easily have a set like this:
 
887
.br 
 
888
 
 
889
.br 
 
890
Allow Filetypes = \.txt$ \.pdf$
 
891
.br 
 
892
Deny  Filetypes = \.com$ \.exe$ \.cpl$ \.pif$
 
893
.br 
 
894
 
 
895
.br 
 
896
which is a lot simpler than having to handle filetype.rules.conf! It is far simpler when you want to change the allowed+denied list for different domains/addresses, as you can use the filetype of a simple ruleset here instead.
 
897
 
 
898
.TP 
 
899
\fBDeny Filetypes\fR
 
900
Default: 
 
901
.br 
 
902
 
 
903
.br 
 
904
Deny any attachment filetypes matching any of the patters listed here. If this setting is empty, it is ignored and no matches are made. This can also be the filetype of a ruleset.
 
905
 
 
906
.TP 
830
907
\fBFiletype Rules\fR
831
908
Default: %etc\-dir%/filetype.rules.conf
832
909
.br 
853
930
There is no point quarantining most viruses these days, so if you set this to "no" then no infections listed in your "Silent Viruses" setting will be quarantined, even if you have chosen to quarantine infections in general. This is currently set to "yes" so the behaviour is the same as it was in in previous versions. This can also be the filename of a ruleset.
854
931
 
855
932
.TP 
 
933
\fBQuarantine Modified Body\fR
 
934
Default: no
 
935
.br 
 
936
 
 
937
.br 
 
938
Do you want to store copies of messages which have been disarmed by having their HTML modified at all? This can also be the filename of a ruleset.
 
939
 
 
940
 
 
941
.TP 
856
942
\fBQuarantine Whole Message\fR
857
943
Default: no
858
944
.br 
885
971
.br 
886
972
Set where to find all the strings used so they can be translated into your local language. This can also be the filename of a ruleset so you can produce different languages for different messages.
887
973
 
 
974
 
 
975
.TP 
 
976
\fBRejection Report\fR
 
977
Default: %reports\-dir%/rejection.report.txt
 
978
.br 
 
979
 
 
980
.br 
 
981
Set where to find the message text sent to users who triggered the ruleset you are using with the "Reject Message" option.
 
982
 
 
983
 
888
984
.TP 
889
985
\fBDeleted Bad Filename Message Report\fR
890
986
Default: %reports\-dir%/deleted.filename.message.txt
1688
1784
 
1689
1785
 
1690
1786
.TP 
 
1787
\fBCache SpamAssassin Results\fR
 
1788
Default: yes
 
1789
.br 
 
1790
 
 
1791
.br 
 
1792
Many naive spammers send out the same message to lots of people. These messages are very likely to have roughly the same SpamAssassin score. For extra speed, cache the SpamAssassin results for the messages being processed so that you only call SpamAssassin once for all of the messages. This can also be the filename of a ruleset.
 
1793
 
 
1794
.TP 
 
1795
\fBSpamAssassin Cache Database File\fR
 
1796
Default: /var/spool/MailScanner/incoming/SpamAsssassin.cache.db
 
1797
.br 
 
1798
 
 
1799
.br 
 
1800
The SpamAssassin cache uses a database file which needs to be writable by the MailScanner "Run As User". This file will be created and setup for you automatically when MailScanner is started.
 
1801
 
 
1802
.TP 
1691
1803
\fBRebuild Bayes Every\fR
1692
1804
Default: 0
1693
1805
.br 
1701
1813
.br 
1702
1814
 
1703
1815
.br 
1704
 
# The Bayesian database rebuild and expiry may take a 2 or 3 minutes
1705
 
# to complete. During this time you can either wait, or simply
1706
 
# disable SpamAssassin checks until it has completed.
1707
 
WaitDuringBayesRebuild = no
1708
 
 
1709
 
 
 
1816
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.
 
1817
 
 
1818
 
 
1819
 
 
1820
.SH "Custom Spam Scanner Plugin"
 
1821
.TP 
 
1822
\fBUse Custom Spam Scanner\fR
 
1823
Default: no
 
1824
.br 
 
1825
 
 
1826
.br 
 
1827
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
 
1828
.br 
 
1829
.RS 7
 
1830
.IP  \(bu 4
 
1831
$IP             \- the numeric IP address of the system on the remote end of the SMTP connections
 
1832
.IP  \(bu 4
 
1833
$From   \- the address of the envelope sender of the message
 
1834
.IP  \(bu 4
 
1835
$To             \- a perl reference to the envelope recipients of the message
 
1836
.IP  \(bu 4
 
1837
$Message        \- a perl reference to the list of line of the message
 
1838
.RE
 
1839
.br 
 
1840
 
 
1841
 
 
1842
.TP 
 
1843
\fBMax Custom Spam Scanner Size\fR
 
1844
Default: 20000
 
1845
.br 
 
1846
 
 
1847
.br 
 
1848
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.
 
1849
 
 
1850
.TP 
 
1851
\fBCustom Spam Scanner Timeout\fR
 
1852
Default: 20
 
1853
.br 
 
1854
 
 
1855
.br 
 
1856
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.
 
1857
 
 
1858
 
 
1859
.TP 
 
1860
\fBMax Custom Spam Scanner Timeouts\fR
 
1861
Default: 10
 
1862
.br 
 
1863
 
 
1864
.br 
 
1865
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.
 
1866
 
 
1867
.TP 
 
1868
\fBCustom Spam Scanner Timeout History\fR
 
1869
Default: 20
 
1870
.br 
 
1871
 
 
1872
.br 
 
1873
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").
1710
1874
.SH "What to do with spam"
1711
1875
.TP 
1712
1876
\fBSpam Actions\fR