Updated with new methods.
authorpallo <pallo@7612ce4b-ef26-0410-bec9-ea0150e637f0>
Sun, 2 Apr 2000 16:54:54 +0000 (16:54 +0000)
committerpallo <pallo@7612ce4b-ef26-0410-bec9-ea0150e637f0>
Sun, 2 Apr 2000 16:54:54 +0000 (16:54 +0000)
git-svn-id: https://svn.code.sf.net/p/squirrelmail/code/trunk/squirrelmail@376 7612ce4b-ef26-0410-bec9-ea0150e637f0

doc/addressbook.txt

index 29d87c1..fe746d5 100644 (file)
@@ -78,11 +78,13 @@ methods are provided:
    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 +110,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.