SpamAssassin Web Frontend by venge@lokalsound.com

Version 2.0 beta

- Improved code over the 1.x series, smaller code size
- More functionality for the admin, lets you control more
- Better layout control for the end user
- Improved squirrelmail support (for upcoming series)
- <user>.spam and procmail-spamrc now kept in $data_dir
- Added some code for use with SM 1.2.10 and 1.4.0(DEV)
- Add a "/" to maildir folder filter selection for use with procmail
   if $sadc[mdir] is set to '1':(procmail uses trailing / for maildir vs mbos)
   (layouts/layout.0.php) May need selection for maildir vs mbox
- SpamAssassin drop "-P" and makes piping to stdout default. Option to choose
   to go with "no pipe" (np) added to admin/config.php for admins with SA>=2.5
- Made some changes to deal with problems of messages including " " (space)
   use a "%20" for URL encoding without error, but preserve function.
- Added feature for permitting maildrop call from procmail instead of using
   procmail's built-in delivery. (If maildrop program can't be found, it will drop to procmail delivery)
- Added a feature for specifying max size of messages (in bytes) before
   spamassassin is called to process mail.
- A "bug" (incomplete feature) requires you to edit admin/user_prefs.tmpl
   to set the "default" settings users get when they first use this plugin
   Perhaps (later?) the default settings for users will generated from
   the admin/config.php (like rewrite_subject etc.)
- Provision of a sample ~/.procmailrc file named SAMPLE.procmailrc

Admin features (Features Pending)
--------------
- Manage the default.config from the interface
 + Optional Usage of the rewript.pl script
  o Can tell user what to put in procmailrc
  o Can email admin letting them know to do it
 + Set the min and max threshold
 + Set the default color scheme
 + Set which options the user can see and set
 + Set whether the user can change the layout
 + Selective user control (grouping)
  o Allows admin to specify "power-users" inside their own group

User features (Features Pending)
-------------
- Show/Hide features to minimize screen usage
- New user config area which allows them to customize the look
- Now add entire domain to wl/bl


Upcoming Featues (Future Add-ons)
----------------
- Option when adding a *@domain.com to wl/bl, remove other entries that would fall under it (keeps list small)





------------------------------ BLURB --------------------------------------
Spamassassin is a spam filter software that is written in perl. It is required
for you to have in order to use this frontend. This FAQ does not cover the 
installation and configuration of Spamassassin. Please consult the spamassassin
website for more details.

I have tried to make this plugin as robust as possible, but there is a chance
that it is missing some features you would like to see. This is what I like
to call a "WishList". Email me and I can see what I can do to get it 
incorporated into this plugin. As far as a warranty goes, there is none.
I am not responsible for what this plugin may do to your server and/or your
email. Use at your own risk. It does carry a GNU GPL license so you can do
what you like with it, just give me credit where credit is due.


Installation is same for all other SM plugins:

1) Extract spamassassin-$VERSION.tar.gz to your plugins folder
2) Use the ./configure Option 8 to enable


This plugin should work with 1.2.x and higher. (Even the 1.3.x series).
It should also work with register_globals=off in your php.ini


********** Read this info to perhaps answer questions (AKA RTFM section) **********

- You can use this out of the box. The default settings can be found in:
  	admin/default.config.php

  To run a customized version, either copy the admin/default.config.php to the base
  directory or this plugin or copy it to the admin directory under the name "config.php"

  This will prevent a newer version from overwriting your settings. 

   **** DO NOT DELETE anything that says default.* from the admin directory ****

		------------------

- The way the data is displayed is done VIA the layouts/ directory.
  The admin can "force" a layout on a user by editing the proper variable inside the config file.
  You can make your own layouts. Layouts can be located in layouts/. If you want to create your
  own layout here is what you do:

   1) Use my default.layout.php in the admin directory (or the layouts/layout.0.php) for a base to understand
      how the variables work.
   2) Create/upload the file in the layouts/ directory and make sure it is named like "layout.n.php" where
      n = a number. (Next number in line). EX: layout.1.php , layout.2.php    


  If a layout is not found, it will use the admin/default.layout.php file.

		-------------------

- If not using HASHING, just make sure your $data_dir is at least 711 (rwx--x--x). This can be done with:
    chmod 711 $data_dir  (EX: chmod 711 /var/www/webmail_data/data)

		------------------

- If you use HASHING ($hash_level > 0):

  To make this work flawlessly, you need to make a mod to the SM source. Unless you feel like
  running a chmod -R everytime a new user uses the webmail.

  1) Edit the $SM_SRC/functions/prefs.php file and search for:
    (!@mkdir($real_hash_dir, 0770)) 
     or just search on 0770 to make life easier
     Change the number to 0771 

     This will now create any "HASH_DIR" with proper permissions for the $user.spam file to be read by spamassassin


  Failure to do this will result in spamassassin not working. If you are not comfortable with this, you can set
  an option on the admin/default.config.php or your config.php file to force the suid perl script to copy your
  2 files ($username-spamrc and $username.spam) to your home directory. Just check the default.config.php file
  to see where this option is. This will greatly reduce the risk of running an accurate frontend and could easily
  cause the filtering to not work right.

		------------------ 

12Dec02 - Now the perl script will check to see if you are using the old plugin setup and change the .procmailrc file to reflect the new layout. A backup is made as .procmailrc.SPAMASSASSIN of your old one.

		------------------

19Dec02 - Now will make an initial backup copy of your user_prefs file (called user_prefs.pre-SA) to preventan unexpecting user from losing their settings before using the spamassassin plugin.

21Jan03 - Fixed problem with @*.domain.com being an "invalid email". Also added "Help" button to interface

		------------------

14Mar03 - After hybernating and planning out my jobs' Ip reorganization, I sat down to fix the nasty bug that would undo most of your general settings when you submitted *anything*. This should be fixed. 
The project is still in beta due to the fact I have not gotten all of the features in. Once I get the admin interface up, it should move to a stable release.
