Installing The Empty Folders Plugin
===================================

1) Start with untaring the file into the plugins directory.
   Here is a example for the 2.0 version of the Empty
   Folders plugin.

  $ cd plugins
  $ tar -zxvf empty_folders-2.0-1.2.tar.gz

2) If you do not want to change the default behavior of this
   plugin, skip to step four.

3) (OPTIONAL) Decide if you want to store the plugin
   configuration file in the plugin directory or in
   the main SquirrelMail config directory.

   A) To store the configuration file in the plugin directory,
      change into the empty_folders directory, copy
      config_example.php to config.php and edit config.php,
      making adjustments as you deem necessary.

     ----- optional -----
     $ cd empty_folders
     $ cp config_example.php config.php
     $ vi config.php
     ----- optional -----

   B) To store the configuration file in the main SquirrelMail
      config directory, change into the empty_folders directory,
      copy config_example.php to
      ../../config/config_empty_folders.php and edit
      ../../config/config_empty_folders.php, making
      adjustments as you deem necessary.

     ----- optional -----
     $ cd empty_folders
     $ cp config_example.php ../../config/config_empty_folders.php
     $ vi ../../config/config_empty_folders.php
     ----- optional -----

4) If you are using SquirrelMail 1.4.1 or above (except 1.5.0),
   skip to step 7.

5) If you are using SquirrelMail 1.5.0 (WARNING!  This version
   is unsupported and contains numerous security exploits as well
   as a package compromise.  When using SquirrelMail development
   (unstable) versions, you should upgrade frequently.  Version
   1.5.0 is VERY OLD and is untrusted and may not work with the
   newest release of this plugin), copy the included source file
   replacement as such, remembering to make a backup first:

  $ cp ../../src/left_main.php ../../src/left_main.php.bak
  $ cp source_files/left_main.php-1.5.0 ../../src/left_main.php

6) If you are using SquirrelMail 1.2.x or 1.4.0 (you really
   should upgrade!), you may take one of the following two
   steps to update your source code for use with this plugin:

     A) This is the recommended method, which guarantees you will not
        lose any other changes you may have made to your SquirrelMail
        installation.  Run the following command (from the
        empty_folders directory) to patch your SquirrelMail source
        code for this plugin:

       $ patch -p0 < patches/empty_folders_patch_squirrelmail-1.4.0.diff

        Note that if you have version 1.2.x, change that last command to use the
        correct .diff file (currently, 1.2.11 diff file should work with most
        SquirrelMail 1.2.x versions).

        Note for Windows users: you can get native patch functionality
        by installing this very useful package:
        http://unxutils.sourceforge.net/

     B) If you are certain you have an unmodified SquirrelMail installation
        or are having problems with the patch command above, you may use the
        provided pre-patched source file by running this command, making
        sure to make a backup of the target file first:

       $ cp ../../src/left_main.php ../../src/left_main.php.bak
       $ cp source_files/left_main.php-1.4.0 ../../src/left_main.php
       cp: overwrite `../src/left_main.php'? y

        Note that if you have version 1.2.x, change that last command to use the
        correct file (currently, 1.2.11 file should work with most SquirrelMail
        1.2.x versions).

7) 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

8) Verify that you have the "compatibility" plugin installed.

9) Translations are not included in this package.  To get a
   translation, download the language pack needed from:

       http://www.squirrelmail.org/download.php



Upgrading Empty Folders
=======================

1) Start with untaring the file into the plugins directory.
   Here is a example for the 2.0 version of the Empty
   Folders plugin.

  $ cd plugins
  $ tar -zxvf empty_folders-2.0-1.2.tar.gz

2) Change into the empty_folders directory and check your
   config.php file against the new version to see if
   there are any new settings that you must add to your
   config.php file.

  $ diff -u config.php config_example.php

   If you store your configuration file in the main SquirrelMail
   config directory, adjust this command as follows:

  $ diff -u ../../config/config_empty_folders.php config_example.php

   Or simply replace your configuration file with the provided
   example and reconfigure the plugin from scratch (see step three
   under the installation procedure above).

3) You never need to patch SquirrelMail again if you've done it
   once before (or unless the release notes/changelog say otherwise).