| 1 | Type configuration | Input | Char(*) |
| 2 | Format name | Input | Char(8) |
| 3 | Error code | I/O | CHAR(*) |
The Add Mail Server Framework Configuration (QzmfAddMailCfg) API generates a configuration for the mail server framework used in validating the information in a message.
None.
The structure containing the information used for the mail server framework type being configured.
The format of the type configuration parameter being used as input. This must be set to ADDC0100.
The structure in which to return error information. For the format of the structure, see Error Code Parameter.
The following table shows the layout of the parameter structure for ADDC0100. For a detailed description of each field, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Length of structure |
| 4 | 4 | CHAR(2) | Type group |
| 6 | 6 | CHAR(4) | Type value |
| 10 | A | CHAR(8) | Type name |
| 18 | 12 | CHAR(2) | Reserved (must be blank) |
| 20 | 14 | BINARY(4) | Type text coded character set identifier (CCSID) |
| 24 | 18 | CHAR(100) | Type text |
Length of structure. The length in bytes of the add mail configuration parameter list.
Reserved. This is a reserved field that must be set to blank.
Type group. The type group being configured. This is a 2-character field representing the type group being configured. This field must be set to one of the following values:
| 01 | Address type group |
| 02 | Message type group |
| 03 | Envelope type group |
| 04 | Attachment type group |
There is a maximum of 128 different type value entries in each type group. If an attempt is made to configure more than 128 type values in a type group, error message CPFAFB2 is generated.
Type name. The name of the type being configured. This is an 8-character mnemonic representation of the type. This must be a unique type name. Allowed character values are A through Z and 0 through 9. This field must not be set to blanks. If this field is blank, error message CPFAFB0 is generated. This value may be used for messages when referring to the type.
Type text. The description of the type being configured. If this field is not used, it is set to blanks.
Type text coded character set identifier (CCSID). The coded character set identifier (CCSID) of the type text field. Valid CCSID values for this field are 1 through 65533 and 65535. If this field is set to zero, then the job CCSID is used.
Type value. The value of the type being configured. This is a unique 4-character representation of the type being configured. Allowed character values are A through Z and 0 through 9. It is used in the registration of exit point programs for the mail server framework exit points. The type value is used in the program data fields to indicate whether a program should be called when the mail server framework is processing a specific type of message. The following type values are reserved:
| 0xxx-1xxx | Reserved for use by IBM. |
| 9998 | Reserved for use as the nondelivery message type. |
| 9999 | Reserved for use in specifying that a program is configured to process all types. |
| 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. |
| CPFAFB2 E | Maximum types for type group &1 already exists. |
| Top | Office APIs | APIs by category |