Print Page as PDF
MESSAGE HEADER API ICR (1143)

MESSAGE HEADER API    ICR (1143)

Name Value
NUMBER 1143
IA # 1143
DATE CREATED 1995/02/20
CUSTODIAL PACKAGE MAILMAN
CUSTODIAL ISC San Francisco
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE XMRENT
NAME MESSAGE HEADER API
GENERAL DESCRIPTION
This API contains the following function:

$$NET^XMRENT - Get message header information
STATUS Active
ID XMRENT
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$NET
This extrinsic function is used for getting message
information.

Given a message number, it returns an "^"-delimited string containing message
header information.  If there is no such message, it returns the null string.

Compare to $$HDR^XMGAPI2 (DBIA 1144), and INMSG^XMXUTIL2 and other ^XMXUTIL2
APIs (DBIA 2736).

Usage: S X=$$NET^XMRENT(XMZ)

Returns:
If the message is NOT defined, the null string.
If the message is defined, a string with the following pieces, separated by
"^":

Piece   Contents
1      Origination date.  If remote, as sent.
If local, in format MAY 25, 1999@08:16:00
2      Scramble hint, if any; otherwise null
3      From (external)
4      Message ID at originating site (XMZ@site, if local)
5      Message sender, usually surrogate (external); otherwise null
6      Subject
7      Message ID of original message, if this is a reply
(XMZ@site, if local); otherwise null
8      Message type (piece 7 of message's zero node)

Examples:

W $$NET^XMRENT(51537)

date@time^HINT^From^10576@MAILSYS^SurrogateDUZ^Subject^4321@site^Type
1      2    3          4           5          6        7      8
VARIABLES TYPE VARIABLES DESCRIPTION
XMZ Input
Message IEN in the MESSAGE file (3.9).

MAIL MESSAGE 14000218
Generated from AUG 12, 2020@ IA Listing Descriptions