* Updated citmail.c with the latest stuff from the production system.

[citadel.git] / citadel / techdoc / api.txt

diff --git a/citadel/techdoc/api.txt b/citadel/techdoc/api.txt
index 3666a3026d4d59c7c8c8f63b612641a62871c5cf..421c06f3d45710b4f0ba4b1fc2e78d241c2eca45 100644 (file)
--- a/citadel/techdoc/api.txt
+++ b/citadel/techdoc/api.txt
@@ -62,28 +62,9 @@ to facilitate a consistent development experience.
 
 
 
- USER ACCOUNT RELATED FUNCTIONS
- ------------------------------
+ INTERPROCESS COMMUNICATION FUNCTIONS
+ ------------------------------------
  
- These are functions which access or manipulate user records.  Each function
-requires a user name, but a zero-length string may be substituted to request
-the currently-logged-in user.  If a lookup fails, ERROR+NOT_LOGGED_IN or
-ERROR+NO_SUCH_USER may be set.
-
-  
- int CtdlGetUserAccessLevel(char *UserName)
- 
- This function returns a user's access level, or -1 in the event of an error.
-The defined access levels are 1 through 6 and may be referenced in "axdefs.h"
-
-
- long CtdlGetUserNumber(char *UserName)
- 
- This function returns a user's user number, or -1 in the event of an error.
-User numbers are always unique to the entire system and never reused, even if
-the user account is deleted.
- 
- time_t CtdlGetUserLastCall(char *UserName)
+ int CtdlSendExpressMessage(char *ToUser, char *MsgText)
  
- This function returns the date and time (in standard Unix timestamp format)
-when the user last logged on to the server.
+ This function sends an express message (page) to the named user.