Misc. documentation fixes by Simon Dick.

[squirrelmail.git] / doc / addressbook.txt

diff --git a/doc/addressbook.txt b/doc/addressbook.txt
index fe746d584f484bdb2ba4c7e10185f1dba893fe07..4d1f7d8f82691df6a268d4717c7233fa41df562f 100644 (file)
--- a/doc/addressbook.txt
+++ b/doc/addressbook.txt
@@ -1,7 +1,7 @@
 SquirrelMail Addressbook Internals
 ==================================
 
 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.
 
 
 primarily intended for developers.
 
 


@@ -21,7 +21,7 @@ To initialize the address book, the function addressbook_init() from
 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
 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:
 
 
 An addressbook can also be initialized like this if you want to:
 


@@ -59,20 +59,19 @@ methods are provided:
    moment), or false if it failed.
 
 
    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.
 
 
      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.
 
 
 
    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.
 
    The same as search(), but the result array is sorted by backend and
    fullname before it is returned.


@@ -145,7 +144,7 @@ AddressBook->error variable. Feel free to ignore it.
 For the result of a search, lookup or list_addr, one or more result
 arrays are used. These arrays contain the following keys: 
 
 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.
              usable for the local_file backend, and possibly LDAP.
   name:      Person's full name.
   email:     Person's e-mail address.


@@ -163,3 +162,6 @@ In addition, the following keys may exist for some backends:
 ----------------------
 
 ... more later ...
 ----------------------
 
 ... more later ...

+
+Ask pallo@squirrelmail.org if you have any questions on how to build
+new address book backends.