Print Page as PDF
DELETE/SAVE MESSAGE API ICR (10065)

DELETE/SAVE MESSAGE API    ICR (10065)

Name Value
NUMBER 10065
IA # 10065
DATE CREATED 1995/01/31
CUSTODIAL PACKAGE MAILMAN
CUSTODIAL ISC San Francisco
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE XMA1B
NAME DELETE/SAVE MESSAGE API
ORIGINAL NUMBER 10065
GENERAL DESCRIPTION
These APIs let you delete a message from a basket
and/or save it to a basket:
- KL^XMA1B   delete a message from a basket (presumes S2 used later)
- KLQ^XMA1B  delete a message from a basket and put it in .5=WASTE
- S2^XMA1B   save a message to a basket
STATUS Active
ID XMA1B
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
KLQ
Delete a message from a basket and put it in the
WASTE basket.  If the basket we're deleting from is the WASTE basket, just
delete it.

This call uses KL^XMA1B to delete the message.  See its writeup in this DBIA
for more information.

Compare to DELMSG^XMXAPI (DBIA 2729).

Usage: S XMDUZ=user's DUZ
S XMK=basket IEN
S XMZ=message IEN
D KLQ^XMA1B
VARIABLES TYPE VARIABLES DESCRIPTION
XMDUZ Input
The DUZ of the user from whose basket the message is
to be deleted.
XMK Used
(optional) IEN of the basket from which the message
is to be deleted.  See the writeup for XMK in entry KL^XMA1B in this DBIA for
more information.
XMZ Input
Message IEN in the Message file of the message to be
deleted.
S2
Save a message into a basket.  If the message is
currently in a different basket, you should first delete it from that basket
(using KL^XMA1B), otherwise you'll end up with the same message in more than
one basket.

Compare to MOVEMSG^XMXAPI (DBIA 2729).

XMKM is killed upon exit.

Usage: S XMDUZ=user's DUZ
S XMKM=basket IEN to save to
S XMZ=message IEN
D S2^XMA1B
VARIABLES TYPE VARIABLES DESCRIPTION
XMDUZ Input
DUZ of the user into whose basket the message is to
be saved.
XMKM Input
IEN of the user's basket into which the message is to
be saved.
XMZ Input
Message IEN in the Message file of the message to be
saved.
KL
Delete a message from a basket.  The message is not
put in the WASTE basket.

If the message is in the specified basket, delete it from there.

Otherwise, delete the message from the first mail basket in which found.

If the message is not found in any basket, quit.

Usage: S XMDUZ=user's DUZ
S XMK=basket IEN
S XMZ=message IEN
D KL^XMA1B
VARIABLES TYPE VARIABLES DESCRIPTION
XMDUZ Input
DUZ of the user from whose basket the message is to
be deleted.
XMK Used
(optional) IEN of the basket in the user's mailbox
from which the message is to be deleted.

If XMK is not supplied, MailMan finds out which basket the message is in.

If XMK is supplied, MailMan checks to make sure that the message is in that
basket, and, if not, finds out which basket the message is in.
XMZ Input
Message IEN in the Message file of the message to be
deleted.