| $$MG |
Create a mail group or add local members to an
existing mail group.
If the mail group does not exist, it will be created. Local members may be
added. There is no way to add other kinds of members. XMTYPE, XMORG, XMSELF,
and XMDESC are accepted.
If the mail group exists, local members must be added to it. No other changes
can be made. XMTYPE, XMORG, XMSELF, and XMDESC are ignored.
There is no MailMan API to change any other mail group fields.
Usage: S X=$$MG^XMBGRP(XMGROUP,XMTYPE,XMORG,XMSELF,.XMY,.XMDESC,XMQUIET)
This function returns the mail group IEN if successful; 0 if not.
Parameters:
XMGROUP mail group IEN or name
XMTYPE mail group type (public or private)
XMORG organizer DUZ
XMSELF self enrollment allowed?
.XMY array of local members
.XMDESC array of text for the mail group description
XMQUIET silent flag
|
| VARIABLES |
TYPE |
VARIABLES DESCRIPTION |
XMGROUP |
Input |
Full Mail group name, exactly as it should appear in
the .01 field of the MAIL GROUP file (3.8). Must be 3-30 characters.
|
XMTYPE |
Used |
(optional) Type of mail group. Used only for
creating a mail group, otherwise it's ignored. Possible values are:
0 - public (default)
1 - private
|
XMORG |
Used |
(optional) DUZ of group organizer. Used only for
creating a mail group, otherwise it's ignored. Default is DUZ of the user
performing the API. If XMORG is less than 1, it is set to .5.
|
XMSELF |
Used |
(optional) Allow self enrollment? (0=no; 1=yes) Used
only for creating a mail group, otherwise it's ignored. Default is 1 (yes).
|
XMY |
Used |
(optional for mail group creation; mandatory
otherwise) Array of local members to add to the mail group.
XMY(user duz)=""
Note that only user DUZs are accepted. User names are not. Remote addresses,
or anything else, are not.
XMY is killed upon successful completion of this API.
|
XMDESC |
Used |
(optional) Array of text to put in the description
field of the mail group. Used only for creating a mail group, otherwise it's
ignored. The text array must be in a format acceptable to FileMan
word-processing APIs.
|
XMQUIET |
Used |
(optional) Silent Flag. What should happen if there
are any errors, or if (during mail group creation only) local members were
successfully added to the mail group?
0 - Display it to the user.
1 - Sent it in a message to the Postmaster and the user (DUZ) performing the
API. (Default)
|
|
$$DM |
Delete local members from a mail group. There is no
MailMan API to delete other kinds of members.
Usage: S X=$$DM^XMBGRP(XMGROUP,.XMY,XMQUIET)
This function returns 1 if successful; 0 if not.
Parameters:
XMGROUP mail group IEN or full name
.XMY array of local members to be deleted
XMQUIET silent flag (1=Silent, 0=Interactive)
|
| VARIABLES |
TYPE |
VARIABLES DESCRIPTION |
XMGROUP |
Input |
Mail group IEN in the MAIL GROUP file (3.8), or the
full mail group name, exactly as it appears in the .01 field.
|
XMY |
Input |
Array of local members to delete from the mail group.
XMY(user duz)=""
Note that only user DUZs are accepted. User names are not.
|
XMQUIET |
Used |
(optional) Silent Flag. Possible values:
0 - Any errors are displayed to the user.
1 - Any errors are sent in a message to the Postmaster and the user (DUZ)
performing the API. (Default)
|
|
