SEND A BULLETIN API ICR (10069)

Name

Value

NUMBER

10069

IA #

10069

DATE CREATED

1995/02/08

CUSTODIAL PACKAGE

MAILMAN

CUSTODIAL ISC

San Francisco

USAGE

Supported

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

XMB

NAME

SEND A BULLETIN API

ORIGINAL NUMBER

10069

GENERAL DESCRIPTION

This API sends bulletins and has the following entry
points:

^XMB - Create and send a bulletin in the background (task).
EN^XMB - Create and send a bulletin in the foreground (while you wait).
BULL^XMB - Interactively select a bulletin, define its parameters,
and send it.

See the MailMan Programmer Manual, Appendix D, Setting up Bulletins, for
information on bulletins, how to set them up, and how to create a bulletin
cross reference.

STATUS

Active

XMB

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

XMB

Create and send a bulletin in the background.  A task
is created to do this.  XMZ, the IEN of the bulletin created in the MESSAGE
file (#3.9), is not returned.  Unless you need to know XMZ, this entry point
is preferred over EN^XMB, because it is faster.

Compare to TASKBULL^XMXAPI (DBIA 2729).

Recipients of the bulletin will include any entries in the XMY array that the
caller has defined and the members of mail groups that are included in the
definition of the entry in the Bulletin file (#3.6) at the time of delivery.
There must be valid recipients or the bulletin will not be delivered.

Usage: D ^XMB

Inputs:
XMB              - name of Bulletin (in file 3.6)
XMB(parameter #) - value to be stuffed into the bulletin for
each parameter. (eg. XMB(1)=data for parameter #1)
XMTEXT(line)     - optional text to append to the bulletin
XMY(DUZ or name@inst) - optional additional recipients
XMDUZ            - optional sender's DUZ
XMDT             - optional Date-Time for future delivery

VARIABLES	TYPE	VARIABLES DESCRIPTION
DUZ	Input	Identity of the user. The user's IEN in the NEW PERSON file.
XMB	Input	See variable description for EN^XMB. XMB is not killed.
XMB(	Used	(optional) See variable description for EN^XMB. XMB array is not killed.
XMBTMP	Used	(optional) See variable description for EN^XMB.
XMDF	Used	(optional) See variable description for EN^XMB.
XMDT	Used	(optional) Date or date/time in the future when the bulletin should be sent. Default is NOW. Must be in a format which FileMan can understand.
XMDUZ	Input	The user's DUZ or free text. This is from whom the bulletin will appear to be.
XMTEXT	Used	(optional) See variable description for EN^XMB.
XMY	Used	(optional) See variable description for EN^XMB.

Create and send a bulletin in the foreground, i.e.
while you wait.  The delivery will happen in the background.  XMZ, the IEN of
the bulletin created in the MESSAGE file (#3.9), is returned.

Compare to SENDBULL^XMXAPI (DBIA 2729).

The recipients of the bulletin will include any entries in the XMY array that
the caller has defined and the members of mail groups that are included in the
definition of the entry in the Bulletin file (#3.6) at the time of delivery.
There must be valid recipients or the bulletin will not be delivered.

Usage: D EN^XMB

Inputs:
XMB              - name of Bulletin (in file 3.6)
XMB(parameter #) - value to be stuffed into the bulletin for
each parameter. (eg. XMB(1)=data for parameter #1)
XMTEXT(line)     - optional text to append to the bulletin
XMY(DUZ or name@inst) - optional additional recipients
XMDUZ            - optional sender's DUZ

Outputs:
XMZ              - message number

VARIABLES	TYPE	VARIABLES DESCRIPTION
DUZ	Used	(optional) The identity of the user. The user's IEN in the NEW PERSON file. Default is .5, the POSTMASTER.
XMDUZ	Used	(optional) The user's DUZ or free text. This is from whom the bulletin will appear to be. Default is DUZ.
XMB(	Used	If the bulletin has parameters, this must be an array containing the parameters to insert into the bulletin. XMB(1) = parameter 1 XMB(2) = parameter 2 etc. XMB is killed upon successful completion of this API.
XMBTMP	Used	(optional) If $D(XMBTMP), then MailMan will not initialize (kill) the ^TMP addressee global, because it contains bulletin addressees set prior to calling this API.
XMDF	Used	(optional) If $D(XMDF) all addressing restrictions are waived.
XMTEXT	Used	(optional) The open root of an array containing additional text to append to the bulletin. The array must be compatible with FileMan word processing APIs. XMTEXT is killed upon successful completion of this API.
XMY	Used	(optional) Array of addressees, in addition to the mail groups already defined in the bulletin, to which to send the bulletin. XMY(addressee A)="" XMY(addressee B)="" etc. XMY is killed upon successful completion of this API.
XMB	Both	The full name of the bulletin. It must be the complete name in the correct case. If the bulletin is not found, XMB will be set to -1. XMB is killed upon successful completion of this API.
XMZ	Output	The IEN in the MESSAGE file (3.9) of the bulletin.

BULL

Manually create and send a bulletin.  MailMan
interactively takes the user through the selection, creation, and sending of a
bulletin.

DUZ and XMDUZ must already be defined.