XMXUTIL2 ;ISC-SF/GMB-Message info ;04/19/2002 13:34
Source file <XMXUTIL2.m>
| Name | Comments | DBIA/ICR reference | 
|---|---|---|
| READ(XMZUREC) | ; How many responses has the user read? ; null = the user has not read the message ; 0 = the user has read the original message only ; number = the user has read through this response | |
| INMSG1(XMDUZ,XMZ,XMZREC,XMFLAGS,XMIM,XMIU) | ; (Should NOT be called for responses!) ; XMIM("RESPS") ; XMIU("IEN") ; XMIU("RESP") | 
 
 | 
| SUBJ(XMZREC) | ; What is the message subject? | 
 
 | 
| BSKT(XMDUZ,XMZ,XMNAME) | ; Which basket is the message in for this user? ; in: ; XMDUZ,XMZ ; XMNAME Return basket name as second piece? 0=no (default); 1=yes ; returns: ; 0 = it's not in any basket ; number = it's in this basket ien ($G(XMNAME)=0) ; number^name = it's in this basket ien^name (XMNAME=1) | 
 
 | 
| ZDATE(XMZ,XMTIME) | ; What is the message date? (Formatted by $$MMDT^XMXUTIL1) ; XMTIME =0 Date only ; =1 Date and time (default) | 
 
 | 
| ZFROM(XMZ) | ; Who sent the message? | 
 
 | 
| FROM(XMZREC) | ; Who sent the message? | 
 
 | 
| NEW(XMDUZ,XMK,XMZ) | ; Is the message new for this user? ; 0 = no; 1 = yes; 2 = yes, and it's priority, too. | 
 
 | 
| ZSUBJ(XMZ) | ; What is the message subject? | 
 
 | 
| INMSG2(XMDUZ,XMZ,XMZREC,XMIM,XMINSTR,XMIU) | ; ; Should NOT be called for responses! ; Does not kill XMIM, XMINSTR, or XMIU first ; XMIM("RECIPS") number of recipients of the message ; XMIU("ORIGN8") user sent message (0=no; 1=yes) ; The following are set only if applicable: ; XMINSTR("FLAGS") ; XMINSTR("RCPT BSKT") ; XMINSTR("TYPE") ; XMINSTR("VAPOR") ; XMINSTR("SCR HINT") | 
 
 | 
