Print Page as PDF
REPLY TO / ANSWER A MESSAGE API ICR (1145)

REPLY TO / ANSWER A MESSAGE API    ICR (1145)

Name Value
NUMBER 1145
IA # 1145
DATE CREATED 1995/02/20
CUSTODIAL PACKAGE MAILMAN
CUSTODIAL ISC San Francisco
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE XMA2R
NAME REPLY TO / ANSWER A MESSAGE API
GENERAL DESCRIPTION 
The APIs (functions) in this DBIA send non-interactive
replies and answers.

$$ENT^XMA2R - Send a reply to a message.  Add a response to the response chain
of original message.

$$ENTA^XMA2R - Send an answer to a message.  Create a new message (rather than
adding a response to the response chain of original message).
STATUS Active
ID XMA2R
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$ENT 
Send a reply to a message.  Add a response to the
response chain of original message, so that all local recipients of the
message get the reply.  If the message is from a remote site, you can indicate
(with XMNET), whether the reply should be send to the author of the message,
too.  This function is non-interactive.

Compare to REPLYMSG^XMXAPI (DBIA 2729).

Usage:  S variable=$$ENT^XMA2R(XMZ,XMSUBJ,.XMTEXT,XMSTRIP,XMDUZ,XMNET)

If successful, function returns:
Message IEN in file 3.9 of the reply.

If failure, function returns:
The letter "E", followed by a number, followed by an error message.
e.g. "E3 Subject too long or short !"

Examples:

W $$ENT^XMA2R(51537,"test of XMA2R",.T,"",DUZ)
E2 No message text !

S T(1)="test line 1"
S X=$$ENT^XMA2R(51537,"test of XMA2R",.T,"",DUZ) W X
51541
VARIABLES TYPE VARIABLES DESCRIPTION
XMZ Input 
Message IEN in the MESSAGE FILE (#3.9) of the message
being replied to.
XMSUBJ Input 
Subject of the reply.  Must be 3-65 characters.
XMTEXT Input 
Text of the reply.  Must be an array, passed by
reference, and in a format acceptable as input to FileMan word-processing
fields.
XMSTRIP Input 
(optional) String containing characters to be
stripped from the text of the reply (XMTEXT).  Default is none.
XMDUZ Used 
(optional) The DUZ of the user sending the answer.
May also be free text.  Default is DUZ.
XMNET Used 
(optional) If the sender of the original message is
at a remote site, should the reply be sent to the sender, too?  Possible
values:
0=no (default)
1=yes

This parameter is ignored if the message is from a local user.
$$ENTA 
Send an answer to a message.  Create a new message
containing the response and send it only to the author of the original
message.  This function is non-interactive.

Compare to ANSRMSG^XMXAPI (DBIA 2729).

Usage:  S variable=$$ENTA^XMA2R(XMZ,XMSUBJ,.XMTEXT,XMSTRIP,XMDUZ)

If successful, function returns:
Message IEN in file 3.9 of the answer.

If failure, function returns:
The letter "E", followed by a number, followed by an error message.
e.g. "E1 No subject !"
VARIABLES TYPE VARIABLES DESCRIPTION
XMZ Input 
Message IEN in the MESSAGE FILE (#3.9) of the message
being answered.
XMSUBJ Input 
Subject of the answer.  Must be 3-65 characters.
XMTEXT Input 
Text of the answer.  Must be an array, passed by
reference, and in a format acceptable as input to FileMan word-processing
fields.
XMSTRIP Used 
(optional) String containing characters to be
stripped from the text of the answer (XMTEXT).  Default is none.
XMDUZ Used 
(optional) The DUZ of the user sending the answer.
It may also be free text.  Default is DUZ.