The following table lists variables that can be either modified or read in the TPXUMAIL exit. The table indicates whether the variable is a table variable, which can only be accessed with the appropriate macro, the call points that can access the variable, and whether the call point can modify the variable or read it.
|
Variable |
Properties |
Call Points |
Description |
|---|---|---|---|
|
MACK |
Table, bit |
Modified in 8,12. |
Indicates that an acknowledgment will be sent to the sender when the recipient opens this message. |
|
MBREAKIN |
Table, bit |
Modified in 4,12. |
Indicates that this message will break into this recipient's session when it is received. |
|
MCOMMENT |
Table, character |
Modified in 32. |
Commented information for an entry in a list that is about to be added, updated or deleted. The ENTRY= parameter is required. |
|
MCONFIRM |
Bit |
Modified in 0. Read in 4, 8, 12. |
Indicates that a confirmation panel will be displayed before the message is sent or stored to this recipient. |
|
MLSTADD |
Bit |
Modified in 32. |
Indicates that the list is being added. |
|
MLSTDEL |
Bit |
Modified in 32. |
Indicates that the list is being deleted. |
|
MLSTDUPD |
8 Character |
Read in 32. |
Specifies the last add or update for this list. |
|
MLSTID |
8 Character |
Read in 32. |
Specifies the ID of the user list. |
|
MLSTITLE |
Character |
Read in 32. |
The title of the list that is about to be added, deleted, or updated. |
|
MLSTLIST |
Character |
Modified in 32. |
The contents of the list that is about to be added, deleted, or updated. The list is in null delimited form with X'FF' field separators. |
|
MLSTLUPD |
8 Character |
Read in 32. |
User ID of user who performed the last add or update for this list. |
|
MLSTOWN |
8 Character |
Modified in 32. |
User ID of the owner of this list. |
|
MLSTPUBL |
Bit |
Modified in 32. |
Indicates whether this is a public list. |
|
MLSTTTAR |
Character |
Modified in 32. |
Specifies the type of target for this message: user, userlist, terminal, appl, actappl, sess, actsess, or GROUP. |
|
MLSTTUPD |
8 Character |
Modified in 32. |
Specifies the time of the last update of this list. |
|
MLSTUPD |
Bit |
Modified in 32. |
Indicates that this list is being updated. This bit is ignored if MLSTADD or MLSTDEL are set to Y. |
|
MLSTVISI |
Bit |
Modified in 32. |
Indicates that other users can browse the contents of this list. |
|
MLOCACK |
Bit |
Read in 24, 28. |
Indicates that an acknowledgment message will be sent to the sender when the message is opened. |
|
MLOCBRKN |
Bit |
Read in 24, 28. |
Indicates that the message was sent with the break in option activated. |
|
MLOCDATE |
8 Character |
Read in 24, 28. |
The date that the message was sent in the format mm/dd/yy. |
|
MLOCDATF |
8 Character |
Read in 24, 28. |
The date that the message was sent in the format dd/mm/yy. |
|
MLOCDATL |
8 Character |
Read in 24, 28. |
The date that the message was sent in the format mm/dd/yyyy. |
|
MLOCDATQ |
8 Character |
Read in 24, 28. |
The date that the message was sent in the format dd/mm/yyyy. |
|
MLOCEXPD |
Character |
Modified in 24, 28. |
The date that the message expires, in the format mm/dd/yy. |
|
MLOCEXPF |
Character |
Modified in 24, 28. |
The date that the message expires, in the format dd/mm/yy. |
|
MLOCEXPL |
Character |
Modified in 24, 28. |
The date that the message expires, in the format mm/dd/yyyy. |
|
MLOCEXPQ |
Character |
Modified in 24, 28. |
The date that the message expires, in the format dd/mm/yyyy. |
|
MLOCFRM1 |
8 Character |
Read in 24, 28. |
Specifies the user ID of the message sender, or indicates that the message is a bulletin. |
|
MLOCFROM |
8 Character |
Read in 24, 28. |
Indicates the user ID of the sender of the message. |
|
MLOCHBAK |
Bit |
Read in 24, 28. |
Indicates that an acknowledgment for this message has been received. |
|
MLOCISAK |
Bit |
Read in 24, 28. |
Indicates that this message is an acknowledgment message. |
|
MLOCOSCD |
Bit |
Read in 24, 28. |
Indicates that only the sender can delete this message. |
|
MLOCREAD |
Bit |
Read in 24, 28. |
Indicates that this message has been opened by the recipient. |
|
MLOCRETP |
Character |
Read in 24, 28. |
Specifies the number of days until this message expires. |
|
MLOCSEND |
Bit |
Read in 24, 28. |
Indicates that this message was sent to the recipient. |
|
MLOCSTOR |
Bit |
Read in 24, 28. |
Indicates that this message was stored to the recipient's mailbox. |
|
MLOCTARG |
Character |
Read in 24, 28. |
Specifies the ID of the target for this message. Can be a list ID, user ID, terminal ID, application ID, session ID, active application ID, or active session ID. |
|
MLOCTIME |
8 Character |
Read in 24, 28. |
Specifies the time that the message was sent. |
|
MLOCTO |
8 Character |
Read in 24, 28. |
Specifies the original sender of the message that is being acknowledged. |
|
MMSG$FRM |
Character |
Read in 0, 4, 8, 12, 24, 28. |
Specifies the real name of the sender of this message, or, if the name is unavailable and user Ids can be displayed, the user ID. |
|
MMSGACK |
Bit |
Modified in 0. Read in 4, 8, 12, 24, 28. |
Indicates that an acknowledgment message will be sent when the recipient opens this message. |
|
MMSGBRKN |
Bit |
Modified in 0. Read in 4, 8, 12, 24, 28. |
Indicates that the message will break into this recipient's session when it is received. |
|
MMSGEXPD |
8 Character |
Modified in 0. Read in 4, 8, 12, 24, 28. |
The date that the message expires, in the format mm/dd/yy. |
|
MMSGEXPF |
8 Character |
Modified in 0. Read in 4, 8, 12, 24, 28. |
The date that the message expires, in the format dd/mm/yy. |
|
MMSGEXPL |
8 Character |
Modified in 0. Read in 4, 8, 12, 24, 28. |
The date that the message expires, in the format mm/dd/yyyy. |
|
MMSGEXPQ |
8 Character |
Modified in 0. Read in 4, 8, 12, 24, 28. |
The date that the message expires, in the format dd/mm/yyyy. |
|
MMSGOSCD |
Bit |
Modified in 0. Read in 4, 8, 12, 24, 28. |
Indicates that only the sender can delete this message. |
|
MMSGO2M |
Bit |
Modified in 0. Read in 4, 8, 12, 24, 28. |
Indicates that this message was produced by the operator facility, a /B command, or by the CA TPX View facility. |
|
MMSGSEND |
Bit |
Modified in 0. Read in 4, 8, 12, 24, 28. |
Indicates that this message was sent to the recipient. |
|
MMSGSTOR |
Bit |
Modified in 0. Read in 4, 8, 12, 24, 28. |
Indicates that this message was stored to the recipient's mailbox. |
|
MMSGSUBJ |
Character |
Read in 4, 8, 12, 24, 28. |
Specifies the subject of the message. |
|
MMSGSYID |
4 Character |
Read in 0, 4, 8, 12, 24, 28. |
Specifies the system ID of the sender of the message. |
|
MMSGTEXT |
Table, Character |
Read in 4, 8, 12, 24, 28. |
Specifies the text of the message. |
|
MMSGTTAR |
13 Character |
Read in 0, 4, 8, 12, 24, 28. |
Specifies the type of target for this message: user, userlist, terminal, appl, actappl, sess, actsess, or GROUP. Do not change. |
|
MODE2 |
1 Character |
Read in 32. |
Indicates whether the user list is being edited or browsed. A value of E indicates edited and a value of B indicates browsed. |
|
MSEND |
Table, Bit |
Modified in 12. Read in 4. |
Indicates that the message will be sent to the user. |
|
MSTORE |
Table, Bit |
Modified in 12. Read in 8. |
Indicates that the message will be stored in the user's mailbox. |
|
MSUBJECT |
70 Character |
Modified in 0. |
Specifies the subject or first line of the message. |
|
MTARGET |
8 Character |
Read in 0. |
The recipient of the message. Masking characters appear as x'FE'. If the recipient is a user list, this variable specifies the list ID.If the message is a bulletin, this variable contains spaces. |
|
MTARGET |
Table ENTRY, Character |
Modified in 32. |
An entry in a list that is about to be added, updated, or deleted. The ENTRY= parameter is required on the TMVINIT, TMVTGET, or TMVTPUT macros when accessing this variable.' |
|
MTITLE |
Character |
Modified in 32. |
Indicates the title of the list that is about to be added, updated, or deleted. |
|
MTARGET2 |
9 Character |
Read in 0. |
Specifies the owner of the list (or *GENERAL*). This variable is only valid if MMSGTTAR is USERLISTS and MTARGET is not ?. |
|
MTEXT |
Table ENTRY, 79 Character |
Modified in 0. |
Specifies one line of message text. |
|
NSTNAME |
Table, 25 Character |
Read in 4, 8, 12. |
Specifies the name of the recipient. The value can be "UNKNOWN USER." |
|
NSTTERM |
Table, 8 Character |
Read in 4, 8, 12. |
Specifies the terminal ID of the recipient of this message. This variable is valid only if parameter +8 is not zero. |
|
NSTUSER |
Table, 8 Character |
Read in 4, 8, 12. |
Specifies the user ID of the recipient of this message. This variable is used only if parameter +8 is zero. |
|
TEXT1 |
40 Character |
All |
Specifies the first line of text to be used on the message produced when the TPXUMAIL exit returns a return code of eight (8). |
|
TEXT2 |
40 Character |
All |
Specifies the second line of text to be used on the message produced when the TPXUMAIL exit returns a return code of eight (8). |
|
TYPE1 |
1 Character |
Read in 32. |
Specifies the type of user list: N indicates a general list P indicates a personal list G indicates a group list. |
|
ZCRP |
4 digit Binary |
|
Controls which line of text or userlist entry can be accessed. |
|
Copyright © 2013 CA.
All rights reserved.
|
|