| INM(XMZ,XMZREC,XMFLAGS,XMIM) | ; For internal MailMan use only. ; XMIM and XMIU are killed first ; out: ; Always returned: ; XMIM("XMZ") ; XMIM("SUBJ") ; XMIM("FROM") ; XMIM("DATE") ; XMIM("CRE8") ; XMIM("SENDR") ; XMIM("LINES") ; XMIM("ENV FROM") 'Envelope From' returned only if it exists ; Returned if XMFLAGS'["I": ; XMIM("FROM DUZ") ; XMIM("FROM NAME") ; XMIM("DATE FM") Returned if XMFLAGS["F" ; XMIM("DATE MM") Returned if XMFLAGS'["F" ; XMIM("CRE8 MM") Returned if XMFLAGS'["F" ; XMIM("SENDR DUZ") ; XMIM("SENDR NAME") | |
| QRESP(XMZ,XMZREC,XMWHICH) | ; Function returns 0 if message XMZ is a message. ; If message XMZ is a response, returns XMZ of original message ; and, optionally, the response number as the second piece. ; in: ; XMZ XMZ of the message to be checked ; XMZREC (optional) 0-node of the message ; XMWHICH (optional) If the message is a response, should MailMan also ; return the response number as the second piece? ; (0=no (default); 1=yes) | 
 
 | 
| KSEQN(XMDUZ,XMK,XMZ) | ; What's the seqence number for this message in this user's basket? | 
 
 | 
| INMSG(XMDUZ,XMK,XMZ,XMZREC,XMFLAGS,XMIM,XMINSTR,XMIU) | ; ; Should NOT be called for responses! ; XMFLAGS If XMFLAGS["I" return internal only ; ["F" return FM date ; XMIU("KVAPOR") If applicable, user-specified vaporize date for message in basket ; XMIU("NEW") Is message new? (0=no; 1=yes; 2=yes, and priority, too) | 
 
 | 
| ZNODE(XMZ) | ; Returns the zero node of the message. | 
 
 | 
| ZREAD(XMDUZ,XMZ) | ; How many responses has the user read? ; null = the user has not read the message ; 0 = the user has read the original message only ; number = the user has read through this response | 
 
 | 
| SEQN(XMKZREC) | ; What's the seqence number for this message in this user's basket? | |
| PRI(XMZREC) | ; Is the message priority? | 
 
 | 
| ZPRI(XMZ) | ; Is the message priority? | 
 
 | 
| INRESPS(XMZ,XMIM,XMIU) | ; How many responses?  What's the user read? ; In: ; XMZ ; XMIU("IEN") ien of user's record in recipient multiple ; Out: ; XMIM("RESPS") message has this many responses ; XMIU("RESP") last response read by the user ; (null=not read at all; 0=original msg only; number=resp) | 
 
 | 
| LINE(XMZ) | ; How many lines does the message have? | 
 
 | 
| INRESP(XMZ,XMIEN,XMFLAGS,XMIR) | ; Get info on a response to a message. ; In: ; XMZ XMZ of original message ; XMIEN Which response (1 thru # of responses) ; XMFLAGS If XMFLAGS["I" return internal only ; ["F" return FM date ; Out: ; XMIR | 
 
 | 
| DATE(XMZREC,XMTIME) | ; What is the message date? (Formatted by $$MMDT^XMXUTIL1) ; XMTIME =0 Date only ; =1 Date and time (default) | 
 
 | 
| RESP(XMZ) | ; How many responses does this message have? | 
 
 | 
| Name | Line Occurrences (* Changed, ! Killed) | 
|---|---|
| ^XMB(3.7 - [#3.7] | INMSG+10, BSKT+9, BSKT+12, NEW+2, NEW+3, KSEQN+1 | 
| ^XMB(3.9 - [#3.9] | QRESP+10, QRESP+16, INMSG1+4, INMSG1+8, INM+22, INM+27, INM+28, INM+29, INM+31, INRESPS+8 , INRESPS+9, INRESP+10, INRESP+11, INRESP+12, INMSG2+11, INMSG2+12, INMSG2+25, INMSG2+27, INMSG2+32, ZNODE+1 , ZDATE+3, ZSUBJ+1, ZFROM+1, ZPRI+1, LINE+1, RESP+1, ZREAD+6, ZREAD+8 | 
| Name | Line Occurrences | 
|---|---|
| $$DATE | INM+42, ZDATE+3 | 
| $$FROM | ZFROM+1 | 
| $$NEW | INMSG+12 | 
| $$PRI | ZPRI+1 | 
| $$READ | ZREAD+8 | 
| $$SEQN | KSEQN+1 | 
| $$SUBJ | ZSUBJ+1 | 
| INM | INMSG1+6, INRESP+13 | 
| INMSG1 | INMSG+6 | 
| INMSG2 | INMSG+7 | 
| INRESPS | INMSG1+9 | 
| Name | Field # of Occurrence | 
|---|---|
| ^( | QRESP+16 | 
| >> | Not killed explicitly | 
| * | Changed | 
| ! | Killed | 
| ~ | Newed | 
| Name | Field # of Occurrence | 
|---|---|
| U | QRESP+11, QRESP+14, INMSG+11, INM+24, INM+25, INM+26, INM+27, INM+28, INM+31, INRESPS+8 , INRESPS+9, INMSG2+11, INMSG2+14, INMSG2+15, INMSG2+20, INMSG2+21, INMSG2+22, INMSG2+23, INMSG2+24, INMSG2+27 , INMSG2+32, DATE+4, SUBJ+2, FROM+1, PRI+1, LINE+1, RESP+1, READ+4, BSKT+12, SEQN+1 | 
| XMDATE | DATE+3~, DATE+4*, DATE+6, DATE+8, DATE+9 | 
| XMDUZ | INMSG~, INMSG+6, INMSG+7, INMSG+10, INMSG+12, INMSG1~, INMSG1+8, INMSG2~, INMSG2+13, ZREAD~ , ZREAD+6, BSKT~, BSKT+9, BSKT+12, NEW~, NEW+2, NEW+3, KSEQN~, KSEQN+1 | 
| XMFLAGS | INMSG~, INMSG+6, INMSG1~, INMSG1+5*, INMSG1+6, INM~, INM+33, INM+39, INRESP~, INRESP+13 | 
| XMFM | DATE+7~, DATE+8*, DATE+9, DATE+10 | 
| XMIEN | INRESP~, INRESP+10, INRESP+11 | 
| XMIM | INMSG~, INMSG+6, INMSG+7, INMSG1~, INMSG1+6, INMSG1+9, INM~, INM+20!, INRESPS~, INMSG2~ | 
| XMIM("CRE8 MM | " , INM+43* | 
| XMIM("CRE8" | INM+27*, INM+43 | 
| XMIM("DATE FM | " , INM+40*, INM+41* | 
| XMIM("DATE MM | " , INM+42* | 
| XMIM("DATE" | INM+25*, INM+40, INM+41 | 
| XMIM("ENV FRO | M" , INM+32* | 
| XMIM("FROM DU | Z" , INM+35* | 
| XMIM("FROM NA | ME" , INM+34*, INM+35* | 
| XMIM("FROM" | INM+24*, INM+34, INM+35 | 
| XMIM("LINES" | INM+28* | 
| XMIM("RECIPS" | INMSG2+11* | 
| XMIM("RESPS" | INRESPS+8* | 
| XMIM("SENDR D | UZ" , INM+38* | 
| XMIM("SENDR N | AME" , INM+37*, INM+38* | 
| XMIM("SENDR" | INM+26*, INM+36, INM+37, INM+38 | 
| XMIM("SUBJ" | INM+23* | 
| XMIM("XMZ" | INM+21* | 
| XMINSTR | INMSG~, INMSG+7, INMSG2~ | 
| XMINSTR("FLAGS" | INMSG2+19*, INMSG2+20*, INMSG2+21*, INMSG2+22*, INMSG2+23*, INMSG2+30*, INMSG2+32* | 
| XMINSTR("RCPT | BSKT" , INMSG2+28* | 
| XMINSTR("SCR | HINT" , INMSG2+24* | 
| XMINSTR("TYPE" | INMSG2+15*, INMSG2+17, INMSG2+18*, INMSG2+29, INMSG2+31* | 
| XMINSTR("VAPOR" | INMSG2+14* | 
| XMIR | INRESP~, INRESP+9!, INRESP+13 | 
| XMIU | INMSG~, INMSG+6, INMSG+7, INMSG1~, INMSG1+7!, INMSG1+9, INRESPS~, INMSG2~ | 
| XMIU("IEN" | INMSG1+8*, INRESPS+9, INMSG2+32 | 
| XMIU("KVAPOR" | INMSG+11* | 
| XMIU("NEW" | INMSG+12* | 
| XMIU("ORIGN8" | INMSG2+13* | 
| XMIU("RESP" | INRESPS+9* | 
| XMK | INMSG~, INMSG+8, INMSG+10, INMSG+12, BSKT+8~, BSKT+9*, BSKT+10, BSKT+11, BSKT+12, NEW~ , NEW+2, NEW+3, KSEQN~, KSEQN+1 | 
| XMKREC | INMSG+9~, INMSG+10*, INMSG+11 | 
| XMKZREC | SEQN~, SEQN+1 | 
| XMNAME | BSKT~, BSKT+11 | 
| XMNVFROM | INM+30~, INM+31*, INM+32 | 
| XMSUBJ | SUBJ+1~, SUBJ+2*, SUBJ+3, SUBJ+4, SUBJ+5 | 
| XMTIME | ZDATE~, ZDATE+3, DATE~, DATE+5*, DATE+6, DATE+8 | 
| XMUPTR | ZREAD+4~, ZREAD+6*, ZREAD+8 | 
| XMWHICH | QRESP~, QRESP+14, QRESP+15*, QRESP+16* | 
| XMZ | QRESP~, QRESP+10, QRESP+14, QRESP+16, INMSG~, INMSG+6, INMSG+7, INMSG+10, INMSG+12, INMSG1~ , INMSG1+4, INMSG1+6, INMSG1+8, INMSG1+9, INM~, INM+21, INM+22, INM+27, INM+28, INM+29 , INM+31, INRESPS~, INRESPS+8, INRESPS+9, INRESP~, INRESP+10, INRESP+11, INMSG2~, INMSG2+11, INMSG2+12 , INMSG2+16, INMSG2+25, INMSG2+27, INMSG2+32, ZNODE~, ZNODE+1, ZDATE~, ZDATE+3, ZSUBJ~, ZSUBJ+1 , ZFROM~, ZFROM+1, ZPRI~, ZPRI+1, LINE~, LINE+1, RESP~, RESP+1, ZREAD~, ZREAD+6 , ZREAD+8, BSKT~, BSKT+9, NEW~, NEW+2, NEW+3, KSEQN~, KSEQN+1 | 
| XMZBSKT | INMSG2+26~, INMSG2+27*, INMSG2+28 | 
| XMZO | QRESP+9~, QRESP+11*, QRESP+14, QRESP+16 | 
| XMZR | INRESP+8~, INRESP+11*, INRESP+12, INRESP+13 | 
| XMZREC | QRESP~, QRESP+10*, QRESP+11, INMSG~, INMSG+6, INMSG+7, INMSG1~, INMSG1+4*, INMSG1+6, INM~ , INM+22*, INM+23, INM+24, INM+25, INM+26, INM+42, INRESP+8~, INRESP+12*, INRESP+13, INMSG2~ , INMSG2+12*, INMSG2+13, INMSG2+14, INMSG2+15, INMSG2+16, INMSG2+20, INMSG2+21, INMSG2+22, INMSG2+23, INMSG2+24 , DATE~, DATE+4, SUBJ~, SUBJ+2, FROM~, FROM+1, PRI~, PRI+1 | 
| XMZUREC | READ~, READ+4 |