Gzip Compressed Output plugin for SquirrelMail
==============================================
Ver 2.01, 25/07/04

Original author: Tyler Akins
  Modifications: Paul Lesneiwski <pdontthink@angrynerds.com>



Features
========

* Less data transferred to client, so faster on low-bandwidth connections.
* Browser detection -- compresses only if the browser allows it
* Uses zlib or gzip (whatever is available -- see configuration file)
* Compresses only when bigger than size specified
* System-wide or per-user settings



Description
===========

This plugin allows SquirrelMail to compress its output to the browser,
saving precious bandwidth.  As of version 2.0, all SquirrelMail pages
are compressed if they fall over the designated size threshold.  Pages
smaller than that threshold will not be encoded, nor will pages going
to a browser that doesn't support gzip decompression.  

The system administrator may choose default settings and determine
whether or not users may override those settings on their own (details
in the configuration file).  Compression level may be set by the
administrator or the plugin can also make a best guess based on actual
system load.



Requirements
============

This plugin requires that you either have the 'zlib' library compiled 
with PHP (with --with-zlib), or that you specify where the 'gzip' 
program is (do so in the configuration file if necessary).

Note that you may also want to consider implementing gzip compression 
on a broader basis (for your whole server) by using Apache's mod_gzip, 
which can be found at:

http://sourceforge.net/projects/mod-gzip/

Or by turning on zlib.output_compression in php.ini (again, if you have
compiled zlib into PHP) - read more here:

http://php.net/manual/ref.zlib.php#ini.zlib.output-compression

Useful information about compressing PHP output can also be found here:

http://www.webcompression.org/php-compress.html



Installation
============

See the INSTALL file.



Support
=======

Questions/comments/flames/etc can be sent to the SquirrelMail Plugins list.



Changes
=======

2.01 - Corrected wrong locale name
     - Added Greek translation (Thanks to Alexandros Vellis <avel@noc.uoa.gr>)

2.0  - Refactored code, internationalized plugin output, created 
       configuration file with system defaults, brought plugin into 
       compliance with SquirrelMail plugin standards, all pages now
       compressed, added code for auto-detect of system load for 
       dynamic compression levels, lots of cleanup.

1.6  - Removed some minor bugs
    
1.5  - Removed an error message

1.4  - Now properly removes the extra '; q=1.0' stuff from encoding lines
       from the browser
    
1.3  - No longer leaves stray temporary files in the data directory if you use
       zlib
    
1.2  - If you have zlib installed, it no longer requires temporary files
  
1.1  - Fixed documentation to say GZip
     - Enforced minimum size requirement when compressing
