Print Page as PDF
MESSAGE & MAILBOX UTILITIES API ICR (2734)

MESSAGE & MAILBOX UTILITIES API    ICR (2734)

Name Value
NUMBER 2734
IA # 2734
DATE CREATED 1999/01/27
CUSTODIAL PACKAGE MAILMAN
CUSTODIAL ISC San Francisco
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE XMXUTIL
NAME MESSAGE & MAILBOX UTILITIES API
GENERAL DESCRIPTION
These APIs are general message and mailbox utilities.

Please see the Programmer Manual on the Infrastructure web site for further
information about the APIs and how to use them.
STATUS Active
ID XMXUTIL
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION
$$BMSGCT
Returns the number of messages in a user's basket.
$$BNMSGCT
Returns the number of new messages in a user's
basket.
$$BSKTNAME
Returns the name of a user's basket.
$$NAME
Returns the name of the user (and, optionally, title
and institution).
$$NETNAME
Returns the network name of the user, including @site
name.
$$NEWS
Returns information about the new messages in a
user's mailbox.
$$TMSGCT
Returns the total number of messages in a user's
mailbox.
$$TNMSGCT
Returns the total number of new messages in a user's
mailbox.
$$KVAPOR
Sets/Removes a message vaporize date on a message in
a user's basket.
LASTACC
Records that the user has read the message.
MAKENEW
Makes a message new and updates the new message
counts.
NONEW
Makes a message not new and updates the new message
counts.
PAGE
Displays to the user: "Enter RETURN to continue or ^
to exit:" and waits until the user presses a key.
WAIT
Displays to the user: "Press RETURN to continue:" and
waits until the user presses a key.
$$BPMSGCT
Returns the number of new priority messages in a
user's basket.
$$TPMSGCT
Returns the total number of new priority messages in
a user's mailbox.