Query Mail Message Identifier (QzmfQryMailMsgId) API
Required Parameter Group:
| 1 | Mail message identifier | Input | Char(32) |
| 2 | Format name | Input | Char(8) |
| 3 | Status | Output | Char(1) |
| 4 | Error code | I/O | Char(*) |
Service Program: QZMFASRV
Threadsafe: No
The Query Mail Message Identifier (QzmfQryMailMsgId) API is used to discover if a mail message identifier is known to the mail server framework.
Authorities and Locks
None.
Required Parameter Group
- Mail message identifier
- INPUT; CHAR(32)
The variable containing the unique message identifier that is being queried as to whether it is known by the mail server framework. The message identifier is composed of characters A through Z and 0 through 9 only.
- Format name
- INPUT; CHAR(8)
The variable containing the format identifier of the parameter list that is passed. This field must be set to QRYF0100.
- Status
- OUTPUT CHAR(1)
This field contains one of the following:
0 The mail message identifier is not known by the mail server framework. The message associated with this mail message may have already been processed. 1 The mail message identifier is known by the mail server framework. This status indicates that the mail message identifier was created using the Create Mail Message (QzmfCrtMailMsg) API. The message is either being processed, or is waiting to be processed, by the mail server framework. 2 The mail message identifier was reserved using the Reserve Mail Message Identifier (QzmfRsvMailMsgId) API. It was also created using the Create Mail Message (QzmfCrtMailMsg) API. The message still exists in the mail server framework and is either being processed, or is waiting to be processed, by the mail server framework. 3 The mail message identifier was reserved using the Reserve Mail Message Identifier (QzmfRsvMailMsgId) API. It was also created using the Create Mail Message (QzmfCrtMailMsg) API. The message no longer exists in the mail server framework. The message associated with this mail server identifier has already been processed by the mail server framework. However, the Creation Sequence Complete (QzmfCrtCmpMailMsg) API has not been called to remove the message identifier from the mail server framework. 4 The mail message identifier was reserved using the Reserve Mail Message Identifier (QzmfRsvMailMsgId) API. However, the Create Mail Message (QzmfCrtMailMsg) API has not been used to create a message using this mail message identifier. - Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
| CPFAF82 E | Error occurred during running of MSF API. |
| CPFAF83 E | Parameter error on call to MSF API. Reason code &1. |
| CPFAF84 E | MSF API failed. MSF message identifier not found. |
API introduced: V3R1
[ Back to top | Office APIs | APIs by category ]