RTVSMTPA RETRIEVE SMTP ATTRIBUTES TAATCPH |
The Retrieve SMTP Attributes command retrieves information based on a
user ID about SMTP (Simple Mail Transfer Protocol). The QATMSMTPA
file in QSYS is used. RTVSMTPA may only be used in a CL program.
RTVSMTPA2 is a similar command that requires both a user ID and
Address.
A typical series of commands for RTVSMTPA would be:
DCL &SMTPUID *CHAR LEN(24)
.
RTVSMTPA USERID(xxx) SMTPUID(&SMTPUID)
The SMTP user ID would be retrieve for the user.
RTVSMTPA escape messages you can monitor for
--------------------------------------------
TAA9896 The user ID does not exist.
Escape messages from based on functions will be re-sent.
RTVSMTPA Command parameters *CMD
---------------------------
USERID The name of the user to retrieve information for.
ADDRESS The second part of the 2 part name by which the user
is known. This is an optional return variable that
if used must be specified as *CHAR LEN(8).
SMTPUID The SMTP user ID. This field will be blank if a
Route is specified. This is an optional return
variable that if used must be specified as *CHAR
LEN(24).
SMTPFLAG The SMTP flag. The value in this field describes
whether the DOMROUTE field contains a domain or a
route. The values are D=Domain and R=Route. This
is an optional return variable that if used must be
specified as *CHAR LEN(1).
DOMROUTE The Domain or Route. The value in this field is
either a domain or a route based on the value in the
SMTPFLAG field. This is an optional return variable
that if used must be specified as *CHAR LEN(240).
RTVSMTPA2 Command parameters *CMD
----------------------------
USERID A two part address of the user.
The first part is the user to retrieve information
for.
The second part is the address by which the user is
known.
SMTPUID The SMTP user ID. This field will be blank if a
Route is specified. This is an optional return
variable that if used must be specified as *CHAR
LEN(24).
SMTPFLAG The SMTP flag. The value in this field describes
whether the DOMROUTE field contains a domain or a
route. The values are D=Domain and R=Route. This
is an optional return variable that if used must be
specified as *CHAR LEN(1).
DOMROUTE The Domain or Route. The value in this field is
either a domain or a route based on the value in the
SMTPFLAG field. This is an optional return variable
that if used must be specified as *CHAR LEN(240).
Restrictions
------------
Because the command returns variables, it may only be used in a CL
program.
Prerequisites
-------------
The following TAA Tools must be on your system:
SNDESCINF Send escape information
SNDESCMSG Send escape message
Implementation
--------------
None, the tool is ready to use.
Objects used by the tool
------------------------
Object Type Attribute Src member Src file
------ ---- --------- ---------- ----------
RTVSMTPA *CMD TAATCPH QATTCMD
RTVSMTPA2 *CMD TAATCPH2 QATTCMD
TAATCPHC *PGM CLP TAATCPHC QATTCL
TAATCPHC2 *PGM CLP TAATCPHC2 QATTCL
|
Added to TAA Productivity tools February 1, 2005