Remove Mail Server Framework Configuration (QzmfRmvMailCfg) API


  Required Parameter Group:

1 Type configuration Input Char(*)
2 Format name Input Char(8)
3 Error code I/O CHAR(*)

  Service Program: QZMFASRV

  Threadsafe: No

The Remove Mail Server Framework Configuration (QzmfRmvMailCfg) API deletes a configuration from the mail server framework.


Authorities and Locks

None.


Required Parameter Group

Type configuration
INPUT; CHAR(*)

A structure containing the information used for the mail server framework configuration being removed.

Format name
INPUT; CHAR(8)

The format identifier of the parameter structure for the type configuration being used. This must be set to DLTC0100.

Error code
I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error code parameter. If this parameter is omitted, diagnostic and escape messages are issued to the application.


DLTC0100 Format

The following table shows the layout of the parameter structure for DLTC0100. For a detailed description of each field, see Field Descriptions.

Offset Type Field
Dec Hex
0 0 BIN(4) Length of structure
4 4 CHAR(2) Type group
6 6 CHAR(4) Type value
10 A CHAR(8) Type name


Field Descriptions

Length of structure. The length in bytes of the parameter list format for the remove mail server framework configuration.

Type group. The type of the configuration being removed. This is a 2-character field representing the type group that is being configured. This field must be set to one of the allowed values. The allowed values are:

01 Address type group
02 Message type group
03 Envelope type group
04 Attachment type group

If the field is not set to an allowed value, the error message CPFAFB0 is generated.

Type name. The name of the type configuration being removed. This is an 8-character mnemonic representation of the type. This field must not be set to blanks. Allowed character values are A through Z and 0 through 9. If this field is blank, then error message CPFAFB0 is generated.

Type value. The value of the type configuration being removed. This is a 4-character representation of the type being removed. Allowed character values are A through Z and 0 through 9.


Error Messages

Message ID Error Message Text
CPF24B4 E Severe error while addressing parameter list.
CPF3CF1 E Error code parameter not valid.
CPF3CF2 E Error(s) occurred during running of &1 API.
CPF3C36 E Number of parameters, &1, entered for this API was not valid.
CPF3C90 E Literal value cannot be changed.
CPF9872 E Program or service program &1 in library &2 ended. Reason code &3.
CPFAFB0 E Mail server framework configuration API error occurred.
CPFAFB1 E Mail server framework type &1 not configured.


API introduced: V3R1

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