Home   Package List   Routine Alphabetical List   Global Alphabetical List   FileMan Files List   FileMan Sub-Files List   Package Component Lists   Package-Namespace Mapping  
Routine: XMXAPIB

XMXAPIB.m

Go to the documentation of this file.
  1. XMXAPIB ;ISC-SF/GMB-Mailbox and Mail Basket APIs ;04/17/2002 14:07
  1. ;;8.0;MailMan;;Jun 28, 2002
  1. ; All entry points covered by DBIA 2723.
  1. ; XMDUZ User's DUZ, or enough of user's name for a positive ID
  1. ; XMK Basket number, or enough of a name for a positive ID
  1. ; ***** Mailbox actions
  1. CRE8MBOX(XMDUZ,XMDATE) ; Create a mailbox
  1. ; In: User
  1. ; User must be POSTMASTER or POSTMASTER surrogate and possess XMMGR key.
  1. I '$D(XMV) N XMV,XMDISPI,XMDUN,XMNOSEND,XMPRIV
  1. D CRE8MBOX^XMXPARMB(.XMDUZ,.XMDATE) Q:$D(XMERR)
  1. D CRE8MBOX^XMXMBOX(XMDUZ,.XMDATE)
  1. Q
  1. FLTRMBOX(XMDUZ,XMMSG) ; Filter all messages in a user's mailbox
  1. ; In: User
  1. I '$D(XMV) N XMV,XMDISPI,XMDUN,XMNOSEND,XMPRIV
  1. D MBOX^XMXPARMB(.XMDUZ) Q:$D(XMERR)
  1. D FLTRMBOX^XMXMBOX(XMDUZ,.XMMSG)
  1. Q
  1. QMBOX(XMDUZ,XMMSG) ; Query a mailbox
  1. ; # msgs^# new msgs^date/time last msg received^priority mail (0/1)
  1. ; In: User, Query type
  1. I '$D(XMV) N XMV,XMDISPI,XMDUN,XMNOSEND,XMPRIV
  1. D MBOX^XMXPARMB(.XMDUZ) Q:$D(XMERR)
  1. D QMBOX^XMXMBOX(XMDUZ,.XMMSG)
  1. Q
  1. TERMMBOX(XMDUZ) ; Remove all traces of a user in MM globals
  1. ; In: User
  1. ; User must be POSTMASTER or POSTMASTER surrogate and possess XMMGR key.
  1. I '$D(XMV) N XMV,XMDISPI,XMDUN,XMNOSEND,XMPRIV
  1. D TERMMBOX^XMXPARMB(.XMDUZ) Q:$D(XMERR)
  1. D TERMMBOX^XMXMBOX(XMDUZ)
  1. Q
  1. ; ***** Basket actions
  1. CRE8BSKT(XMDUZ,XMKN,XMK) ; Create a basket
  1. ; In: User, basket name
  1. ; Out: Basket number
  1. I '$D(XMV) N XMV,XMDISPI,XMDUN,XMNOSEND,XMPRIV
  1. D CRE8BSKT^XMXPARMB(.XMDUZ,.XMKN) Q:$D(XMERR)
  1. D CRE8BSKT^XMXBSKT(XMDUZ,XMKN,.XMK)
  1. Q
  1. DELBSKT(XMDUZ,XMK,XMFLAGS) ; Delete basket
  1. ; In: User, basket
  1. I '$D(XMV) N XMV,XMDISPI,XMDUN,XMNOSEND,XMPRIV
  1. D DELBSKT^XMXPARMB(.XMDUZ,.XMK,.XMFLAGS) Q:$D(XMERR)
  1. D DELBSKT^XMXBSKT(XMDUZ,XMK,.XMFLAGS)
  1. Q
  1. FLTRBSKT(XMDUZ,XMK,XMMSG) ; Filter all messages in a user's basket
  1. ; In: User
  1. I '$D(XMV) N XMV,XMDISPI,XMDUN,XMNOSEND,XMPRIV
  1. D BSKT^XMXPARMB(.XMDUZ,.XMK) Q:$D(XMERR)
  1. D FLTRBSKT^XMXBSKT(XMDUZ,XMK,.XMMSG)
  1. Q
  1. LISTBSKT(XMDUZ,XMFLAGS,XMAMT,XMSTART,XMPART,XMTROOT) ;
  1. I '$D(XMV) N XMV,XMDISPI,XMDUN,XMNOSEND,XMPRIV
  1. D LISTBSKT^XMXPARMB(XMDUZ,.XMFLAGS,.XMAMT,.XMSTART,.XMPART,.XMTROOT) Q:$D(XMERR)
  1. D LISTBSKT^XMXBSKT(XMDUZ,.XMFLAGS,.XMAMT,.XMSTART,.XMPART,.XMTROOT)
  1. Q
  1. LISTMSGS(XMDUZ,XMK,XMFLDS,XMFLAGS,XMAMT,XMSTART,XMCRIT,XMTROOT) ; List messages
  1. I '$D(XMV) N XMV,XMDISPI,XMDUN,XMNOSEND,XMPRIV
  1. D LISTMSGS^XMXPARMB(.XMDUZ,.XMK,.XMFLDS,.XMFLAGS,.XMAMT,.XMSTART,.XMCRIT,.XMTROOT) Q:$D(XMERR)
  1. D LISTMSGS^XMXLIST(XMDUZ,.XMK,.XMFLDS,.XMFLAGS,.XMAMT,.XMSTART,.XMCRIT,.XMTROOT)
  1. Q
  1. NAMEBSKT(XMDUZ,XMK,XMKN) ; Change the name of a basket
  1. ; In: User, basket, new basket name (@ will delete)
  1. I '$D(XMV) N XMV,XMDISPI,XMDUN,XMNOSEND,XMPRIV
  1. D NAMEBSKT^XMXPARMB(.XMDUZ,.XMK,.XMKN) Q:$D(XMERR)
  1. D NAMEBSKT^XMXBSKT(XMDUZ,XMK,XMKN)
  1. Q
  1. QBSKT(XMDUZ,XMK,XMMSG) ; Get info on a basket
  1. ; In: User, basket
  1. ; Out: basket ien^basket name^# msgs^# new msgs
  1. I '$D(XMV) N XMV,XMDISPI,XMDUN,XMNOSEND,XMPRIV
  1. D BSKT^XMXPARMB(.XMDUZ,.XMK) Q:$D(XMERR)
  1. D QBSKT^XMXBSKT(XMDUZ,XMK,.XMMSG)
  1. Q
  1. RSEQBSKT(XMDUZ,XMK,XMMSG) ; Resequence msgs in a basket
  1. ; In: User, basket
  1. I '$D(XMV) N XMV,XMDISPI,XMDUN,XMNOSEND,XMPRIV
  1. D BSKT^XMXPARMB(.XMDUZ,.XMK) Q:$D(XMERR)
  1. D RSEQBSKT^XMXBSKT(XMDUZ,XMK,.XMMSG)
  1. Q