289 lines
9.2 KiB
HTML
289 lines
9.2 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
|
|
<title>Add Mail Server Framework Configuration (QzmfAddMailCfg) API</title>
|
|
<!-- Begin Header Records ========================================== -->
|
|
<!-- All rights reserved. Licensed Materials Property of IBM -->
|
|
<!-- US Government Users Restricted Rights -->
|
|
<!-- Use, duplication or disclosure restricted by -->
|
|
<!-- GSA ADP Schedule Contract with IBM Corp. -->
|
|
<!-- NETMG2 SCRIPT A converted by B2H R4.1 (346) (CMS) by HOLTJM at -->
|
|
<!-- RCHVMW2 on 29 Jan 1999 at 10:01:37 -->
|
|
<!--File Edited October 2001 -->
|
|
<!--End Header Records -->
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
|
</head>
|
|
<body>
|
|
<a name="Top_Of_Page"></a>
|
|
<!-- Java sync-link -->
|
|
<script language="Javascript" src ="../rzahg/synch.js" type="text/javascript"></script>
|
|
|
|
<h2>Add Mail Server Framework Configuration (QzmfAddMailCfg) API</h2>
|
|
|
|
<div class="box" style="width: 60%;">
|
|
<br>
|
|
Required Parameter Group:<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
|
|
<table width="100%">
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">1</td>
|
|
<td align="left" valign="top" width="50%">Type configuration</td>
|
|
<td align="left" valign="top" width="20%">Input</td>
|
|
<td align="left" valign="top" width="20%">Char(*)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">2</td>
|
|
<td align="left" valign="top">Format name</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(8)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">3</td>
|
|
<td align="left" valign="top">Error code</td>
|
|
<td align="left" valign="top">I/O</td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
</tr>
|
|
</table>
|
|
<br>
|
|
Service Program: QZMFASRV<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: No<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The Add Mail Server Framework Configuration (QzmfAddMailCfg) API generates a configuration for the mail server framework used in validating the information in a message.</p>
|
|
|
|
<br>
|
|
<!-- Please NOTE: DO NOT DELETE THIS SECTION if this API has no authorities and locks. -->
|
|
<!-- Instead, use the commented out coding below to indicate NONE. -->
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<!-- Use this if there are no authorities and locks. -->
|
|
<p>None.</p>
|
|
|
|
<br>
|
|
<h3>Required Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Type configuration</strong></dt>
|
|
<dd>INPUT; CHAR(*)
|
|
|
|
<p>The structure containing the information used for the mail server framework type being configured.</p></dd>
|
|
|
|
<dt><strong>Format name</strong></dt>
|
|
<dd>INPUT; CHAR(8)
|
|
|
|
<p>The format of the type configuration parameter being used as input. This must be set to ADDC0100.</p></dd>
|
|
|
|
<dt><strong>Error code</strong></dt>
|
|
<dd>I/O; CHAR(*)
|
|
|
|
<p>The structure in which to return error information. For the format of the structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>.</p></dd>
|
|
</dl>
|
|
|
|
<br>
|
|
<h3>ADDC0100 Format</h3>
|
|
|
|
<p>The following table shows the layout of the parameter structure for ADDC0100. For a detailed description of each field, see <a href="#HDRADDFLD">Field Descriptions</a>.</p>
|
|
|
|
<table border width="80%">
|
|
|
|
<tr>
|
|
<th align="CENTER" valign="BOTTOM" colspan="2">Offset</th>
|
|
<th align="LEFT" valign="BOTTOM" rowspan="2">Type</th>
|
|
<th align="LEFT" valign="BOTTOM" rowspan="2">Field</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<th align="center" valign="bottom">Dec</th>
|
|
<th align="center" valign="bottom">Hex</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="left" valign="top" width="20%">BINARY(4)</td>
|
|
<td align="left" valign="top" width="60%">Length of structure</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="CENTER" valign="TOP">4</td>
|
|
<td align="CENTER" valign="TOP">4</td>
|
|
<td align="LEFT" valign="TOP">CHAR(2)</td>
|
|
<td align="LEFT" valign="TOP">Type group</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="CENTER" valign="TOP">6</td>
|
|
<td align="CENTER" valign="TOP">6</td>
|
|
<td align="LEFT" valign="TOP">CHAR(4)</td>
|
|
<td align="LEFT" valign="TOP">Type value</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="CENTER" valign="TOP">10</td>
|
|
<td align="CENTER" valign="TOP">A</td>
|
|
<td align="LEFT" valign="TOP">CHAR(8)</td>
|
|
<td align="LEFT" valign="TOP">Type name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="CENTER" valign="TOP">18</td>
|
|
<td align="CENTER" valign="TOP">12</td>
|
|
<td align="LEFT" valign="TOP">CHAR(2)</td>
|
|
<td align="LEFT" valign="TOP">Reserved (must be blank)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="CENTER" valign="TOP">20</td>
|
|
<td align="CENTER" valign="TOP">14</td>
|
|
<td align="LEFT" valign="TOP">BINARY(4)</td>
|
|
<td align="LEFT" valign="TOP">Type text coded character set identifier (CCSID)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="CENTER" valign="TOP">24</td>
|
|
<td align="CENTER" valign="TOP">18</td>
|
|
<td align="LEFT" valign="TOP">CHAR(100)</td>
|
|
<td align="LEFT" valign="TOP">Type text</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br><br>
|
|
<h3><a name="HDRADDFLD">Field Descriptions</a></h3>
|
|
|
|
<p><strong>Length of structure.</strong> The length in bytes of the add mail configuration parameter list.</p>
|
|
|
|
<p><strong>Reserved.</strong> This is a reserved field that must be set to blank.</p>
|
|
|
|
<p><strong>Type group.</strong> 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:</p>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td valign="top"><em>01</em></td>
|
|
<td valign="top">Address type group</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>02</em></td>
|
|
<td valign="top">Message type group</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>03</em></td>
|
|
<td valign="top">Envelope type group</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>04</em></td>
|
|
<td valign="top">Attachment type group</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>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.</p>
|
|
|
|
<p><strong>Type name.</strong> 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.</p>
|
|
|
|
<p><strong>Type text.</strong> The description of the type being configured. If this field is not used, it is set to blanks.</p>
|
|
|
|
<p><strong>Type text coded character set identifier (CCSID).</strong> 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.</p>
|
|
|
|
<p><strong>Type value.</strong> 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:</p>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td valign="top"><em>0xxx-1xxx</em></td>
|
|
<td valign="top">Reserved for use by IBM.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>9998</em></td>
|
|
<td valign="top">Reserved for use as the nondelivery message type.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>9999</em></td>
|
|
<td valign="top">Reserved for use in specifying that a program is configured to process all types.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br><br>
|
|
<h3>Error Messages</h3>
|
|
|
|
<table width="100%" cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<th align="left" valign="top">Message ID</th>
|
|
<th align="left" valign="top">Error Message Text</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF24B4 E</td>
|
|
<td valign="top">Severe error while addressing parameter list.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3CF1 E</td>
|
|
<td valign="top">Error code parameter not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3CF2 E</td>
|
|
<td valign="top">Error(s) occurred during running of &1 API.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C36 E</td>
|
|
<td valign="top">Number of parameters, &1, entered for this API was not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C90 E</td>
|
|
<td valign="top">Literal value cannot be changed.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9872 E</td>
|
|
<td valign="top">Program or service program &1 in library &2 ended. Reason code &3.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFAFB0 E</td>
|
|
<td valign="top">Mail server framework configuration API error occurred.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFAFB2 E</td>
|
|
<td valign="top">Maximum types for type group &1 already exists.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
|
|
<hr>
|
|
API introduced: V3R1
|
|
|
|
<hr>
|
|
<table cellpadding="2" cellspacing="2" align="center">
|
|
<tr align="center">
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a
|
|
href="off1a.htm">Office APIs</a> | <a href=
|
|
"aplist.htm">APIs by category</a></td>
|
|
</tr>
|
|
</table>
|
|
</body>
|
|
</html>
|