X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fabook_ldap_server.php;h=043f7336a8f33711d268c16a4ad667e5d280046c;hp=57b4a43dc5375a559c65b41f948c3cb904cb8e04;hb=cb48c2455cde2cf6ba67944c45decc4eca7df306;hpb=7609273d61b2f995b35cace14f49d3b605a6e3e9 diff --git a/functions/abook_ldap_server.php b/functions/abook_ldap_server.php index 57b4a43d..043f7336 100644 --- a/functions/abook_ldap_server.php +++ b/functions/abook_ldap_server.php @@ -1,28 +1,31 @@ LDAP server hostname/IP-address - ** base => LDAP server root (base dn). Empty string allowed. - ** ? port => LDAP server TCP port number (default: 389) - ** ? charset => LDAP server charset (default: utf-8) - ** ? name => Name for LDAP server (default "LDAP: hostname") - ** Used to tag the result data - ** ? maxrows => Maximum # of rows in search result - ** ? timeout => Timeout for LDAP operations (in seconds, default: 30) - ** Might not work for all LDAP libraries or servers. - ** - ** NOTE. This class should not be used directly. Use the - ** "AddressBook" class instead. - ** - ** $Id$ - **/ + /** + * abook_ldap_server.php + * + * Copyright (c) 1999-2001 The Squirrelmail Development Team + * Licensed under the GNU GPL. For full terms see the file COPYING. + * + * Address book backend for LDAP server + * + * An array with the following elements must be passed to + * the class constructor (elements marked ? are optional): + * + * host => LDAP server hostname/IP-address + * base => LDAP server root (base dn). Empty string allowed. + * ? port => LDAP server TCP port number (default: 389) + * ? charset => LDAP server charset (default: utf-8) + * ? name => Name for LDAP server (default "LDAP: hostname") + * Used to tag the result data + * ? maxrows => Maximum # of rows in search result + * ? timeout => Timeout for LDAP operations (in seconds, default: 30) + * Might not work for all LDAP libraries or servers. + * + * NOTE. This class should not be used directly. Use the + * "AddressBook" class instead. + * + * $Id$ + */ class abook_ldap_server extends addressbook_backend { var $btype = 'remote'; @@ -222,5 +225,14 @@ return $ret; } // end search() + + // If you run a tiny LDAP server and you want the "List All" button + // to show EVERYONE, then uncomment this tiny block of code: + // + // function list_addr() { + // return $this->search("*"); + // } + // + // Careful with this -- it could get quite large for big sites. } ?>