XMXAPI ;ISC-SF/GMB - Message APIs ; 4/2/09 10:11am
Source file <XMXAPI.m>
| Name | Comments | DBIA/ICR reference | 
|---|---|---|
| ANSRMSG(XMDUZ,XMK,XMKZ,XMSUBJ,XMBODY,XMTO,XMINSTR,XMZR) | ; Answer a msg (Send new msg with copy of original msg inside)
 ; In: User, basket, msg # ; Out: XMZR (message number of answer)  | 
 
  | 
| DELMSG(XMDUZ,XMK,XMKZA,XMMSG) | ; Delete msgs from a basket
 | 
 
  | 
| FLTRMSG(XMDUZ,XMK,XMKZA,XMMSG) | ; Filters msgs in a basket
 | 
 
  | 
| FWDMSG(XMDUZ,XMK,XMKZA,XMTO,XMINSTR,XMMSG) | ; Forward msgs
 ; XMINSTR("SHARE DATE") ; XMINSTR("SHARE BSKT") ; XMINSTR("SELF BSKT") ; XMINSTR("FWD BY") substitute any string instead of XMDUZ name  | 
 
  | 
| LATERMSG(XMDUZ,XMK,XMKZA,XMINSTR,XMMSG) | ; Later msgs
 ; XMINSTR("LATER")  | 
 
  | 
| MOVEMSG(XMDUZ,XMK,XMKZA,XMKTO,XMMSG) | ; Move msgs from one basket to another
 ; XMKTO Basket number, or enough of a name for a positive ID. ; Identifies basket to move to  | 
 
  | 
| NTOGLMSG(XMDUZ,XMK,XMKZA,XMMSG) | ; New Toggle msgs
 | 
 
  | 
| PRTMSG(XMDUZ,XMK,XMKZA,XMPRTTO,XMINSTR,XMMSG,XMTASK,XMSUBJ,XMTO) | ; Print msgs
 ; XMINSTR("HDR"), "RESPS", "RECIPS", "WHEN" ; XMPRTTO Printer name ; XMSUBJ & XMTO used only if XMPRTTO is a P-MESSAGE device. Even then, they're optional.  | 
 
  | 
| PUTSERV(XMKN,XMZ) | ; Put a message in a server basket
 ; XMKN full server name, including "S."  | 
 
  | 
| REPLYMSG(XMDUZ,XMK,XMKZ,XMBODY,XMINSTR,XMZR) | ; Reply to msg (Attach reply to original msg)
 ; XMINSTR("NET REPLY") 1=send over the network; 0=don't (default) ; XMINSTR("NET SUBJ") Network Reply subject (see XMSUBJ) ; Out: XMZR (message number of answer)  | 
 
  | 
| SENDBULL(XMDUZ,XMBN,XMPARM,XMBODY,XMTO,XMINSTR,XMZ,XMATTACH) | ; Send a bulletin (returns XMZ)
 ; In: User, bulletin name, bulletin parameters, add'l text, ; add'l recipients, send now or later (when?), opt'l BLOB  | 
 
  | 
| SENDMSG(XMDUZ,XMSUBJ,XMBODY,XMTO,XMINSTR,XMZ,XMATTACH) | ; Send a msg
 ; In: User, basket (if you are recipient), all msg parts, ; priority?, closed?, (info?,cc?), send now or later (when?), ; (KIDS,MIME,text,PackMan), delete date (if to shared,mail) ; XMINSTR("RCPT BSKT")  | 
 
  | 
| TASKBULL(XMDUZ,XMBN,XMPARM,XMBODY,XMTO,XMINSTR,XMTASK,XMATTACH) | ; Send a bulletin (Task it - does not return XMZ)
 ; XMBN Bulletin name (must be full name) ; XMPARM Array of parameters necessary for bulletin ; ARRAY(1)="parameter 1" ; ARRAY(2)="parameter 2" ; XMBODY Additional text to append to the bulletin text ; (must be closed root, passed by value. See WP_ROOT ; definition for WP^DIE(), FM word processing filer) ; XMTO Additional addressee(s) ; XMINSTR("SELF BSKT") ; ***ETC.*** ; In: User, bulletin name, bulletin parameters, add'l text, ; add'l recipients, send now or later (when?), opt'l BLOB ; Out: XMTASK (task number)  | 
 
  | 
| TERMMSG(XMDUZ,XMK,XMKZA,XMMSG) | ; Terminate msgs
 | 
 
  | 
| VAPORMSG(XMDUZ,XMK,XMKZA,XMINSTR,XMMSG) | ; Set vaporize date for msgs in a basket
 ; XMINSTR("VAPOR")  | 
 
  | 
| ZAPSERV(XMKN,XMZ) | ; Delete a message from a server basket
 ; XMKN full server name, including "S."  | 
 
  | 
| ADDRNSND(XMDUZ,XMZ,XMTO,XMINSTR) | ; Build a message part 2 (address and send)
 ; XMZ (in)  | 
 
  | 
| CRE8XMZ(XMSUBJ,XMZ) | ; Build a message part 1 (create)
 ; In: subject ; Out: XMZ  | 
 
  | 
| MOVEBODY(XMZ,XMBODY) | ; Move text to the message
 | 
|
| TOWHOM(XMDUZ,XMZ,XMTYPE,XMTO,XMINSTR,XMFULL) | ; Check ONE msg addressee
 ; XMFULL Expanded address of the addressee  | 
 
  | 
| VSUBJ(XMSUBJ) | ; Validate a subject
 | 
 
  |