XMXAPI ;ISC-SF/GMB-Message APIs ; 4/2/09 10:11am
Source file <XMXAPI.m>
| Package | Total | Call Graph | 
|---|---|---|
| MailMan | 9 | ANSRMSG^XMXANSER  (SENDBULL,TASKBULL)^XMXBULL  (DELMSG,FLTRMSG,FWDMSG,LATERMSG,MOVEMSG,NTOGLMSG,PRTMSG,TERMMSG,VAPORMSG)^XMXMSGS  (PUTSERV,ZAPSERV)^XMXMSGS1  (ACTMSGS,ADDRNSND,ANSRMSG,BULLETIN,FWDMSG,LATERMSG,MOVEBODY,MOVEMSG,PRTMSG,REPLYMSG,SENDMSG,TOWHOM,VAPORMSG,VSUBJ)^XMXPARM  SERV^XMXPARMB  REPLYMSG^XMXREPLY  (ADDRNSND,CRE8XMZ,MOVEBODY,SENDMSG)^XMXSEND TOWHOM^XMXTO | 
| Name | Comments | DBIA/ICR reference | 
|---|---|---|
| MOVEBODY(XMZ,XMBODY) | ; Move text to the message | |
| 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) | 
 
 | 
| VSUBJ(XMSUBJ) | ; Validate a subject | 
 
 | 
| 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) | 
 
 | 
| ADDRNSND(XMDUZ,XMZ,XMTO,XMINSTR) | ; Build a message part 2 (address and send) ; XMZ (in) | 
 
 | 
| FLTRMSG(XMDUZ,XMK,XMKZA,XMMSG) | ; Filters msgs in a basket | 
 
 | 
| LATERMSG(XMDUZ,XMK,XMKZA,XMINSTR,XMMSG) | ; Later msgs ; XMINSTR("LATER") | 
 
 | 
| 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 | 
 
 | 
| CRE8XMZ(XMSUBJ,XMZ) | ; Build a message part 1 (create) ; In: subject ; Out: XMZ | 
 
 | 
| 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) | 
 
 | 
| PUTSERV(XMKN,XMZ) | ; Put a message in a server basket ; XMKN full server name, including "S." | 
 
 | 
| TERMMSG(XMDUZ,XMK,XMKZA,XMMSG) | ; Terminate msgs | 
 
 | 
| ZAPSERV(XMKN,XMZ) | ; Delete a message from a server basket ; XMKN full server name, including "S." | 
 
 | 
| VAPORMSG(XMDUZ,XMK,XMKZA,XMINSTR,XMMSG) | ; Set vaporize date for msgs in a basket ; XMINSTR("VAPOR") | 
 
 | 
| DELMSG(XMDUZ,XMK,XMKZA,XMMSG) | ; Delete msgs from a basket | 
 
 | 
| 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") | 
 
 | 
| 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 | 
 
 | 
| TOWHOM(XMDUZ,XMZ,XMTYPE,XMTO,XMINSTR,XMFULL) | ; Check ONE msg addressee ; XMFULL Expanded address of the addressee | 
 
 | 
| 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. | 
 
 | 
| NTOGLMSG(XMDUZ,XMK,XMKZA,XMMSG) | ; New Toggle msgs | 
 
 | 
| 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 | 
 
 | 
