Show SSL Link plugin for SquirrelMail
=====================================
Ver 2.2, 2005/05/01


Copyright (c) 2002 Jeff W. <venge@lokalsound.com>
Copyright (c) 2003-2005 Paul Lesneiwski <pdontthink@angrynerds.com>



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

This plugin displays a link at the bottom of the
login page that redirects the user to a SSL-secured
connection for logging in.  The secure connection
may optionally be retained for the duration of the
user's mail session.  It is also possible to present
extra information below the link on the login page
(for informational purposes, etc.).



Configuration - (set by editing config.php)
===========================================

  * $my_ssl_url can contain the URL for the secure login page
    or may be left empty to allow the plugin to automatically
    use the same URL (substituting "https" for "http") for the
    link destination

  * $my_ssl_extra is used to place additional information below
    the link on the login page.  It may contain HTML if needed, 
    but please make sure to escape any single quotes (\')

  * $go_back_to_http_after_login should be set to 1 if you want
    to provide a secured connection only for logging in, or it
    can be set to 0 if you want user sessions to remain in SSL 
    for their entire duration

  * $stay_in_https_if_logged_in_using_https can be set to 1 if
    you want to allow users who came to the login page using 
    "https" (without having clicked the link that is provided by
    this plugin) to retain their SSL connection for the duration
    of their email session.  Users who use the link are not 
    affected by this setting.  Please note that this setting will 
    override the "stay secure" checkbox, which may be misleading 
    for your users, thus the default for this setting is zero.

  * $mySecurePort is not commonly used, however, if your web server
    hosts either HTTP or HTTPS on non-standard ports, you should
    specify the port for HTTPS connections here.  If you use regular
    port numbering (80 and 443), you may leave this setting undefined

  * $notStandardHttpPort can usually be left as is, but if you are 
    accepting regular HTTP requests on a non-standard port (anything 
    besides port 80), please specify that value here.  If you are 
    using port 80, then you should leave this value empty

  * $allVirtualDomainsAreUnderOneSSLHost is another setting that
    can typically be ignored.  However, if you host all of your
    SSL connections for your virtual domains off the same directory
    tree (usually to avoid problems with SSL certificate errors),
    you should specify the common portion of that URL here.  See
    the config.php file for an example
 


Help Requests
=============

Help requests are welcome at my personal email address, but I
request that you first post to the SquirrelMail Plugins mailing
list, where you'll get faster help from more people and other
people with the same problem will be able to see how your issue
was resolved.  If you don't get good answers that way, you may
try emailing me directly.

Info about the SquirrelMail Plugins mailing list can be found
on the SquirrelMail web site.  It is currently located at:

http://lists.sourceforge.net/mailman/listinfo/squirrelmail-plugins
squirrelmail-plugins@lists.sourceforge.net



License
=======

This plugin is released under the GNU General Public
License (see COPYING for details).



Change Log (new as of version 2.0)
==================================

  2.2 - 2005/05/01 - Paul Lesneiwski <pdontthink@angrynerds.com>
   * Standardized internationalization
   * Removed $my_ssl_text in favor of correct internationalization.
   * Added checkbox to secure screen that allows user to decide
     to stay in SSL after login or not

  2.1 - 2003/07/18 - Paul Lesneiwski <pdontthink@angrynerds.com>
   * Changed plugin logic to detect HTTP and HTTPS connections
     based on port number instead of environment variables
     that in some cases may not be provided by the web server
     (Thanks to Tony Geerts <tgeerts@dyton.com>)
   * If user comes to login page with a URI that has any
     GET variables appended to it, they are automatically
     added to the SSL link URI (Thanks to Alex Lemaresquier 
     <alex@brainstorm.fr>).

  2.0.8 - Paul Lesneiwski <pdontthink@angrynerds.com>
   * Fix for when going back to HTTP from HTTPS login that
     would cause javascript errors after sending at least
     one message - the right frame was getting redirected
     back to HTTPS.  But not any more.  ;>
     This is only a fix applicable for SM 1.4 and up.

  2.0.7 - Paul Lesneiwski <pdontthink@angrynerds.com>
   * Fixed dumb typo that prevented the secure port number
     functionality from working (many thanks to Elisamuel 
     Resto <webmaster@blue-dragons-lair.net>)
   * Fix for when specifying "my_ssl_url" and using 
     "go_back_to_http_after_login", the user's original
     HTTP URL is reverted to after secure login.  If this
     presents problems for anyone, this can be made into a
     configurable option; please get in touch.
   * Added config.php.sample and removed config.php for
     hassle-free upgrading.

  2.0.6 - Paul Lesneiwski <pdontthink@angrynerds.com>
   * Fix for errors some installations had due to session
     starting issues.  Not necessary to upgrade unless you
     were getting "Warning:" messages using version 2.0.5.
   * Updated to new plugin version reporting API.

  2.0.5 - Paul Lesneiwski <pdontthink@angrynerds.com>
   * Fixed minor problem where unexpected text shows up below
     the link.

  2.0 -  Paul Lesneiwski <pdontthink@angrynerds.com>
   * Updated for compatibility with SquirrelMail 1.4
   * Updated for compatibility with Plugin Updates plugin
   * New setup.php format for better overall SquirrelMail performance
   * Added ability to specify non-standard port numberings
   * Added functionality to specify SSL URLs where virtual
     domains are all hosted off of a common root URL
   * Revamped several aging pieces of this plugin
   * Added support for internationalizing the link text
