Files > BULLETIN

name

BULLETIN

number

3.6

location

^XMB(3.6,

description

Bulletins are 'Super' messages. Each Bulletin has a text and a subject just like a normal message. But embedded within either the subject or the text can be variable fields that can be filled in with parameters. There is also a standard set of recipients in the form of a Mail Group that is associated with the bulletin. Bulletins are processed by MailMan either because of a special cross reference type of FileMan or because of a direct call in a routine. The interface for the direct call is described in the documentation on programmer entry points. FileMan sets up code that will issue a bulletin automatically when the special cross reference type is created. In either case the parameters that go into the text and/or the subject make each bulletin unique.

applicationGroups

XU;XM

Fields

#	Name	Location	Type	Details	Index	Description
.01	name(+)	0;1	FREE TEXT		B	This field is the name of the bulletin, in the standard format of a two character package prefix, followed by a descriptive name.
2	subject(+)	0;2	FREE TEXT			This is the subject of the bulletin, as it will appear to the recipient. Note that it may contain windows, just as in the "MESSAGE" field.
4	mail group	2;0	MULTIPLE	3.62		This is a list of the mail groups to which this bulletin will be directed when triggered. If no mail groups are defined, or they point to no users, then the bulletin is ignored.
5	retention days	0;3	NUMERIC			After this number of days, if the bulletin hasn't already been purged, it will be purged by the XMAUTOPURGE option. If zero or null, the bulletin will not have a purge date, and will not be purged by XMAUTOPURGE.
6	description	3;0	WORD-PROCESSING			This field is a description of the bulletin, for documentation purposes. It is not used by MailMan for any automatic processing.
10	message	1;0	WORD-PROCESSING			This holds the "canned" text of the bulletin which will be sent when the bulletin is fired. Variable text may be stored in parameters at the time of firing, then inserted in the message text. Parameter windows are defined by putting them within vertical bars, with the parameter number inside. For example, "Appointment for |1| on |2| has been cancelled." with parameter 1 set to "Jones", and parameter 2 set to "Monday" would generate a bulletin of "Appointment for Jones on Monday has been cancelled." Parameters may be set with fileman (in the Bulletin cross reference) or by programmers from within programs.
11	parameter	4;0	MULTIPLE	3.64		This defines the parameters, which will be used to set information into the bulletin.
12	priority?	0;4	BOOLEAN	0:NO 1:YES		If you want this bulletin to appear to the recipients as a priority message, enter 'yes'; if not, enter 'no'.