Login Redirect plugin for SquirrelMail
======================================
Ver 1.2, 2006/10/26

Original authors: Paul Lesneiwski <paul@squirrelmail.org>


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

This plugin will force the user to a custom login screen 
instead of using the default SquirrelMail login page.  

For help on creating custom login screens, please see:

http://www.squirrelmail.org/wiki/wiki.php?EmbeddedSquirrelMailLogin

You can change the login page for different domains if 
you use the Login Manager (vlogin) plugin and configure 
the "login_redirect_custom_login_URI" setting for each domain
in the Virtual Host Login configuration.

Also, you may include the text "###DOMAIN###" in the login
page URI (without the quotes of course) and that will be 
replaced with the value of SquirrelMail's $domain at run time.  
If you rely on the Login Manager (vlogin) to set $domain 
correctly, make sure this plugin is installed AFTER that one.



License
=======

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



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

  * SquirrelMail version 1.2.0 or above



Troubleshooting
===============

If this plugin is being used to redirect to the standard 
SquirrelMail login page (but, for example, at a re-written 
URI), an endless loop of redirects can be caused.  This 
plugin does its best to try to avoid the situation, but in 
the process, it can also prevent more simple or complex 
custom login URIs from working.  If you have problems 
getting the redirection to work, first try turning off the
$prevent_endless_redirects setting in the configuration file.



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



Change Log
==========

  1.2  2006/12/09  Paul Lesneiwski <paul@squirrelmail.org>
   * Added dynamic $domain substitution in the login page URI
   * Added functionality that attempts to prevent runaway redirect loops
   * Overrides login page URI that is used in logout errors
   * Overrides login page URI that is used on the signout page 
   * Updated for 1.5.2 plugin specification requirements

  1.1  2005/10/15  Paul Lesneiwski <paul@squirrelmail.org>
   * Config file not required

  1.0  2005/03/17  Paul Lesneiwski <paul@squirrelmail.org>
   * Initial release

