friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
14ed2849c6
ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/QZMFARTV.htm

1921 lines
56 KiB
HTML
Raw Normal View History

Add readme and dist folders
2024-04-02 14:02:31 +00:00
<!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>Retrieve Mail Message (QzmfRtvMailMsg) 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>Retrieve Mail Message (QzmfRtvMailMsg) API</h2>
<div class="box" style="width: 75%;">
<br>
&nbsp;&nbsp;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%">Mail message identifier</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(32)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="LEFT" valign="TOP">Message descriptor attributes</td>
<td align="LEFT" valign="TOP">Input</td>
<td align="LEFT" valign="TOP">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="LEFT" valign="TOP">Number of message descriptor attributes</td>
<td align="LEFT" valign="TOP">Input</td>
<td align="LEFT" valign="TOP">Array of Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">4</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">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>
&nbsp;&nbsp;Service Program: QZMFASRV<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Retrieve Mail Message (QzmfRtvMailMsg) API retrieves information about
an electronic mail message and returns it in the receiver variables provided by
the caller. It is only valid to call this API during the processing of the exit
program for the Snap-In Call or Track Mail Message Changes exit point.</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>Mail message identifier</strong></dt>
<dd>INPUT; CHAR(32)
<p>The variable containing the message identifier for which information is to
be retrieved. The mail message identifier is composed of characters A through Z
and 0 through 9 only.</p>
</dd>
<dt><strong>Message descriptor attributes</strong></dt>
<dd>INPUT; ARRAY OF CHAR(*)
<p>This array contains the message descriptor attributes for the data that is
to be retrieved. The following table defines a message descriptor attributes
array entry.</p>
<p><strong><a name="TBLRTVARR">Table 1. Message Descriptor Attribute Array
Entry</a></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%">POINTER</td>
<td align="left" valign="top" width="60%">Receiver message descriptor
pointer</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">Length of the receiver message descriptor</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">20</td>
<td align="CENTER" valign="TOP">14</td>
<td align="LEFT" valign="TOP">CHAR(8)</td>
<td align="LEFT" valign="TOP">Format name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">28</td>
<td align="CENTER" valign="TOP">1C</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Reserved (must be set to zero)</td>
</tr>
</table>
<p>The message descriptor attribute array entry contains the following:</p>
<ul>
<li>Pointers to the message descriptors that are to receive the message
information<br>
<br>
</li>
<li>The format name associated with the message descriptor<br>
<br>
</li>
<li>The length of the message descriptor.</li>
</ul>
<p>If the message descriptors are not long enough to hold all of the available
message information, the data is truncated and the number of bytes available is
returned. If the length specified for the receiver message descriptor is -1,
the pointer to the message descriptor is pointing to a user space that should
be automatically extended by the API if it is not large enough for all of the
data.</p>
<p>The format name associated with the message descriptor indicates what type
of message information is being requested.</p>
</dd>
<dt><strong>Number of message descriptor attributes</strong></dt>
<dd>INPUT; BINARY(4)
<p>The number of entries in the array of message descriptor attributes. At
least one array element must be specified on a call to this API.</p>
</dd>
<dt><strong>Format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The variable containing the format name of the parameter list being
returned. This field must be set to RTVM0100.</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><a name="HDRRTVFMTS">Message Parameter Lists</a></h3>
<p>A message descriptor consists of:</p>
<ul>
<li>A common message header section<br>
<br>
</li>
<li>The actual message descriptor format. The following table shows valid
message descriptors.<br>
<br>
<table border width="50%">
<tr>
<th align="LEFT" valign="TOP">Format name</th>
<th align="LEFT" valign="TOP">Description</th>
</tr>
<tr>
<td align="LEFT" valign="TOP" width="30%">ORCL0100</td>
<td align="LEFT" valign="TOP" width="70%">Originator recipient entry</td>
</tr>
<tr>
<td align="LEFT" valign="TOP">ORGL0100</td>
<td align="LEFT" valign="TOP">Originator entry</td>
</tr>
<tr>
<td align="LEFT" valign="TOP">ENVL0100</td>
<td align="LEFT" valign="TOP">Envelope entry</td>
</tr>
<tr>
<td align="LEFT" valign="TOP">RCPL0100</td>
<td align="LEFT" valign="TOP">Recipient entry</td>
</tr>
<tr>
<td align="LEFT" valign="TOP">RCHL0100</td>
<td align="LEFT" valign="TOP">Recipient history entry</td>
</tr>
<tr>
<td align="LEFT" valign="TOP">ROAL0100</td>
<td align="LEFT" valign="TOP">Report-on address entry</td>
</tr>
<tr>
<td align="LEFT" valign="TOP">RPYL0100</td>
<td align="LEFT" valign="TOP">Reply-to address entry</td>
</tr>
<tr>
<td align="LEFT" valign="TOP">RTAL0100</td>
<td align="LEFT" valign="TOP">Report-to address entry</td>
</tr>
<tr>
<td align="LEFT" valign="TOP">ATTL0100</td>
<td align="LEFT" valign="TOP">Attachment reference entry</td>
</tr>
<tr>
<td align="LEFT" valign="TOP">MSGL0100</td>
<td align="LEFT" valign="TOP">Message types in the recipient list entries</td>
</tr>
<tr>
<td align="LEFT" valign="TOP">EXCH0100</td>
<td align="LEFT" valign="TOP">Exit call history entry</td>
</tr>
<tr>
<td align="LEFT" valign="TOP">CRTA0100</td>
<td align="LEFT" valign="TOP">Creation attributes entry</td>
</tr>
</table>
</li>
</ul>
<br>
<h3><a name="HDRRTVMHDR">Message Descriptor Common Header</a></h3>
<p>The following table shows the common header section that is always included
at the beginning of a message descriptor. It is used for all of the different
formats that can be retrieved using this API. The common header will always be
returned, even if there is no message descriptor data to be included. There may
be no list items or one or more list items after the common header section.</p>
<p><strong><a name="TBLRTVCHDR">Table 2. Format of Common
Header</a></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 this message
descriptor</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">4</td>
<td align="CENTER" valign="TOP">4</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Number of bytes available for this message
descriptor</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">8</td>
<td align="CENTER" valign="TOP">8</td>
<td align="LEFT" valign="TOP">CHAR(8)</td>
<td align="LEFT" valign="TOP">Array element format name</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">Offset of the first entry in the message
descriptor</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">Number of entries available for this message
descriptor</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">24</td>
<td align="CENTER" valign="TOP">18</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Reserved (must be set to zero)</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">*</td>
<td align="CENTER" valign="TOP">*</td>
<td align="LEFT" valign="TOP">CHAR(*)</td>
<td align="LEFT" valign="TOP">Message descriptor data</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRRTVMFMT">Message Descriptor Formats for Retrieve Mail
Message</a></h3>
<p>If there is data after the common header, the format associated with the
message descriptor is used. There may be multiple instances of the formats
following the common header, depending on the size of the parameter list.</p>
<br>
<h3><a name="HDRRTRMR1">ORCL0100 Format (Original Recipient Entry)</a></h3>
<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 this entry</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">4</td>
<td align="CENTER" valign="TOP">4</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Displacement of the original recipient address
from the beginning of this ORCL0100 entry</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">8</td>
<td align="CENTER" valign="TOP">8</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Length of original recipient address</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">12</td>
<td align="CENTER" valign="TOP">C</td>
<td align="LEFT" valign="TOP">CHAR(4)</td>
<td align="LEFT" valign="TOP">Address type</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">Original recipient address 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">BINARY(4)</td>
<td align="LEFT" valign="TOP">Distribution type</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">24</td>
<td align="CENTER" valign="TOP">18</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Reply requested flag</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">28</td>
<td align="CENTER" valign="TOP">1C</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Unique identifier</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">32</td>
<td align="CENTER" valign="TOP">20</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Unique identifier of referenced ORCL0100
entry</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">36</td>
<td align="CENTER" valign="TOP">24</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Reserved (must be set to zero)</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">*</td>
<td align="CENTER" valign="TOP">*</td>
<td align="LEFT" valign="TOP">CHAR(*)</td>
<td align="LEFT" valign="TOP">Original recipient address</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRDTRME1">ORGL0100 Format (Originator Entry)</a></h3>
<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 this entry</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">4</td>
<td align="CENTER" valign="TOP">4</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Displacement of the origin address from the
beginning of this ORGL0100 entry</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">8</td>
<td align="CENTER" valign="TOP">8</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Length of origin address</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">12</td>
<td align="CENTER" valign="TOP">C</td>
<td align="LEFT" valign="TOP">CHAR(4)</td>
<td align="LEFT" valign="TOP">Address type</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">Origin address 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">BINARY(4)</td>
<td align="LEFT" valign="TOP">Unique identifier</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">24</td>
<td align="CENTER" valign="TOP">18</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Unique identifier of referenced ORGL0100
entry</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">28</td>
<td align="CENTER" valign="TOP">1C</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Reserved (set to zero)</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">*</td>
<td align="CENTER" valign="TOP">*</td>
<td align="LEFT" valign="TOP">CHAR(*)</td>
<td align="LEFT" valign="TOP">Origin address</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRRTRM2">ENVL0100 Format (Envelope Entry)</a></h3>
<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 this entry</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">4</td>
<td align="CENTER" valign="TOP">4</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Displacement of envelope from the beginning of
this ENVL0100 entry</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">8</td>
<td align="CENTER" valign="TOP">8</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Length of envelope</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">12</td>
<td align="CENTER" valign="TOP">C</td>
<td align="LEFT" valign="TOP">CHAR(4)</td>
<td align="LEFT" valign="TOP">Envelope type</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">Unique identifier</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">Unique identifier of referenced ENVL0100
entry</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">24</td>
<td align="CENTER" valign="TOP">18</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Reserved (set to zero)</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">*</td>
<td align="CENTER" valign="TOP">*</td>
<td align="LEFT" valign="TOP">CHAR(*)</td>
<td align="LEFT" valign="TOP">Envelope</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRRTRM3">RCPL0100 Format (Recipient Entry)</a></h3>
<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 this entry</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">4</td>
<td align="CENTER" valign="TOP">4</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Displacement of the snap-in provided information
(SPIN) from the beginning of this RCPL0100 entry</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">8</td>
<td align="CENTER" valign="TOP">8</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Length of snap-in provided information
(SPIN)</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">12</td>
<td align="CENTER" valign="TOP">C</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Displacement of the recipient address from the
beginning of this RCPL0100 entry</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">Length of recipient address</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">20</td>
<td align="CENTER" valign="TOP">14</td>
<td align="LEFT" valign="TOP">CHAR(4)</td>
<td align="LEFT" valign="TOP">Address type</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">24</td>
<td align="CENTER" valign="TOP">18</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Recipient address coded character set identifier
(CCSID)</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">28</td>
<td align="CENTER" valign="TOP">1C</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Reason code</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">32</td>
<td align="CENTER" valign="TOP">20</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Diagnostic code</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">36</td>
<td align="CENTER" valign="TOP">24</td>
<td align="LEFT" valign="TOP">CHAR(4)</td>
<td align="LEFT" valign="TOP">Message type</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">40</td>
<td align="CENTER" valign="TOP">28</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Status</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">44</td>
<td align="CENTER" valign="TOP">2C</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Reserved</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">48</td>
<td align="CENTER" valign="TOP">30</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Unique identifier</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">52</td>
<td align="CENTER" valign="TOP">34</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Reserved (set to zero)</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">*</td>
<td align="CENTER" valign="TOP">*</td>
<td align="LEFT" valign="TOP">CHAR(*)</td>
<td align="LEFT" valign="TOP">Recipient address</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">*</td>
<td align="CENTER" valign="TOP">*</td>
<td align="LEFT" valign="TOP">CHAR(*)</td>
<td align="LEFT" valign="TOP">Snap-in provided information (SPIN)</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRRTVMA0">ROAL0100 Format (Report-on Address Entry)</a></h3>
<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 this entry</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">4</td>
<td align="CENTER" valign="TOP">4</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Displacement of the snap-in provided information
(SPIN) from the beginning of this ROAL0100 entry</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">8</td>
<td align="CENTER" valign="TOP">8</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Length of snap-in provided information
(SPIN)</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">12</td>
<td align="CENTER" valign="TOP">C</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Displacement of the report-on address from the
beginning of this ROAL0100 entry</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">Length of address</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">20</td>
<td align="CENTER" valign="TOP">14</td>
<td align="LEFT" valign="TOP">CHAR(4)</td>
<td align="LEFT" valign="TOP">Address type</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">24</td>
<td align="CENTER" valign="TOP">18</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Report-on address coded character set identifier
(CCSID)</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">28</td>
<td align="CENTER" valign="TOP">1C</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Reason code</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">32</td>
<td align="CENTER" valign="TOP">20</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Diagnostic code</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">36</td>
<td align="CENTER" valign="TOP">24</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Unique identifier</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">40</td>
<td align="CENTER" valign="TOP">28</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Unique identifier of referenced ROAL0100
entry</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">44</td>
<td align="CENTER" valign="TOP">2C</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Reserved (set to zero)</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">*</td>
<td align="CENTER" valign="TOP">*</td>
<td align="LEFT" valign="TOP">CHAR(*)</td>
<td align="LEFT" valign="TOP">Report-on address</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">*</td>
<td align="CENTER" valign="TOP">*</td>
<td align="LEFT" valign="TOP">CHAR(*)</td>
<td align="LEFT" valign="TOP">Snap-in provided information (SPIN)</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRRTVMB0">RPYL0100 Format (Reply-to Address Entry)</a></h3>
<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 this entry</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">4</td>
<td align="CENTER" valign="TOP">4</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Displacement of the reply-to address from the
beginning of this RPYL0100 entry</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">8</td>
<td align="CENTER" valign="TOP">8</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Length of reply-to address</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">12</td>
<td align="CENTER" valign="TOP">C</td>
<td align="LEFT" valign="TOP">CHAR(4)</td>
<td align="LEFT" valign="TOP">Address type</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">Reply-to address 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">BINARY(4)</td>
<td align="LEFT" valign="TOP">Unique identifier</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">24</td>
<td align="CENTER" valign="TOP">18</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Unique identifier of referenced RPYL0100
entry</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">28</td>
<td align="CENTER" valign="TOP">1C</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Reserved (must be set to zero)</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">*</td>
<td align="CENTER" valign="TOP">*</td>
<td align="LEFT" valign="TOP">CHAR(*)</td>
<td align="LEFT" valign="TOP">Reply-to address</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRRTVM4">RTAL0100 Format (Report-to Address Entry)</a></h3>
<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="40%">Length of this entry</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">4</td>
<td align="CENTER" valign="TOP">4</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Displacement of the report-to address from the
beginning of this RTAL0100 entry</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">8</td>
<td align="CENTER" valign="TOP">8</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Length of address</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">12</td>
<td align="CENTER" valign="TOP">C</td>
<td align="LEFT" valign="TOP">CHAR(4)</td>
<td align="LEFT" valign="TOP">Address type</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">Report-to address 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">BINARY(4)</td>
<td align="LEFT" valign="TOP">Unique identifier</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">24</td>
<td align="CENTER" valign="TOP">18</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Unique identifier of referenced RTAL0100
entry</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">28</td>
<td align="CENTER" valign="TOP">1C</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Reserved (set to zero)</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">*</td>
<td align="CENTER" valign="TOP">*</td>
<td align="LEFT" valign="TOP">CHAR(*)</td>
<td align="LEFT" valign="TOP">Report-to address</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRRTVM5">ATTL0100 Format (Attachment Reference Entry)</a></h3>
<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 this entry</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">4</td>
<td align="CENTER" valign="TOP">4</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Displacement of the attachment reference from the
beginning of this ATTL0100 entry</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">8</td>
<td align="CENTER" valign="TOP">8</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Length of attachment reference</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">12</td>
<td align="CENTER" valign="TOP">C</td>
<td align="LEFT" valign="TOP">CHAR(4)</td>
<td align="LEFT" valign="TOP">Attachment reference type</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">Unique identifier</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">Unique identifier of referenced ATTL0100
entry</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">24</td>
<td align="CENTER" valign="TOP">18</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Reserved (set to zero)</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">*</td>
<td align="CENTER" valign="TOP">*</td>
<td align="LEFT" valign="TOP">CHAR(*)</td>
<td align="LEFT" valign="TOP">Attachment reference</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRRTVM6">MSGL0100 Format (Message Types in the Recipient List
Entry)</a></h3>
<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(4)</td>
<td align="left" valign="top" width="60%">Message type</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRRTVM7">RCHL0100 Format (Recipient History Entry)</a></h3>
<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 this entry</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">4</td>
<td align="CENTER" valign="TOP">4</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Displacement of the snap-in provided information
(SPIN) of this RCHL0100 entry</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">8</td>
<td align="CENTER" valign="TOP">8</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Length of snap-in provided information
(SPIN)</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">12</td>
<td align="CENTER" valign="TOP">C</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Displacement of the recipient address from the
beginning of this RCHL0100 entry</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">Length of recipient address</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">20</td>
<td align="CENTER" valign="TOP">14</td>
<td align="LEFT" valign="TOP">CHAR(4)</td>
<td align="LEFT" valign="TOP">Address type</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">24</td>
<td align="CENTER" valign="TOP">18</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Recipient address coded character set identifier
(CCSID)</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">28</td>
<td align="CENTER" valign="TOP">1C</td>
<td align="LEFT" valign="TOP">CHAR(4)</td>
<td align="LEFT" valign="TOP">Message type</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">32</td>
<td align="CENTER" valign="TOP">20</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Status</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">36</td>
<td align="CENTER" valign="TOP">24</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Reserved</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">40</td>
<td align="CENTER" valign="TOP">28</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Unique identifier</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">44</td>
<td align="CENTER" valign="TOP">2C</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Recipient status flag</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">48</td>
<td align="CENTER" valign="TOP">30</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Unique identifier of parent entry</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">52</td>
<td align="CENTER" valign="TOP">34</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Reserved (set to zero)</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">*</td>
<td align="CENTER" valign="TOP">*</td>
<td align="LEFT" valign="TOP">CHAR(*)</td>
<td align="LEFT" valign="TOP">Recipient address</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">*</td>
<td align="CENTER" valign="TOP">*</td>
<td align="LEFT" valign="TOP">CHAR(*)</td>
<td align="LEFT" valign="TOP">Snap-in provided information (SPIN)</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRRTVM8">EXCH0100 Format (Exit Point Call History Entry)</a></h3>
<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(20)</td>
<td align="left" valign="top" width="60%">Mail server framework exit point
name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">20</td>
<td align="CENTER" valign="TOP">14</td>
<td align="LEFT" valign="TOP">CHAR(10)</td>
<td align="LEFT" valign="TOP">Qualified mail server framework exit program
name</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">30</td>
<td align="CENTER" valign="TOP">1E</td>
<td align="LEFT" valign="TOP">CHAR(10)</td>
<td align="LEFT" valign="TOP">Mail server framework exit program library</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">40</td>
<td align="CENTER" valign="TOP">28</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Exit program number</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">44</td>
<td align="CENTER" valign="TOP">2C</td>
<td align="LEFT" valign="TOP">CHAR(16)</td>
<td align="LEFT" valign="TOP">Timestamp of when the exit program was
called</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">60</td>
<td align="CENTER" valign="TOP">3C</td>
<td align="LEFT" valign="TOP">CHAR(16)</td>
<td align="LEFT" valign="TOP">Timestamp of when the exit program returned</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">76</td>
<td align="CENTER" valign="TOP">4C</td>
<td align="LEFT" valign="TOP">BINARY(4)</td>
<td align="LEFT" valign="TOP">Return code from the exit program</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">80</td>
<td align="CENTER" valign="TOP">50</td>
<td align="LEFT" valign="TOP">CHAR(1)</td>
<td align="LEFT" valign="TOP">Change indicator</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">81</td>
<td align="CENTER" valign="TOP">51</td>
<td align="LEFT" valign="TOP">CHAR(3)</td>
<td align="LEFT" valign="TOP">Reserved (set to blanks)</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRRTVM9">CRTA0100 Format (Creation Attributes Entry)</a></h3>
<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(16)</td>
<td align="left" valign="top" width="60%">Timestamp of when the message was
created</td>
</tr>
<tr>
<td align="CENTER" valign="TOP">16</td>
<td align="CENTER" valign="TOP">10</td>
<td align="LEFT" valign="TOP">CHAR(4)</td>
<td align="LEFT" valign="TOP">Creation message type</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRRTVMDE">Field Descriptions</a></h3>
<p><strong>Address type.</strong> The type of address that is contained in the
entry.</p>
<p><strong>Attachment reference.</strong> A reference to an attachment that is
associated with the message.</p>
<p><strong>Attachment reference type.</strong> The type of attachment that is
contained in the entry.</p>
<p><strong>Change indicator.</strong> An indicator of whether processing of the
exit point program resulted in changes to the message.</p>
<table cellpadding="3">
<!-- cols="5 95" -->
<tr>
<td valign="top"><em>0</em></td>
<td valign="top">There were no changes to the message as a result of this exit
point program being called.</td>
</tr>
<tr>
<td valign="top"><em>1</em></td>
<td valign="top">There were changes to the message as a result of this exit
point program being called.</td>
</tr>
</table>
<p><strong>Creation message type.</strong> The creation message type specified
when the MSF message was created.</p>
<p><strong>Diagnostic code.</strong> A code that indicates the cause of a
problem which caused the delivery of a message to this address to fail. The
diagnostic code is assumed to contain the X.400 nondelivery diagnostic
code.</p>
<!-- <TABLE><TR><TD>The reason code and diagnostic code fields are assumed to contain
values that are documented in
<CITE>CCITT Data Communication Networks Message Handling Systems
1988 Recommendation for X.400-X.420</CITE>
for the fields Non-delivery-reason-code
and Non-delivery-diagnostic-code.</td></tr></table> -->
<p><strong>Displacement of the attachment reference from the beginning of this
ATTL0100 entry.</strong> The displacement from the beginning of this entry to
the attachment reference in this entry.</p>
<p><strong>Displacement of the envelope from the beginning of this ENVL0100
entry.</strong> The displacement from the beginning of this entry to the
envelope in this entry.</p>
<p><strong>Displacement of the origin address from the beginning of this
ORGL0100 entry.</strong> The displacement from the beginning of this entry to
the origin address in this entry.</p>
<p><strong>Displacement of the original recipient address from the beginning of
this ORCL0100 entry.</strong> The displacement from the beginning of this entry
to the original recipient address in this entry.</p>
<p><strong>Displacement of the recipient address from the beginning of this
RCPL0100 entry.</strong> The displacement from the beginning of this entry to
the recipient address in this entry.</p>
<p><strong>Displacement of the reply-to address from the beginning of this
RPYL0100 entry.</strong> The displacement from the beginning of this entry to
the reply-to address in this entry.</p>
<p><strong>Displacement of the report-to address from the beginning of this
RTAL0100 entry.</strong> The displacement from the beginning of this entry to
the report-to address in this entry.</p>
<p><strong>Displacement of the report-on address from the beginning of this
ROAL0100 entry.</strong> The displacement from the beginning of this entry to
the report-on address in this entry.</p>
<p><strong>Displacement of the snap-in provided information (SPIN) of this
RCHL0100.</strong> The displacement from the beginning of this entry to the
snap-in provided information (SPIN). (There are fields for RCPL0100 and
RCHL0100 entries.)</p>
<p><strong>Distribution type.</strong> The type of distribution associated with
each recipient entry. The possible values are:</p>
<table cellpadding="3">
<!-- cols="5 95" -->
<tr>
<td valign="top"><em>0</em></td>
<td valign="top">Normal message recipient</td>
</tr>
<tr>
<td valign="top"><em>1</em></td>
<td valign="top">CC (carbon copy) recipient</td>
</tr>
<tr>
<td valign="top"><em>2</em></td>
<td valign="top">BCC (blind carbon copy) recipient</td>
</tr>
</table>
<p><strong>Envelope.</strong> A string of data representing information about
the message, aside from the attachments and its recipients.</p>
<p><strong>Envelope type.</strong> The type of envelope that is contained in
the entry.</p>
<p><strong>Exit program number.</strong> A number assigned to the exit program
when it is registered using the registration facility. This is the number in
effect at the time the exit program was called.</p>
<p><strong>Format name.</strong> The content and format of the information
provided for each message parameter. The possible values are:</p>
<table cellpadding="3">
<!-- cols="15 85" -->
<tr>
<td valign="top"><em>ORCL0100</em></td>
<td valign="top">Original recipient entry</td>
</tr>
<tr>
<td valign="top"><em>ORGL0100</em></td>
<td valign="top">Originator entry</td>
</tr>
<tr>
<td valign="top"><em>ENVL0100</em></td>
<td valign="top">Envelope entry</td>
</tr>
<tr>
<td valign="top"><em>RCPL0100</em></td>
<td valign="top">Recipient entry</td>
</tr>
<tr>
<td valign="top"><em>RCHL0100</em></td>
<td valign="top">Recipient history entry</td>
</tr>
<tr>
<td valign="top"><em>ROAL0100</em></td>
<td valign="top">Report-on address entry</td>
</tr>
<tr>
<td valign="top"><em>RPYL0100</em></td>
<td valign="top">Reply-to address entry</td>
</tr>
<tr>
<td valign="top"><em>RTAL0100</em></td>
<td valign="top">Report-to address entry</td>
</tr>
<tr>
<td valign="top"><em>ATTL0100</em></td>
<td valign="top">Attachment reference entry</td>
</tr>
<tr>
<td valign="top"><em>MSGL0100</em></td>
<td valign="top">List of message types in the recipient list entry</td>
</tr>
<tr>
<td valign="top"><em>EXCH0100</em></td>
<td valign="top">Exit call history entry</td>
</tr>
<tr>
<td valign="top"><em>CRTA0100</em></td>
<td valign="top">Creation attributes entry</td>
</tr>
</table>
<p><strong>Length of address.</strong> The length of address that is contained
in the entry. The maximum length of an address is 1024 bytes.</p>
<p><strong>Length of attachment reference.</strong> The length in bytes of the
attachment reference that is contained in the entry.</p>
<p><strong>Length of envelope.</strong> The length of envelope that is
contained in the entry.</p>
<p><strong>Length of origin address.</strong> The length of the origin address
for this entry. The maximum length of an origin address is 1024 bytes.</p>
<p><strong>Length of original recipient address.</strong> The length of the
original recipient address for this entry. The maximum length of an original
recipient address is 1024 bytes.</p>
<p><strong>Length of receiver message descriptor.</strong> The length in bytes
of the message descriptor that is being pointed to by the pointer to the
message descriptor. The maximum length of a message descriptor is 16 million
bytes.</p>
<p><strong>Length of recipient address.</strong> The length in bytes of the
recipient address. The maximum length of a recipient address is 1024 bytes.</p>
<p><strong>Length of reply-to address.</strong> The length in bytes of the
reply-to address. The maximum length of a reply-to address is 1024 bytes.</p>
<p><strong>Length of snap-in provided information (SPIN).</strong> The length
in bytes of the snap-in provided information (SPIN). The maximum length of the
SPIN is 256 bytes.</p>
<p><strong>Length of this entry.</strong> The length in bytes of this entry.
This is used to get to the next entry.</p>
<p><strong>Length of this message descriptor.</strong> The length in bytes of
this message descriptor. The maximum length of a message descriptor is 16
million bytes.</p>
<p><strong>Message descriptor data.</strong> One or more parameter list formats
that follow the common header. Message descriptors are made up of a common
header and a list of entries. The format of each entry in the list is defined
by the format name associated with the message descriptor, which is located in
the common header. The number of entries in the list is also defined in the
common header.</p>
<p><strong>Message type.</strong> The type of message that is associated with
the entry.</p>
<p><strong>Number of bytes available for this message descriptor.</strong> The
number of bytes available in the space where the mail server framework puts the
information being retrieved.</p>
<p><strong>Number of entries available for this message descriptor.</strong>
The total number of entries available for this message descriptor indicates the
number of entries that would be returned if the length of the message
descriptor is greater than or equal to the number of bytes available for this
message descriptor.</p>
<p><strong>Offset of the first entry in the message descriptor.</strong> The
offset from the beginning of this message descriptor to the first entry in the
list of entries.</p>
<p><strong>Origin address.</strong> A string that represents the address
associated with the originator of the message. The contents and format of the
string are not defined by the mail server framework. It is assumed that the
address type associated with the origin address defines the contents of the
origin address field.</p>
<p><strong>Origin address coded character set identifier (CCSID).</strong> The
CCSID provided for the origin address. Valid values for the CCSID are 1 through
65533 and 65535.</p>
<p><strong>Original recipient address.</strong> A string that represents the
address associated with the original recipient of the message. The contents and
format of the string are not defined by the mail server framework. It is
assumed that the address type associated with the original recipient address
defines the contents of the original recipient address field.</p>
<p><strong>Original recipient address coded character set identifier
(CCSID).</strong> The CCSID provided for the original recipient address. Valid
values for the CCSID are 1 through 65533 and 65535.</p>
<p><strong>Qualified mail server framework exit program name.</strong> The
qualified program name of the program that was called at the mail server
framework exit point.</p>
<p><strong>Reason code.</strong> A code that identifies reasons associated with
the message delivery to this address. In the case of a nondelivery entry, this
field would contain the reason the delivery of this message to this recipient
failed. The reason code is assumed to contain the X.400 nondelivery reason
code.</p>
<!-- <TABLE><TR><TD>The reason code and diagnostic code fields are assumed to contain
values that are documented in
<CITE>CCITT Data Communication Networks Message Handling Systems
1988 Recommendation for X.400-X.420</CITE>
for the fields Non-delivery-reason-code
and Non-delivery-diagnostic-code.</td></tr></table> -->
<p><strong>Receiver message descriptor pointer.</strong> A space pointer that
points to a message descriptor. A message descriptor is used to pass
information which describes the message.</p>
<p><strong>Recipient address.</strong> A string that represents the address
associated with a recipient of the message. The contents and format of the
string are not defined by the mail server framework. It is assumed that the
address type associated with the recipient address defines the contents of the
recipient address field.</p>
<p><strong>Recipient address coded character set identifier (CCSID).</strong>
The CCSID provided for the recipient address. Valid values for the CCSID are 1
through 65533 and 65535.</p>
<p><strong>Recipient status flag.</strong> A flag which when set to 1 indicates
that this entry has been replaced by either one or multiple entries. Entries
with this flag set to 1 are referred to as parents. Entries with this flag set
zero are referred to as children.</p>
<p><strong>Reply requested flag.</strong> Whether this original recipient
should reply to the message. The possible values are as follows:</p>
<table cellpadding="3">
<!-- cols="5 95" -->
<tr>
<td valign="top"><em>0</em></td>
<td valign="top">A reply is not requested from this original recipient</td>
</tr>
<tr>
<td valign="top"><em>1</em></td>
<td valign="top">A reply is requested from this original recipient</td>
</tr>
</table>
<p><strong>Reply-to address.</strong> A string that represents the address to
be replied to. The contents and format of the string are not defined by the
mail server framework. It is assumed that the address type associated with the
reply-to address defines the contents of the reply-to address field.</p>
<p><strong>Reply-to address coded character set identifier (CCSID).</strong>
The CCSID provided for the reply-to address. Valid values for the CCSID are 1
through 65533 and 65535.</p>
<p><strong>Report-on address.</strong> A string which represents the address to
be reported on. The contents and format of the string are not defined by the
mail server framework. It is assumed that the address type associated with the
report-on address defines the contents of the report-on address field.</p>
<p><strong>Report-on address coded character set identifier (CCSID).</strong>
The CCSID provided for the report-on address. Valid values for the CCSID are 1
through 65533 and 65535.</p>
<p><strong>Report-to address.</strong> A string which represents the address to
be reported to. The contents and format of the string are not defined by the
mail server framework. It is assumed that the address type associated with the
report-to address defines the contents of the report-to address field.</p>
<p><strong>Report-to address coded character set identifier (CCSID).</strong>
The CCSID provided for the report-to address. Valid values for the CCSID are 1
through 65533 and 65535.</p>
<p><strong>Reserved.</strong> All reserved fields must be set to zero.</p>
<p><strong>Return code from the exit program.</strong> The return code returned
by the user exit program.</p>
<p><strong>Snap-in provided information (SPIN).</strong> An area where snap-ins
can store information that other snap-ins may use. SPIN provides a place where
information relating to a specific recipient can be stored and used by snap-ins
in the same or different exit points. This is completely user-defined and
user-interpreted data.</p>
<p><strong>Status.</strong> The status associated with each recipient entry.
The possible values are:</p>
<table cellpadding="3">
<!-- cols="5 95" -->
<tr>
<td valign="top"><em>1</em></td>
<td valign="top">Forwarded (remote)</td>
</tr>
<tr>
<td valign="top"><em>2</em></td>
<td valign="top">Ignore</td>
</tr>
<tr>
<td valign="top"><em>3</em></td>
<td valign="top">Local</td>
</tr>
<tr>
<td valign="top"><em>4</em></td>
<td valign="top">Nondeliverable</td>
</tr>
<tr>
<td valign="top"><em>5</em></td>
<td valign="top">Security violation</td>
</tr>
</table>
<p><strong>Timestamp of when the message was created.</strong> The timestamp of
when the message was created. The format of the timestamp is CYYMMDDHHMMSSMMM.
The fields are defined in the order that they occur in the string.</p>
<table cellpadding="3">
<!-- cols="10 90" -->
<tr>
<td valign="top"><em>C</em></td>
<td valign="top">Century, where 0 indicates years 19<em>xx</em> and 1 indicates
years 20<em>xx</em>.</td>
</tr>
<tr>
<td valign="top"><em>YY</em></td>
<td valign="top">Year</td>
</tr>
<tr>
<td valign="top"><em>MM</em></td>
<td valign="top">Month</td>
</tr>
<tr>
<td valign="top"><em>DD</em></td>
<td valign="top">Day</td>
</tr>
<tr>
<td valign="top"><em>HH</em></td>
<td valign="top">Hour of the day</td>
</tr>
<tr>
<td valign="top"><em>mm</em></td>
<td valign="top">Minute of the hour</td>
</tr>
<tr>
<td valign="top"><em>SS</em></td>
<td valign="top">Second of the minute</td>
</tr>
<tr>
<td valign="top"><em>MMM</em></td>
<td valign="top">Milliseconds in zoned format</td>
</tr>
</table>
<p><strong>Timestamp of when the exit program was called.</strong> The
timestamp of when the exit point was called. The format of this timestamp is
the same as that of the timestamp of when the message was created.</p>
<p><strong>Timestamp of when the exit program returned.</strong> The timestamp
of when the exit point returned. The format of this timestamp is the same as
that of the timestamp of when the message was created.</p>
<p><strong>Unique identifier.</strong> A unique identifier that differentiates
each item within a particular list. Identifiers are generated for each list
item when the Create Mail Message (QzmfCrtMailMsg) API has successfully
completed. These unique identifiers are temporary and may change as the mail
service processes a message. List entries are placed in message descriptors
such that unique identifiers are in ascending order.</p>
<p><strong>Unique identifier of parent entry.</strong> The unique identifier
associated with the parent entry of this entry. A parent entry is an entry that
had been replaced by a single or multiple entries.</p>
<p><strong>Unique identifier of referenced entry.</strong> The unique
identifier of another ORCL0100, ORGL0100, ENVL0100, RTAL0100, ROAL0100,
RPYL0100, or ATTL0100 entry that this entry refers to. This field can be used
to create entry cross-references as new entries are added.</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">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 &amp;1 in library &amp;2 ended.
Reason code &amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPFAF80 E</td>
<td valign="top">Syntax error on call to MSF API. Reason code &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPFAF82 E</td>
<td valign="top">Error occurred during running of MSF API.</td>
</tr>
<tr>
<td align="left" valign="top">CPFAF83 E</td>
<td valign="top">Parameter error on call to MSF API. Reason code &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPFAF84 E</td>
<td valign="top">MSF API failed. MSF message identifier not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPFAF85 E</td>
<td valign="top">MSF API failed. Request not allowed.</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>
Reference in New Issue Copy Permalink