SMTP Authentication plugin for SquirrelMail
===========================================
Ver 1.0, 2012/06/30


Copyright (c) 2011-2012 Paul Lesniewski <paul@squirrelmail.org>
Copyright (c) 2011 Emmanuel Dreyfus <manu@netbsd.org>


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

This plugin provides additional SMTP authentication mechanisms
to SquirrelMail.  It provides a SAML SASL built-in mechanism
(usually implemented in (provided to) your SMTP server by
crudesaml - see http://ftp.espci.fr/pub/crudesaml/README ) and
allows you to easily create custom modules for any other mechanism.



License
=======

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



Donations
=========

If you or your company make regular use of this software,
please consider supporting Open Source development by
donating to the authors or inquire about hiring them to
consult on other projects.  Donation/wish list links for
the author(s) are as follows:

Paul Lesniewski: https://squirrelmail.org/donate_paul_lesniewski.php



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

  * SquirrelMail version 1.4.23 or above

  * PHP Zlib support (compile with --with-zlib) only if
    you are using the compression feature with the
    "saml_sasl" module
    See: http://php.net/manual/en/zlib.installation.php



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

  * Note that if you have configured both the SquirrelMail
    $smtp_auth_mech and this plugin's $smtp_auth_type to
    different values, it is possible that if this plugin
    fails to authenticate the user, SquirrelMail may still
    authenticate the user using a different mechanism.  This
    may or may not be desirable, and can certainly create some
    confusion.  Configure your system carefully.

  * If changes to the configuration file don't seem to be having
    any effect, ensure that there are not two SMTP Authentication
    configuration files, one in the smtp_auth directory and
    one in the main SquirrelMail config directory (named
    "config_smtp_auth.php").  The one in the main SquirrelMail
    config directory will always override the one in the
    smtp_auth directory.

  * For the "saml_sasl" module, you should first ensure that you
    have a working single sign-on authentication system in place.
    You can find a few tips for doing so using a
    crudesaml/mod_auth_mellon-based system in the contrib/README.crudesaml
    file, but if you have more detailed questions, you need to
    search for the answers in locations specific to crudesaml or
    mod_auth_mellon, which does NOT include the plugin authors
    or the SquirrelMail mailing lists.



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

Before looking for help elsewhere, please try to help yourself:

  * Read the Troubleshooting section herein.

  * Look to see if others have already asked about the same issue.
    There are tips and links for the best places to do this in
    the SquirrelMail mailing list posting guidelines:
    http://squirrelmail.org/wiki/MailingListPostingGuidelines
    You should also try Google or some other search engine.

  * If you cannot find any information about your issue, please
    first mail your help request to the squirrelmail-plugins
    mailing list.  Information about it can be found here:
    http://lists.sourceforge.net/mailman/listinfo/squirrelmail-plugins
    You MUST read the mailing list posting guidelines (see above)
    and include as much information about your issue (and your
    system) as possible.  Including configtest output, any debug
    output, the plugin configuration settings you've made and
    anything else you can think of to make it easier to diagnose
    your problem will get you the most useful responses.  Inquiries
    that do not comply with the posting guidelines are liable to
    be ignored.

  * If you don't get any replies on the mailing list, you are
    welcome to send a help request to the authors' personal
    address(es), but please be patient with the mailing list.



TODO
====

  * Ideas?



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

  1.0  2012/06/30  Paul Lesniewski <paul@squirrelmail.org>
   * Initial release

