File Release Notes and Changelog
Release Name: 0.1.5
Notes:
NAME: quarReminder - Quarantine Reminder for Amavisd-new users
AUTHOR: BJ Dierkes <wdierkes@5dollarwhitebox.org>
REFERENCE:
+ Amavisd-new Content Filter: http://www.ijs.si/software/amavisd/
+ MailZu Quarantine Frontend: http://www.mailzu.org/
+ SourceForge: http://sourceforge.net/projects/quarreminder/
+ 5dollarwhitebox.org: http://devel.5dollarwhitebox.org/quarReminder
DESCRIPTION:
The script queries the Amavisd-new MySQL Database and sends a list of messages
in quarantine to the rightful email user
COMPATIBILITY:
This script was built for a standard Amavisd-new 2.3.3 SQL layout as per
+ amavisd-new-2.3.3/README_FILES/README.sql
+ amavisd-new-2.4.x not tested
USAGE:
You first need to copy 'config.inc.php.dist' to 'config.inc.php' and then
properly set all of the variables in the $CONFIG array.
The script freads the file set in the var $CONFIG['msg_template'].
You can build any type of message you like, all you need to do is drop
in the following VARS
+ %%%MSG_TITLE%%%
+ %%%EMAIL%%%
+ %%%HOSTNAME%%%
+ %%%QUAR_URL%%%
+ %%%QUAR_LIST%%%
+ %%%QUAR_COUNT%%%
Once you have configured the '$CONFIG' array variables, and modified
your template file you simply run the script:
php quarReminder.php
ISSUES:
The only issue as of yet is that Amavisd-new itself generally considers
the messages sent from this script as Spam. I mean, in all actuality you
are sending a message that is 90% Spam content (due to the Subject lines
of the messages in quarantine). My fix for this was to add the following
to the amavisd.conf file:
@whitelist_sender_maps = (
read_hash("/etc/amavis/whitelist")
);
You then have a list of email addresses in '/etc/amavis/whitelist'. I have
system-maintenance@5dollarwhitebox.org or something similar which is the
user account that is sending the message (not necessarily the email set in
$CONFIG['admin_email']). It is recommended to use some obscure user
account (if you use postmaster, don't be suprised when you get Spam sent
to postmaster@yourdomain.com which is allowed through your whitelist since
the From header is easily forged).
COPYRIGHT:
Copyright (c) 2005,2006 BJ Dierkes/5dollarwhitebox.org. All rights reserved.
This software is released under the GNU General Public License. Please read
the disclaimer at the top of the quarReminder.php application.
Changes:
------------------------------------------------------------------------
quarReminder - v0.1.5 - July 17, 2006
------------------------------------------------------------------------
- Changed the $CONFIG array variable to '$qrConfig' because... simply
$CONFIG was annoying.
- Added 'utils/quarReminder.cron' for those that may need help setting
up a cronjob.
- Added a file check on 'config.inc.php' before trying to require it
- Added the var $CONFIG['email_source'], which replaces the use of
$CONFIG['email_list']. This var can be 'sql' or 'file'. If set to
'file', quarReminder will then read '$CONFIG['email_file']' for a
one email per line list of emails to send for.
- Added '$qrConfig['test_only'] to allow administrators to test the
process a couple times without annoying their end user's with the
Spam. Emails go to '$qrConfig['test_email_addy']'.
- Added a few class files, in the 'classes' directory. Nothing fancy
but a better approach than the way it was before. Added the
MySQL.class.php, and moved all functions to quarReminder.class.php
- Tried to clean up script as much as possible. Please send any
feedback to the project at http://sourceforge.net/projects/quarreminder
------------------------------------------------------------------------
quarReminder - v0.1.4 - July 15, 2006
------------------------------------------------------------------------
- Added the $CONFIG['email_list'] variable
[+] This variable can be either 'sql' or set to
the path of a file (one email per list).
- Moved 'config.php' to 'config.inc.php.dist'. To setup script
you need to copy 'config.inc.php.dist' to 'config.inc.php' and then
configure it.
- Added a check to verify whether there are any emails to process
instead of just blindly processing the '$Emails' array
- Cleaned up error checking a bit
- Modified versioning scheme: 0.1.4 = 0.04
------------------------------------------------------------------------
quarReminder - v0.1.3 - April 30, 2006
------------------------------------------------------------------------
- Created this CHANGELOG
- Created README with the all important ISSUES section
- No bugs in script reported
- Added conditional check to avoid sending reports to
users without anything in their quarantine
- Added conditional check to test that the template file exists
- Moved the $CONFIG to config.php
- Added checks on variables (no empty variables)
------------------------------------------------------------------------
quarReminder - v0.1.2 - April 15, 2006
------------------------------------------------------------------------
- Released script publicly (functional)
------------------------------------------------------------------------
quarReminder - v0.1.1 - October 15, 2005
------------------------------------------------------------------------
- Built script, and dropped project (forgot about it actually)
