##
## Spam Rule version 0.2
##
## Copyright (c) 2002-2003 O'Shaughnessy Evans <shaug-sqml @ wumpus.org>
## 

Spam Rule is a plugin for SquirrelMail that lets you select from different
groups of email filters via a config file maintained through FTP.  It is
written specifically for situations where a user can select from various
filters, individually or in predefined groups, and subscribe to them by
modifing lines in a procmail or maildrop config file in their home
directory.  This way the user can have his mail filtered at message delivery
time by the email system rather than at reading time by SquirrelMail, which
could really slow things down.


Requirements:
  - access to an FTP server for each IMAP user, using the same login name
  - a forward file somewhere under the user's FTP directory,
    e.g. ".forward" or ".qmail"
  - a mail filter config file somewhere under the user's FTP directory,
    e.g. ".mailfilter" for maildrop or ".procmailrc" for procmail


Features:
  - creates a new block under Options called "Spam Rules"
  - tries to give the user a simple interface that can still provide as much
    flexibility as the user desires
  - lets the admin create sets of predefined filter groups from which the
    user can select, but also lets the user pick and choose from the whole
    set of available filters
  - tries to be very flexible (perhaps too much so?)


Installation:
  - Take a look at config.php and modify as described there.
  - If you don't have different filter include files set up, contact me
    and I'll share my maildrop filters with you.
  - Enable the plugin through conf.pl.
  - Test it out!  Make sure to double-check the contents of your forward file
    and mail filter config file before putting into production.


Questions and support:
  I've tested this plugin quite a bit, and it works great on my system,
  but it's still brand new and hasn't seen any use outside of my own
  environment.  I tried to make it resistant to unexpected problems and
  easy to change for different environments, but I'm sure there are many
  shortcomings.  If you have any questions or comments, please contact
  me through shaug-sqml @ wumpus.org.
