"Fossies" - the Fresh Open Source Software Archive

Member "spammilt-0.5.0-rc7/README" (22 Jun 2005, 5714 Bytes) of package /linux/privat/old/spammilt-0.5.0-rc7.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 $Id: README,v 1.21 2005/06/22 18:12:20 mardan Exp $
    2 
    3 
    4 Description:
    5 -------------------------------------------------------------------------------
    6 Spammilt is a sendmail-milter which scans the header of emails for blacklisted-
    7 relaying servers and locally predefined domains/words. It is possible when
    8 spammilt detects *spam* to add a warning to the header, redirect, reject and
    9 discard the *spam* based on thresholds.
   10 	
   11 -------------------------------------------------------------------------------
   12 
   13 
   14 Compiling:
   15 -------------------------------------------------------------------------------
   16 Go see the INSTALL file.
   17 
   18 -------------------------------------------------------------------------------
   19 
   20 
   21 Changelog:
   22 -------------------------------------------------------------------------------
   23 Look into the CHANGELOG file.
   24 
   25 -------------------------------------------------------------------------------
   26 
   27 
   28 Troubleshooting:
   29 -------------------------------------------------------------------------------
   30 Take a look at http://tweegy.demon.nl/projects/spammilt/trouble.html or ask
   31 me if you can't find an answer anywhere.
   32 
   33 -------------------------------------------------------------------------------
   34 
   35 
   36 Usage:
   37 -------------------------------------------------------------------------------
   38 options: -h :this help
   39          -v :version
   40 
   41          * file locations:
   42          -b <arg> :blacklistmatch-file (default: /etc/mail/spam/black.list)
   43          -w <arg> :whitelistmatch-file (default: /etc/mail/spam/white.list)
   44          -D <arg> :dnsbl queryhosts-file 
   45                    (default: /etc/mail/spam/dnsbl-hosts.list)
   46          -I <arg> :dnsbl postives ignore list 
   47                    (default: /etc/mail/spam/dnsbl-ignore.list)
   48 
   49          * min threshold actions:
   50          (note: always adds 'X-Spam-Flag' and 'X-Spam-Result')
   51          -s <arg> :redirect _spam_ to recipient <arg>
   52          -T <arg> :rewrite subject on _spam_ detection
   53 
   54          * max threshold actions:
   55          -a <arg>:takes 'discard' or 'reject' as argument 
   56                   (if not set min. threshold action is used)
   57 
   58          * thresholds:
   59          -A <min> <max> :enable SpamAssassin highscore detection with thresholds
   60          -M <min> <max> :set DNSBL thresholds (default <1> <999>)
   61          -m <min> <max> :set blacklist thresholds (default <1> <999>)
   62          -W <min> :set whitelist threshold (default <1>)
   63          -c <arg> :DNSBL connecting host: -cc count DNSBL for threshold (default),
   64                    -cr reject, -cd discard
   65          -f <arg> :Forged connecting host: -fw action as in min. threshold (default),
   66                    -fr reject, -fd discard
   67 
   68          * generic settings:
   69          -H <arg> :set MTA servername, otherwise autodetect
   70          -F :fast-mode :don't scan rest of email if positive indication of 
   71                         _spam_ is found
   72 
   73          * milter settings:
   74          -t <arg> :milter socket timeout (in seconds)]
   75          -p <arg> :socket-address 
   76                    (default: autodetect or local:/var/spool/spammilt/spammilt.sock)
   77 
   78          * signals:
   79          killall -USR1 spammilt :reloads lists from file
   80 
   81 if compiled with BAYESIAN_ANNOYANCE=1 the following options are also available
   82         -x :Enable Annoyance-filter
   83         -X <n> :path_to_annoyance-filter (default: /usr/local/annoyance-filter)
   84         -Y :archive bayesian scanned mail
   85 
   86 -------------------------------------------------------------------------------
   87 
   88 
   89 Some notes:
   90 -------------------------------------------------------------------------------
   91 Spammilt queries every IP it finds in the header against a dnsbl server. It 
   92 does the same for words/domains or whatever you want to match from 
   93 the 'black.list' and 'white.list'. Note: whitelist overrules anything except 
   94 when a reject/discard-action is set for connect. (forged & dnsbl connected host)
   95 When a dnsbl-query or blacklisted match is positive it and exceeds the minimum
   96 threshold it adds the 'X-Spam-Flag: YES' header to the email.  
   97 When a whitelisted match is found it adds an extra header to the email, but 
   98 it doesn't it show the whitelisted word.
   99 Spammilt works with a minimum and a maximum threshold for each filter. When 
  100 a minimum threshold is reached it is possible to redirect, rewrite subject 
  101 and when a maximum is reached it is possible to reject or dicard. A threshold 
  102 is reached based upon the number of hits it find in the email header.
  103 
  104 -------------------------------------------------------------------------------
  105 
  106 
  107 Homepage:
  108 -------------------------------------------------------------------------------
  109 http://tweegy.demon.nl/projects/spammilt/
  110 
  111 -------------------------------------------------------------------------------
  112 
  113 
  114 Files:
  115 -------------------------------------------------------------------------------
  116 AUTHORS
  117 COPYING
  118 NEWS
  119 ChangeLog
  120 README
  121 INSTALL
  122 spammilt.c
  123 spammilt.h
  124 xfunctions.c
  125 xfunctions.h
  126 dynarray.c
  127 dynarray.h
  128 sample-files/white.list.example
  129 sample-files/black.list.example
  130 sample-files/dnsbl-hosts.list.example
  131 sample-files/dnsbl-ignore.list.example
  132 Redhat/spammiltd.sysconfig
  133 Redhat/spammiltd.init
  134 SuSe/spammiltd.sysconfig
  135 SuSe/spammiltd.init
  136 mrtg/mrtg
  137 mrtg/mrtg-spammilt.cfg
  138 mrtg/mrtg-spammilt-diff.cfg
  139 mrtg/spammilt.pl
  140 -------------------------------------------------------------------------------
  141 
  142 
  143 Credits:
  144 -------------------------------------------------------------------------------
  145 S.Graaf <sgraaf@xs4all.nl>
  146 Who gave some nice ideas and provided mental support ;-)
  147 
  148 Josh Corbin <jcorbin@jdweb.com>
  149 For writing the whitelist code, rewriting memory allocation of the black/white
  150 lists and pointing out some other issues.
  151 
  152 -------------------------------------------------------------------------------