Added the OPNA command for downloading attachments

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

diff --git a/citadel/techdoc/session.txt b/citadel/techdoc/session.txt
index 1994dd8a59e9dc248c787b26a6fb87e824885a85..f535a74c81ae3240f1f2459cb3945e7eece5c004 100644 (file)
--- a/citadel/techdoc/session.txt
+++ b/citadel/techdoc/session.txt
@@ -216,8 +216,6 @@ by the '|' symbol, and then a number that may contain the following bits:
  Other bits may be defined in the future.  The listing terminates, as with
 all listings, with "000" on a line by itself.
  
- Version 4.01 and above only:
-
  Starting with version 4.01 and above, floors are supported.  The first 
 argument to LKRN should be the number of the floor to list rooms from.  Only
 rooms from this floor will be listed.  If no arguments are passed to LKRN, or
@@ -226,6 +224,10 @@ if the floor number requested is (-1), rooms on all floors will be listed.
  The third field displayed on each line is the number of the floor the room
 is on.  The LFLR command should be used to associate floor numbers with
 floor names.
+ 
+ The fourth field displayed on each line is a "room listing order."  Unless
+there is a compelling reason not to, clients should sort any received room
+listings by this value.
 
  
  
@@ -570,6 +572,7 @@ and the room aide associated with the current room, can access this command.
  2. The name of the room's directory (if it's a directory room)
  3. Various flags (bits) associated with the room (see LKRN cmd above)
  4. The floor number on which the room resides
+ 5. The room listing order
   
   
  SETR   (SET Room attributes)
@@ -583,6 +586,7 @@ should be passed the following arguments:
  3. Various flags (bits) associated with the room (see LKRN cmd above)
  4. "Bump" flag (see below)
  5. The floor number on which the room should reside
+ 6. The room listing order
  
  *Important: You should always use GETR to retrieve the current attributes of
 the room, then change what you want to change, and then use SETR to write it
@@ -997,8 +1001,8 @@ file resides.  Possible return codes are:
  OK                            (file is open)
  
  If the file is successfully opened, OK will be returned, along with the
-size (in bytes) of the file, and (in version 5.00 and above) the time of last
-modification.
+size (in bytes) of the file, the time of last modification (if applicable),
+the filename (if known), and the MIME type of the file (if known).
  
  
  CLOS   (CLOSe the download file)
@@ -1623,9 +1627,27 @@ fails for any reason, ERROR is returned.
  
     "messages"     (purge old messages out of each room)
     "users"        (purge old users from the userlog)
+    "rooms"        (remove rooms which have not been posted in for some time)
+    "visits"       (purge dereferenced user/room relationship records)
   
  EXPI returns OK (probably after a long delay while it does its work) if it
 succeeds; otherwise it returns an ERROR code.
  
  This command is probably temporary, until we can work some sort of scheduler
 into the system.  It is implemented in the serv_expire module.
+ 
+  
+ 
+ MSG4   (read MeSsaGe, mode 4 -- enumerate MIME parts)
+ 
+     FIX ... do the writeup for this once it's done.
+ 
+
+  
+ OPNA   (OPeN Attachment)
+ 
+ Opens, as a download file, a component of a MIME-encoded message.  The two
+parameters which must be passed to this command are the message number and the
+name of the desired section.  If the message or section does not exist, an
+appropriate ERROR code will be returned; otherwise, if the open is successful,
+this command will succeed returning the same information as an OPEN command.