405 lines
12 KiB
HTML
405 lines
12 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>List Mail Server Framework Configuration (QzmfLstMailCfg) 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>List Mail Server Framework Configuration (QzmfLstMailCfg) 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%">Qualified user space name</td>
|
|
<td align="left" valign="top" width="20%">Input</td>
|
|
<td align="left" valign="top" width="20%">Char(20)</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">Type configuration 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">4</td>
|
|
<td align="LEFT" valign="TOP">Type configuration</td>
|
|
<td align="LEFT" valign="TOP">Input</td>
|
|
<td align="LEFT" valign="TOP">Char(*)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">5</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 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.</p>
|
|
|
|
<br>
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<dl>
|
|
<dt><em>User Space Authority</em></dt>
|
|
<dd>*CHANGE<br><br></dd>
|
|
|
|
<dt><em>Library Authority</em></dt>
|
|
<dd>*USE<br><br></dd>
|
|
|
|
<dt><em>User Space Lock</em>
|
|
<dd>*EXCLRD</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
<h3>Required Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Qualified user space name</strong></dt>
|
|
<dd>INPUT; CHAR(20)
|
|
|
|
<p>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:</p>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td valign="top"><em>*CURLIB</em></td>
|
|
<td valign="top">The job's current library</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>*LIBL</em></td>
|
|
<td valign="top">The library list</td>
|
|
</tr>
|
|
</table>
|
|
<br></dd>
|
|
|
|
<dt><strong>Format name</strong></dt>
|
|
<dd>INPUT; CHAR(8)
|
|
|
|
<p>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.</p></dd>
|
|
|
|
<dt><strong>Type configuration format name</strong></dt>
|
|
<dd>INPUT; CHAR(8)
|
|
|
|
<p>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.</p></dd>
|
|
|
|
<dt><strong>Type configuration</strong></dt>
|
|
<dd>INPUT; CHAR(*)
|
|
|
|
<p>This is a structure containing the information that will be used for the mail server framework configuration being listed.</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>. If this parameter is omitted, diagnostic and escape messages are issued to the application.</p></dd>
|
|
</dl>
|
|
|
|
<br>
|
|
<h3><a name="HDRGENLIST">Format of the Generated List</a></h3>
|
|
|
|
<p>The following table shows the layout of the parameter structure for LSTL0100. The framework configuration list consists of:</p>
|
|
|
|
<ul>
|
|
<li>A user area<br><br></li>
|
|
<li>A generic header<br><br></li>
|
|
<li>List data section</li>
|
|
</ul>
|
|
|
|
<p>For detailed descriptions of the fields in the list returned, see <a href="#HDRLMBRD2">Field Descriptions</a>.</p>
|
|
|
|
<p>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.</p>
|
|
|
|
<p><strong>LSTL0100 Format</strong></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%">CHAR(2)</td>
|
|
<td align="left" valign="top" width="60%">Type group</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="CENTER" valign="TOP">2</td>
|
|
<td align="CENTER" valign="TOP">2</td>
|
|
<td align="LEFT" valign="TOP">CHAR(4)</td>
|
|
<td align="LEFT" valign="TOP">Type value</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="CENTER" valign="TOP">6</td>
|
|
<td align="CENTER" valign="TOP">6</td>
|
|
<td align="LEFT" valign="TOP">CHAR(8)</td>
|
|
<td align="LEFT" valign="TOP">Type name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="CENTER" valign="TOP">14</td>
|
|
<td align="CENTER" valign="TOP">E</td>
|
|
<td align="LEFT" valign="TOP">CHAR(2)</td>
|
|
<td align="LEFT" valign="TOP">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="CENTER" valign="TOP">16</td>
|
|
<td align="CENTER" valign="TOP">10</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">20</td>
|
|
<td align="CENTER" valign="TOP">14</td>
|
|
<td align="LEFT" valign="TOP">CHAR(100)</td>
|
|
<td align="LEFT" valign="TOP">Type text</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br><br>
|
|
<h3>Format for List Mail Configuration Selection</h3>
|
|
|
|
<p>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.</p>
|
|
|
|
<p><strong>LSTC0100 Format</strong></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">Selection 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">Selection 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">Selection type name</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br><br>
|
|
<h3><a name="HDRLMBRD2">Field Descriptions</a></h3>
|
|
|
|
<p><strong>Length of structure.</strong> The length in bytes of the LSTL0100 format for list mail configuration selection.</p>
|
|
|
|
<p><strong>Reserved.</strong> A reserved field must be set to blanks.</p>
|
|
|
|
<p><strong>Selection type group.</strong> The requested type group to list. The possible values for the selection type group field are:</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>
|
|
|
|
<tr>
|
|
<td valign="top"><em>blank</em></td>
|
|
<td valign="top">List configurations that match the other selection criteria without using the selection type group as a selection criteria.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Selection type name.</strong> 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.</p>
|
|
|
|
<p><strong>Selection type value.</strong> 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.</p>
|
|
|
|
<p><strong>Type group.</strong> The type group of the entry that matched the selection criteria. The possible values for the type group field are:</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><strong>Type name.</strong> 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.</p>
|
|
|
|
<p><strong>Type text.</strong> The description of the type that matched the selection criteria.</p>
|
|
|
|
<p><strong>Type text coded character set identifier (CCSID).</strong> The coded character set identifier (CCSID) for the type text field.</p>
|
|
|
|
<p><strong>Type value.</strong> 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.</p>
|
|
|
|
<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">CPF3C21 E</td>
|
|
<td valign="top">Format name &1 is 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">CPFAFB1 E</td>
|
|
<td valign="top">Mail server framework type &1 not configured.</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>
|