webfilt 0.91 - Flexible web interface to server-side spam filters
Copyright (C) 2003 Jem E. Berkes <jb2003@pc9.org>
http://www.pc-tools.net/unix/webfilt/

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 
USA.

=====================================================

WHAT IS webfilt?

	webfilt is a group of scripts that can enhance the functionality 
of your existing server-side spam filtering setup by adding a web 
interface and CGI-based mail query/reclassification capability.
	webfilt was originally developed to work with SpamProbe, an 
open source Bayesian spam filter. However, webfilt can be configured to 
work with other similar spam filters. Because it is composed of bash 
scripts, it is very easy to tweak for your particular setup.

	The software really does two things:

1) Keeps copies of all incoming mail in separate directories depending on 
whether your filter identified the mail as spam or not. Only mail up to N 
days old is kept, and old mail is automatically removed. An HTML index 
is generated for each of these directories, allowing you to easily see 
what mail ends up where.

	This requires bash and common *nix utilities (grep, sed, cut, etc.)

2) The HTML index generated above is also a CGI form that can launch the 
webfilt.cgi script on your web server. This form allows you to mark mail 
and then apply actions to it, such as: query for current spam state, 
classify as spam, classify as not-spam.

	This additionally requires a web server with CGI capability, and
	an operating system with FIFO support (i.e. 'mkfifo' command).

When it's all done and set-up, here is what a user can do:

+ use their web browser to see a summary of the last few day's mail, and 
  which messages were classified as spam and not-spam (they can also view
  full plaintext of any email)

+ use their web browser to select an individual message and run it through
  the filter to check the mail status, or reclassify as 'spam' or 'good'

Hopefully 'webfilt' can make intelligent spam filters that require some
user interaction easier to use!

Jem Berkes
jb2003@pc9.org
2003-07-16
