Block Sender - A Plugin for SquirrelMail
========================================
Version: 0.2 (BETA)
Version Date: 24-Feb-2002
Author: Derek Battams <derek@battams.ca>
Requires SQMAIL: >= v1.2.2
Requires procmail: >= v3.15.x

Description
-----------
The Block Sender plugin allows users to create a list of e-mail
addresses that will be "blocked" from delivery.  When an e-mail arrives
for a user the sender's address is checked against their block list.  If
the sender's address is in the block list the mail will automatically be
delivered to their SquirrelMail trash folder.  Users can add addresses
to their blocked list by reading an e-mail and clicking on the "Block
Sender" link, which is added by this plugin.  Users can also manually
edit their blocked senders list through their SquirrelMail Options.

This plugin relies on the use of the procmail LDA.  Within the plugin
directory is a file called 'sqblock.rc'.  This file contains a recipe
that must be added to the global procmailrc file (usually located at
/etc/procmailrc) along with variables that must be defined.  The easiest
way to do this is to simply include sqblock.rc in your global procmailrc
file by adding a line such as this:

INCLUDERC=/path/to/sqblock.rc

This should be the first line of your global procmailrc file.  The
recipe is only a delivery recipe if a match is found in the recepient's
block list.  If no match is found then processing continues as normal;
this means that this should not interfere with other procmail recipes.
The variables at the top of sqblock.rc are vital for proper operation
and must be set for your system.  PLEASE ENSURE THAT THE VARIABLES ARE
PROPERLY SET BEFORE INSTALLING THIS PLUGIN FOR USE!  Use of this recipe
and/or file requires special (root) access to your system.  Though every
effort has been made to ensure the accuracy and safety of the recipe,
the author is not responsible for the results of its use.

Installation
------------
Installation is like any other SquirrelMail plugin.  Simply untar the
archive in the plugins directory and install the plugin from the
configure program (option 8).  The only other thing to be done is to
modify the variables in sqblock.rc and add the recipe to your system's
global procmailrc file as indicated above.

Comments/Questions
------------------
Send them to the author, Derek Battams <derek@battams.ca>.

Revision History
----------------
21-Feb-2002   0.1     Original version (BETA).
24-Feb-2002   0.2     Corrected a bug that would cause errors with the IMAP
                      server when blocking an address after deleting other
                      messages.  Now when a sender is blocked the message is
                      automatically deleted and the user is able to return to
                      the message list of the current folder.
