s/"/'/

[squirrelmail.git] / doc / addressbook.txt

diff --git a/doc/addressbook.txt b/doc/addressbook.txt
index 29d87c1e76a7d2157020079760fa3ddd67f14543..f0521e853e07c02850d1a466ab009d02fb78a2ae 100644 (file)
--- a/doc/addressbook.txt
+++ b/doc/addressbook.txt
@@ -59,30 +59,31 @@ methods are provided:
    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.
 
 
-  lookup(NICKNAME)  
+  lookup(NICKNAME, [BNUM])  
 
      NICKNAME - Return the user identified by NICKNAME in
      the addressbook.
 
+     BNUM - ID of the backend to look in (optional).
+
    This method will return one result array (see below), an empty
    array if nothing was found, or false if the search failed. The
    lookup is only performed in "local" type backends.
@@ -108,6 +109,33 @@ methods are provided:
    was added, or false if it failed.
 
 
+  remove(NICKNAME, BNUM)
+
+     NICKNAME - Delete the user identified by NICKNAME in the
+     addressbook or, if NICKNAME is an array, all users indentified by
+     nthe nicknames in the array.
+
+     BNUM - ID of the backend, as returned by add_backend, to remove
+     the user(s) from.
+
+   This method will retrun true if the user(s) was removed, or false
+   if removal failed.
+
+
+  modify(NICKNAME, USERDATA, BNUM)
+
+     NICKNAME - Update the user identified by NICKNAME in the
+     addressbook.
+
+     USERDATA - Array with user data. The exisiting data for the user
+     will be replaced with this.
+
+     BNUM - ID of the backend, as returned by add_backend, to update
+     the user in.
+
+   This method will retrun true if the user was modified, or false if
+   something failed.
+
 
 If one of the above methods fail, an error message is available in the
 AddressBook->error variable. Feel free to ignore it.
@@ -134,3 +162,6 @@ In addition, the following keys may exist for some backends:
 ----------------------
 
 ... more later ...
+
+Ask pallo@squirrelmail.org if you have any questions on how to build
+new address book backends.