QuickSave Plugin
-------------------

This automatically saves the email message you're composing from
being accidentally wiped out by refreshing the right frame or
otherwise leaving the Compose page. Think of it as anti-anti-caching :)

It's all javascript on the Compose page, plus a form that we're using
for storage in the left_main frame. You won't ever know that it's
installed unless you've lost a message and it can be recovered.

We're using cookies as the primary method for storing the values from
the Compose form, and we've still got the 'left_main frame' method in
case you opt to not use cookies. Recovery happens no matter what you 
do including completely refreshing the whole window (as in a Netscape 
window resize) or even closing your browser.  However, the cookie RFC
restricts the size and number of cookies allowed per domain, and thus
long messages will only be partially recovered.

Cookies are kept on a per-user basis, and are encrypted as best they 
can be using javascript.  They are persistent, the time for which is
configurable (see below).  Older systems can be noticably slow when
encrypting the user's email, and because encrypted messages need more
storage space, using encryption will cut down on the length of any
messages that may be recovered.  Therefore, the default is no 
encryption -- the user can increase encryption levels by going to 
Options->Display Preferences.

If there are problems, or JavaScript inconsistancies, please notify
Ray Black at allah@accessnode.net or Paul Lesneiwski at 
pdontthink@angrynerds.com, or else post to the squirrelmail-plugins list.

It's worth noting that this plugin might not work yet with Identities or
Priority.  It does work with 'compose in new window', but PLEASE BE SURE
NOT TO DOWNLOAD the 'compose in new window' plugin, since it has already
been made part of the SquirrelMail core -- if you download the plugin,
which is out of date, Quicksave will not function properly.

Quicksave also will not recover attachments.


To Install:
-------------------
  1. Unarchive the file
      $ cd plugins
      $ tar -zxvf quicksave.x.x.x-1.0.0.tar.gz

  2. Run conf.pl, choose "8" from the main menu, and add "quicksave"
     as a new plugin.  Save and exit.

  3. Also, please verify that you have the "compatibility" plugin
     installed.

  4. Optionally, you can patch the SquirrelMail source code to quelch
     false recover alerts after saving an email as a draft.  If you
     decide not to do this, you can think of said functionality as
     a "feature" -- auto-draft recovery.

      ----- optional -----
      $ cd ../
      $ patch -p0 < plugins/quicksave/compose.php-draft_saved-1.2.11.diff
      ----- optional -----

     This must be done from the main SquirrelMail directory, and you
     should use the patch that matches your SquirrelMail version.


Optional Configuration:
-------------------------------
  Cookies are kept on users' machines for a default of one hour (the
  rationale being that they know when they lose a message, and shouldn't 
  need more than an hour to recover it; QuickSave is not a replacement 
  for "Save Draft" functionality), but you can change this as desired by
  changing the values for $quicksave_cookie_days, $quicksave_cookie_hours,
  and/or $quicksave_cookie_minutes in config.php.

  config.php also contains settings for restricting the amount of data 
  stored in cookies; values are about maxed out for IE6, default security 
  and privacey settings...  If you experience blank recoveries or "must 
  be logged in" messages, you can adjust these downward (the main value 
  you'll want to change is $maxSingleCookieLength).

