LDAP common
===========

SquirrelMail LDAP Client Plugin (ldap_client)
By Daniel Marczisovszky <marczi@dev-labs.com>

Copyright (c) 2005-2006 Daniel Marczisovszky <marczi@dev-labs.com>

Licensed under the GNU GPL. For full terms see the file COPYING that came
with the Squirrelmail distribution.          

Requires at least SquirrelMail 1.4.3


1. Description
===============

LDAP common is helper plugin which does not provide any feature for
SquirrelMail itself, rather it is like a shared library for the LDAP Address
Book and the LDAP Preferences plugin.



2. Configuration
================

Debug messages can be sent to a log file. This can be useful when you install
any of the LDAP plugins and want to know what happens exactly. To enable
logging, copy config_sample.php to config.php and set $ldapCommonDebug to true.
This will log LDAP operations to the log file.  If $ldapCommonLogFile is empty,
then logs will go to the web server's error log, otherwise it will log to the
specified log file.

If you want to enable debug logging from LDAP Preferences or LDAP Address Book
plugins, you should also specify the log file in config.php, but in this case,
$ldapCommonDebug can be set to false. However, setting it to false is not
recommended, since in that case low-level LDAP operations and errors will not
be logged. Recommendation is to enable debug log for LDAP Common plugin, when
LDAP Preferences or LDAP Address Book debug logging is enabled.

Important note: log will contain passwords as well, please delete the log
immediately after the plugin works correctly, and set file permission so that
only you can read the log file.