Installing Expire plugin in SquirrelMail
========================================

1) Start with untaring the file into the plugins directory.
   Here is a example for the 1.2 version of the expire plugin.

  $ cd plugins
  $ tar -zxvf expire-1.xx-1.4.tar.gz

2) If you do not need to change the default plugin settings,
   skip to the next step.  Otherwise, change into the expire 
   directory, copy config.php.sample to config.php and edit 
   config.php, making adjustments as you deem necessary.

  $ cd expire
  $ cp config.php.sample config.php
  $ vi config.php

3) Then go to your config directory and run conf.pl. Choose
   option 8 and move the plugin from the "Available Plugins"
   category to the "Installed Plugins" category. Save and exit.

  $ cd ../../config/
  $ ./conf.pl

4) If your SM user names equals to the system user name please
   skip to step 5).

   To support virtual users (or if your SM user name were not equal
   to local user id), you've to create a special file named
   "<SM user name>.expire" in the users mail directory. This file is
   used by the mail-expire script to locate user's mail directory. 
   
   The file can easily be created by using the touch command:
   
   $ touch /home/jam@qv90.de/Maildir/jam@qv90.de.expire
   
   In this sample "jam@qv90.de" is the SM user name and 
   "/home/jam@qv90.de/Maildir" the base mail directory where mail 
   files are stored.
   
5) Run the installation script for the daily cron job (the 
   installed script is actually performing the deletion of expired 
   mails).
   
   If you're not allowed to access the system daily cronjob 
   directory, then try asking your system administrator :-)
   
  $ cd expire
  $ ./instsh
  
   Caution: If you change your SM configuration (either with an 
   editor or with the provided configuration script, please rerun
   the installation script! Some parameters of the configuration
   file will only be extracted at installation time and stored in
   the "mail-expire" script.

6) Log on to SquirrelMail. A new folder (named "expire") is 
   automatically created in the SM data directory and the 
   default expiration settings from "config.php" or 
   "config.php.sample" were stored in a user file in the 
   "expire" directory.

7) Select "folder" menue. You should see a new option there. Now
   you can modify from which folder the mails should be deleted 
   (after reaching the expiration date). 

Support
=======

If you encounters problems using this plugin, please send a mail to
the mailing list <squirrelmail-plugins@lists.sourceforge.net>. For
more information on how to subscribe to mailing list please check out 

http://www.squirrelmail.org/wiki/MailingLists

International language support
==============================

Yes, there is international laguage support available. As you 
should know you need some "gettext" support to translate the 
messages. For further information please have a look at the 
pages at http://www.squirrelmail.org.

  $ ./getpot

This script extract all string used in the plugin to the file 
"expire.po". Please modify the string in that file to your 
language.

  $ ./compilepot
  
This script compiles the translated messages and stores them 
into the SM "locales" directory.

Live long and prosper!
jam@qv90.de
