| 1 | Qualified user space name | Input | Char(20) |
| 2 | Format name | Input | Char(8) |
| 3 | Type configuration format name | Input | Char(8) |
| 4 | Type configuration | Input | Char(*) |
| 5 | Error code | I/O | Char(*) |
The List Mail Server Framework Configuration (QzmfLstMailCfg) API generates a list of type configurations and places the list in a specified user space. You may specify a specific group of type configurations, a specific configuration or all configurations. The generated list replaces any existing data in the user space.
The qualified user space name identifies the space that is to receive the created list. The first 10 characters contain the user space name, and the second 10 characters contain the name of the library where the user space is located. You can use these special values for the library name:
| *CURLIB | The job's current library |
| *LIBL | The library list |
The variable containing the name of the list format identifier. This must be set to LSTL0100. If the list format identifier is not LSTL0100, then the error message CPFAFB0 is generated.
The format identifier of the parameter structure for the type configuration to be used. This must be set to LSTC0100. If the format identifier is not set to LSTC0100, the CPFAFB0 error message is generated.
This is a structure containing the information that will be used for the mail server framework configuration being listed.
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.
The following table shows the layout of the parameter structure for LSTL0100. The framework configuration list consists of:
For detailed descriptions of the fields in the list returned, see Field Descriptions.
When you retrieve list entry information from a user space, you must use the entry size returned in the generic header. The size of each entry may be padded at the end. If you do not use the entry size, the result may not be valid.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(2) | Type group |
| 2 | 2 | CHAR(4) | Type value |
| 6 | 6 | CHAR(8) | Type name |
| 14 | E | CHAR(2) | Reserved |
| 16 | 10 | BINARY(4) | Type text coded character set identifier (CCSID) |
| 20 | 14 | CHAR(100) | Type text |
The following table shows the LSTC0100 format used to select the configurations to be listed. It can be used to selectively retrieve configuration entries. If the data entered in any of the fields is not valid, error message CPFAFB0 is generated. If no matching entries are found, not valid, error message CPFAFB1 is generated.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Length of structure |
| 4 | 4 | CHAR(2) | Selection type group |
| 6 | 6 | CHAR(4) | Selection type value |
| 10 | A | CHAR(8) | Selection type name |
Length of structure. The length in bytes of the LSTL0100 format for list mail configuration selection.
Reserved. A reserved field must be set to blanks.
Selection type group. The requested type group to list. The possible values for the selection type group field are:
| 01 | Address type group |
| 02 | Message type group |
| 03 | Envelope type group |
| 04 | Attachment type group |
| blank | List configurations that match the other selection criteria without using the selection type group as a selection criteria. |
Selection type name. The name of the configuration to list. If the selection type name is set to blank, other selection criteria are used without using the selection type name as a selection criteria.
Selection type value. The value of the configuration to list. If the type value is set to blank, other selection criteria are used without using the selection type name as a selection criteria.
Type group. The type group of the entry that matched the selection criteria. The possible values for the type group field are:
| 01 | Address type group |
| 02 | Message type group |
| 03 | Envelope type group |
| 04 | Attachment type group |
Type name. The name of the type that matched the selection criteria. This is an 8-character mnemonic representation of the type. This value is made up of the characters A through Z and 0 through 9.
Type text. The description of the type that matched the selection criteria.
Type text coded character set identifier (CCSID). The coded character set identifier (CCSID) for the type text field.
Type value. The value of the type that matched the selection criteria. This is a 4-character representation of the type. This value is made up of the characters A through Z and 0 through 9.
| Message ID | Error Message Text |
|---|---|
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3C21 E | Format name &1 is 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. |
[ Back to top | Office APIs | APIs by category ]