Print Page as PDF
MESSAGE INFORMATION API ICR (2736)

MESSAGE INFORMATION API    ICR (2736)

Name Value
NUMBER 2736
IA # 2736
DATE CREATED 1999/01/27
CUSTODIAL PACKAGE MAILMAN
CUSTODIAL ISC San Francisco
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE XMXUTIL2
NAME MESSAGE INFORMATION API
GENERAL DESCRIPTION
These APIs return all kinds of information about a
message.
- Information that can be displayed.
- Information that can be used to determine what may (and may not) be done
with the message.

Please see the Programmer Manual on the Infrastructure web site for further
information about the APIs and how to use them.
STATUS Active
ID XMXUTIL2
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION
$$BSKT
Returns which basket a message is in for a user.
$$DATE
Returns the message sent date.
$$FROM
Returns the message From information.
$$KSEQN
Returns the sequence number fo a message in this
user's basket.
$$LINE
Returns the number of lines in the text of a message.

$$NEW
Returns a value indicating whether or not a message
is new for this user in this basket.
$$PRI
Returns a value indicating whether the message is
priority or not.
$$QRESP
Determines whether a message is a response or not,
and, optionally, if it is, which response to which message.
$$RESP
Returns the number of responses to a message.
$$SUBJ
Returns the message subject.
$$ZDATE
Returns the message sent date.
$$ZFROM
Returns the message From.
$$ZNODE
Returns the message zero node.
$$ZPRI
Returns a value indicating whether the message is
priority or not.
$$ZREAD
Returns the number of responses to a message this
user has read.
$$ZSUBJ
Returns the message subject.
INMSG
Sets arrays with message information.
INMSG1
Sets arrays with message information, part 1.
INMSG2
Sets arrays with message information, part 2.
INRESP
Sets an array with response information.
INRESPS
Sets arrays indicating how many responses a message
has, and how many of them the user has read.