SquirrelMail Addressbook Internals
==================================
-This document describe how the SquirrelMail address book works. It is
+This document describes how the SquirrelMail address book works. It is
primarily intended for developers.
functions/addressbook.php is called. This function will create an
AddressBook object, add one backend for a personal address book (file
based storage), and add the LDAP backends defined in the $ldap_server
-configuration directive (is any).
+configuration directive (if any).
An addressbook can also be initialized like this if you want to:
moment), or false if it failed.
- search(QUERY, [BTYPE])
+ search(QUERY, [BNUM])
QUERY - Something to search for. At the moment, only
a string is allowed here, but advanced expressions
will be supported through an array of parameters.
- BTYPE - Optional backend type to search. Either "local"
- or "remote".
+ BNUM - Optional backend number to search.
This method will return an array of result arrays (see below), an
empty array if nothing was found, or false if the search failed.
- s_search(QUERY, [BTYPE])
+ s_search(QUERY, [BNUM])
The same as search(), but the result array is sorted by backend and
fullname before it is returned.
For the result of a search, lookup or list_addr, one or more result
arrays are used. These arrays contain the following keys:
- nickname: Unique identifier for this name in this backend. Onlu
+ nickname: Unique identifier for this name in this backend. Only
usable for the local_file backend, and possibly LDAP.
name: Person's full name.
email: Person's e-mail address.
----------------------
... more later ...
+
+Ask pallo@squirrelmail.org if you have any questions on how to build
+new address book backends.