| Name | Field # of Occurrence | 
|---|---|
| ANSRMSG^XMXANSER | ANSRMSG+6 | 
| SENDBULL^XMXBULL | SENDBULL+6 | 
| TASKBULL^XMXBULL | TASKBULL+17 | 
| DELMSG^XMXMSGS | DELMSG+4 | 
| FLTRMSG^XMXMSGS | FLTRMSG+4 | 
| FWDMSG^XMXMSGS | FWDMSG+8 | 
| LATERMSG^XMXMSGS | LATERMSG+5 | 
| MOVEMSG^XMXMSGS | MOVEMSG+6 | 
| NTOGLMSG^XMXMSGS | NTOGLMSG+4 | 
| PRTMSG^XMXMSGS | PRTMSG+7 | 
| TERMMSG^XMXMSGS | TERMMSG+4 | 
| VAPORMSG^XMXMSGS | VAPORMSG+5 | 
| PUTSERV^XMXMSGS1 | PUTSERV+4 | 
| ZAPSERV^XMXMSGS1 | ZAPSERV+4 | 
| ACTMSGS^XMXPARM | DELMSG+3, FLTRMSG+3, NTOGLMSG+3, TERMMSG+3 | 
| ADDRNSND^XMXPARM | ADDRNSND+4 | 
| ANSRMSG^XMXPARM | ANSRMSG+5 | 
| BULLETIN^XMXPARM | SENDBULL+5, TASKBULL+16 | 
| FWDMSG^XMXPARM | FWDMSG+7 | 
| LATERMSG^XMXPARM | LATERMSG+4 | 
| MOVEBODY^XMXPARM | MOVEBODY+2 | 
| MOVEMSG^XMXPARM | MOVEMSG+5 | 
| PRTMSG^XMXPARM | PRTMSG+6 | 
| REPLYMSG^XMXPARM | REPLYMSG+6 | 
| SENDMSG^XMXPARM | SENDMSG+7 | 
| TOWHOM^XMXPARM | TOWHOM+4 | 
| VAPORMSG^XMXPARM | VAPORMSG+4 | 
| VSUBJ^XMXPARM | CRE8XMZ+4, VSUBJ+2 | 
| SERV^XMXPARMB | PUTSERV+3, ZAPSERV+3 | 
| REPLYMSG^XMXREPLY | REPLYMSG+7 | 
| ADDRNSND^XMXSEND | ADDRNSND+5 | 
| CRE8XMZ^XMXSEND | CRE8XMZ+5 | 
| MOVEBODY^XMXSEND | MOVEBODY+3 | 
| SENDMSG^XMXSEND | SENDMSG+8 | 
| TOWHOM^XMXTO | TOWHOM+5 | 
| >> | Not killed explicitly | 
| * | Changed | 
| ! | Killed | 
| ~ | Newed | 
| Name | Field # of Occurrence | 
|---|---|
| DIERR | ANSRMSG+3~, DELMSG+1~, FLTRMSG+1~, FWDMSG+5~, LATERMSG+2~, MOVEMSG+3~, NTOGLMSG+1~, PRTMSG+4~, PUTSERV+2~, REPLYMSG+4~ , SENDBULL+3~, SENDMSG+5~, TASKBULL+14~, TERMMSG+1~, VAPORMSG+2~, ZAPSERV+2~, ADDRNSND+2~, CRE8XMZ+3~, MOVEBODY+1~, TOWHOM+2~ , VSUBJ+1~ | 
| XMATTACH | SENDBULL~, SENDBULL+5, SENDBULL+6, SENDMSG~, SENDMSG+7, SENDMSG+8, TASKBULL~, TASKBULL+16, TASKBULL+17 | 
| XMBN | SENDBULL~, SENDBULL+5, SENDBULL+6, TASKBULL~, TASKBULL+16, TASKBULL+17 | 
| XMBODY | ANSRMSG~, ANSRMSG+5, ANSRMSG+6, REPLYMSG~, REPLYMSG+6, REPLYMSG+7, SENDBULL~, SENDBULL+5, SENDBULL+6, SENDMSG~ , SENDMSG+7, SENDMSG+8, TASKBULL~, TASKBULL+16, TASKBULL+17, MOVEBODY~, MOVEBODY+2, MOVEBODY+3 | 
| XMDISPI | ANSRMSG+4~, DELMSG+2~, FLTRMSG+2~, FWDMSG+6~, LATERMSG+3~, MOVEMSG+4~, NTOGLMSG+2~, PRTMSG+5~, REPLYMSG+5~, SENDBULL+4~ , SENDMSG+6~, TASKBULL+15~, TERMMSG+2~, VAPORMSG+3~, ADDRNSND+3~, TOWHOM+3~ | 
| XMDUN | ANSRMSG+4~, DELMSG+2~, FLTRMSG+2~, FWDMSG+6~, LATERMSG+3~, MOVEMSG+4~, NTOGLMSG+2~, PRTMSG+5~, REPLYMSG+5~, SENDBULL+4~ , SENDMSG+6~, TASKBULL+15~, TERMMSG+2~, VAPORMSG+3~, ADDRNSND+3~, TOWHOM+3~ | 
| XMDUZ | ANSRMSG~, ANSRMSG+5, ANSRMSG+6, DELMSG~, DELMSG+3, DELMSG+4, FLTRMSG~, FLTRMSG+3, FLTRMSG+4, FWDMSG~ , FWDMSG+7, FWDMSG+8, LATERMSG~, LATERMSG+4, LATERMSG+5, MOVEMSG~, MOVEMSG+5, MOVEMSG+6, NTOGLMSG~, NTOGLMSG+3 , NTOGLMSG+4, PRTMSG~, PRTMSG+6, PRTMSG+7, REPLYMSG~, REPLYMSG+6, REPLYMSG+7, SENDBULL~, SENDBULL+5, SENDBULL+6 , SENDMSG~, SENDMSG+7, SENDMSG+8, TASKBULL~, TASKBULL+16, TASKBULL+17, TERMMSG~, TERMMSG+3, TERMMSG+4, VAPORMSG~ , VAPORMSG+4, VAPORMSG+5, ADDRNSND~, ADDRNSND+4, ADDRNSND+5, TOWHOM~, TOWHOM+4, TOWHOM+5 | 
| >> XMERR | ANSRMSG+5, DELMSG+3, FLTRMSG+3, FWDMSG+7, LATERMSG+4, MOVEMSG+5, NTOGLMSG+3, PRTMSG+6, PUTSERV+3, REPLYMSG+6 , SENDBULL+5, SENDMSG+7, TASKBULL+16, TERMMSG+3, VAPORMSG+4, ZAPSERV+3, ADDRNSND+4, CRE8XMZ+4, MOVEBODY+2, TOWHOM+4 | 
| XMFULL | TOWHOM~, TOWHOM+5 | 
| XMINSTR | ANSRMSG~, ANSRMSG+5, ANSRMSG+6, FWDMSG~, FWDMSG+7, FWDMSG+8, LATERMSG~, LATERMSG+4, LATERMSG+5, PRTMSG~ , PRTMSG+6, PRTMSG+7, REPLYMSG~, REPLYMSG+6, REPLYMSG+7, SENDBULL~, SENDBULL+5, SENDBULL+6, SENDMSG~, SENDMSG+7 , SENDMSG+8, TASKBULL~, TASKBULL+16, TASKBULL+17, VAPORMSG~, VAPORMSG+4, VAPORMSG+5, ADDRNSND~, ADDRNSND+4, ADDRNSND+5 , TOWHOM~, TOWHOM+4, TOWHOM+5 | 
| XMK | ANSRMSG~, ANSRMSG+5, ANSRMSG+6, DELMSG~, DELMSG+3, DELMSG+4, FLTRMSG~, FLTRMSG+3, FLTRMSG+4, FWDMSG~ , FWDMSG+7, FWDMSG+8, LATERMSG~, LATERMSG+4, LATERMSG+5, MOVEMSG~, MOVEMSG+5, MOVEMSG+6, NTOGLMSG~, NTOGLMSG+3 , NTOGLMSG+4, PRTMSG~, PRTMSG+6, PRTMSG+7, REPLYMSG~, REPLYMSG+6, REPLYMSG+7, TERMMSG~, TERMMSG+3, TERMMSG+4 , VAPORMSG~, VAPORMSG+4, VAPORMSG+5 | 
| XMKN | PUTSERV~, PUTSERV+3, PUTSERV+4, ZAPSERV~, ZAPSERV+3, ZAPSERV+4 | 
| XMKTO | MOVEMSG~, MOVEMSG+5, MOVEMSG+6 | 
| XMKZ | ANSRMSG~, ANSRMSG+5, ANSRMSG+6, REPLYMSG~, REPLYMSG+6, REPLYMSG+7 | 
| XMKZA | DELMSG~, DELMSG+3, DELMSG+4, FLTRMSG~, FLTRMSG+3, FLTRMSG+4, FWDMSG~, FWDMSG+7, FWDMSG+8, LATERMSG~ , LATERMSG+4, LATERMSG+5, MOVEMSG~, MOVEMSG+5, MOVEMSG+6, NTOGLMSG~, NTOGLMSG+3, NTOGLMSG+4, PRTMSG~, PRTMSG+6 , PRTMSG+7, TERMMSG~, TERMMSG+3, TERMMSG+4, VAPORMSG~, VAPORMSG+4, VAPORMSG+5 | 
| XMMSG | DELMSG~, DELMSG+4, FLTRMSG~, FLTRMSG+4, FWDMSG~, FWDMSG+8, LATERMSG~, LATERMSG+5, MOVEMSG~, MOVEMSG+6 , NTOGLMSG~, NTOGLMSG+4, PRTMSG~, PRTMSG+7, TERMMSG~, TERMMSG+4, VAPORMSG~, VAPORMSG+5 | 
| XMNOSEND | ANSRMSG+4~, DELMSG+2~, FLTRMSG+2~, FWDMSG+6~, LATERMSG+3~, MOVEMSG+4~, NTOGLMSG+2~, PRTMSG+5~, REPLYMSG+5~, SENDBULL+4~ , SENDMSG+6~, TASKBULL+15~, TERMMSG+2~, VAPORMSG+3~, ADDRNSND+3~, TOWHOM+3~ | 
| XMPARM | SENDBULL~, SENDBULL+5, SENDBULL+6, TASKBULL~, TASKBULL+16, TASKBULL+17 | 
| XMPRIV | ANSRMSG+4~, DELMSG+2~, FLTRMSG+2~, FWDMSG+6~, LATERMSG+3~, MOVEMSG+4~, NTOGLMSG+2~, PRTMSG+5~, REPLYMSG+5~, SENDBULL+4~ , SENDMSG+6~, TASKBULL+15~, TERMMSG+2~, VAPORMSG+3~, ADDRNSND+3~, TOWHOM+3~ | 
| XMPRTTO | PRTMSG~, PRTMSG+6, PRTMSG+7 | 
| XMSUBJ | ANSRMSG~, ANSRMSG+5, ANSRMSG+6, PRTMSG~, PRTMSG+6, PRTMSG+7, SENDMSG~, SENDMSG+7, SENDMSG+8, CRE8XMZ~ , CRE8XMZ+4, CRE8XMZ+5, VSUBJ~, VSUBJ+2 | 
| XMTASK | PRTMSG~, PRTMSG+7, TASKBULL~, TASKBULL+17 | 
| XMTO | ANSRMSG~, ANSRMSG+5, ANSRMSG+6, FWDMSG~, FWDMSG+7, FWDMSG+8, PRTMSG~, PRTMSG+6, PRTMSG+7, SENDBULL~ , SENDBULL+5, SENDBULL+6, SENDMSG~, SENDMSG+7, SENDMSG+8, TASKBULL~, TASKBULL+16, TASKBULL+17, ADDRNSND~, ADDRNSND+4 , ADDRNSND+5, TOWHOM~, TOWHOM+4, TOWHOM+5 | 
| XMTYPE | TOWHOM~, TOWHOM+4, TOWHOM+5 | 
| XMV | ANSRMSG+4~, DELMSG+2~, FLTRMSG+2~, FWDMSG+6~, LATERMSG+3~, MOVEMSG+4~, NTOGLMSG+2~, PRTMSG+5~, REPLYMSG+5~, SENDBULL+4~ , SENDMSG+6~, TASKBULL+15~, TERMMSG+2~, VAPORMSG+3~, ADDRNSND+3~, TOWHOM+3~ | 
| XMZ | PUTSERV~, PUTSERV+3, PUTSERV+4, SENDBULL~, SENDBULL+6, SENDMSG~, SENDMSG+8, ZAPSERV~, ZAPSERV+3, ZAPSERV+4 , ADDRNSND~, ADDRNSND+4, ADDRNSND+5, CRE8XMZ~, CRE8XMZ+5, MOVEBODY~, MOVEBODY+2, MOVEBODY+3, TOWHOM~, TOWHOM+4 , TOWHOM+5 | 
| XMZR | ANSRMSG~, ANSRMSG+6, REPLYMSG~, REPLYMSG+7 |