Reserve Mail Message Identifier (QzmfRsvMailMsgId) API


  Required Parameter Group:

1 Reserved mail message identifier Output Char(32)
2 Format name Input Char(8)
3 Error code I/O Char(*)

  Service Program: QZMFASRV

  Threadsafe: No

The Reserve Mail Message Identifier (QzmfRsvMailMsgId) API is used to reserve an identifier for an electronic mail message. After the API completes successfully, a single mail message identifier is returned to the caller.

This reserved mail message identifier can be operated on through the Remove Reserved Mail Message Identifier (QzmfRmvRsvMailMsgId) API, the Creation Sequence Complete (QzmfCrtCmpMailMsg) API, and the Create Mail Message (QzmfCrtMailMsg) API. The normal processing for a reserved mail message identifier involves the following sequence:

  1. The mail message identifier is reserved (using the Reserve Mail Message Identifier (QzmfRsvMailMsgId) API). This means that a message can later be created using this mail message identifier.

  2. The message is created (using the Create Mail Message (QzmfCrtMailMsg) API).

  3. The application confirms that the message was created (using the Creation Sequence Complete (QzmfCrtCmpMailMsg) API).

A reserved mail message identifier can be removed from reserved status using the remove mail message identifier if the message has not been created.


Authorities and Locks

None.


Required Parameter Group

Reserved mail message identifier
OUTPUT; CHAR(32)

The variable containing a unique message identifier. The message identifier is returned by the API after it has completed running. This identifier can be used later by the Create Mail Message (QzmfCrtMailMsg) API to pass information which defines the message. The message identifier is composed of characters A through Z and 0 through 9 only. If an error occurs during processing, a message identifier is not generated.

Format name
INPUT; CHAR(8)

The variable containing the format identifier of the parameter list being passed. This field must be set to RSVF0100.

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.

API introduced: V3R1

[ Back to top | Office APIs | APIs by category ]