$Id: README,v 1.14 2003/04/27 23:31:45 mardan Exp $ Description: ------------------------------------------------------------------------------- Spammilt is a sendmail-milter which scans the header of emails for blacklistes- relaying servers and locally predefined domains/words. By default when it detects *spam* it adds a warning to the header and the subject, as an option it's also possible to rejects such emails without bothering the recipient or redirect such emails. ------------------------------------------------------------------------------- Compiling: ------------------------------------------------------------------------------- Go see the INSTALL file. ------------------------------------------------------------------------------- Changelog: ------------------------------------------------------------------------------- Look into the CHANGELOG file. ------------------------------------------------------------------------------- Troubleshooting: ------------------------------------------------------------------------------- Take a look at http://tweegy.demon.nl/projects/spammilt/trouble.html or ask me if you can't find an answer anywhere. ------------------------------------------------------------------------------- Usage: ------------------------------------------------------------------------------- options: -h :this help -p :socket-address (default: local:/var/spammilt/spammilt.sock) -H :manually set MTA servername, otherwise autodetect -b :black.list file (default: /etc/mail/spam/black.list) -w :white.list file (default: /etc/mail/spam/white.list) -c :reject garbage if DNSBL match found on connect -r :reject garbage if DNSBL match found in header -B :reject garbage if Blacklist match found in header -W :Overrule all blacklisted if whitelisted match is found -U :reject garbage if max number of unknown hosts in header are found (see -u) -u :set max number of unresolveble hosts found in header before treating email as spam (default: 8) -s :redirect all marked mail to recipient 'n' -t :timeout (in seconds) -D :daemonize killall -USR1 spammilt :reloads black and whitelist killall -USR2 spammilt :write statistics to file if compiled with BAYESIAN_ANNOYANCE=1 the following options are also available -x :Enable Annoyance-filter -X :path_to_annoyance-filter (default: /usr/local/annoyance-filter) ------------------------------------------------------------------------------- Some notes: ------------------------------------------------------------------------------- Spammilt queries every IP/hostname it finds in the header against a dnsbl server. It does the same for words/domains or whatever you want to match from the 'black.list' and 'white.list'. Note: whitelist overrules anything except for immidiate rejection! By default when the dnsbl-query or blacklisted match is positive it adds an extra header to the email and changes the subject. When a whitelisted match is found it adds an extra header to the email, but doesn't tag it as spam. Spammilt uses by default 'relays.osurisoft.com' as DNSBL server. Other servers maybe possible. This you can define in 'spammilt.h'. With an extra parameter *spam* mail can be automaticly rejected or redirected to another account. (example: -s spam@yourdomain.org) The -U and -u option are for unresolveble hostnames which are found in header. I found a number of 10 to be a nice number. But you are free to set it to a different value. ------------------------------------------------------------------------------- Homepage: ------------------------------------------------------------------------------- http://tweegy.demon.nl/projects/spammilt/ ------------------------------------------------------------------------------- Files: ------------------------------------------------------------------------------- AUTHORS COPYING CHANGELOG Makefile README INSTALL spammilt.c spammilt.h xfunctions.c xfunctions.h sample-files/white.list.example sample-files/black.list.example sample-files/dnsbl-ignore.list.example ------------------------------------------------------------------------------- Credits: ------------------------------------------------------------------------------- Josh Corbin For writing the whitelist code, rewriting memory allocation of the black/white lists and pointing out some other issues. -------------------------------------------------------------------------------