1454 lines
44 KiB
HTML
1454 lines
44 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>Validate Data Field Exit Program</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>Validate Data Field Exit Program</h2>
|
|
|
|
<div class="box" style="width: 75%;">
|
|
<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%">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">Array of 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">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">Return code</td>
|
|
<td align="LEFT" valign="TOP">Output</td>
|
|
<td align="LEFT" valign="TOP">Binary(4)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<pre>
|
|
Exit Point Name: QIBM_QZMFMSF_VLD_TYP
|
|
Exit Point Format Name: VDFF0100
|
|
</pre>
|
|
</div>
|
|
|
|
<p>To configure the mail server framework, the user or programmer defines the
|
|
format of information that it will use. The four basic type groups that the
|
|
mail server framework supports are address types, message types, envelope
|
|
types, and attachment types. The definition of a type consists of its name and
|
|
its value. The mail server framework assumes that the definition of the type of
|
|
the information defines the format of the information.</p>
|
|
|
|
<p>The mail server framework also provides a Validate Data Field exit program
|
|
where a system can register programs to provide additional checking. These
|
|
programs are called when mail messages are created or changed (using the Create
|
|
Mail Message (QzmfCrtMailMsg) or Change Mail Message (QzmfChgMailMsg) API) and
|
|
the message contains a type that has a validate data field exit program
|
|
configured. The exit programs can be registered to be called for specific
|
|
types of information only, or whenever any information for a particular type group
|
|
is changed. Only list entries that have a matching type are passed to the user
|
|
exit programs. The Validate Data Field exit program is called whenever any
|
|
information matching the selection material is added to the message. When the
|
|
program is complete, it returns its status in the return code parameter. If the
|
|
return code from the exit program was zero, then the data is assumed to be
|
|
valid and accepted. If the return code was not zero, then the data is assumed
|
|
to be not valid and is rejected.</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 mail message identifier that the Validate Data
|
|
Field exit program is passing information for. 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 validated. The following table defines a message descriptor attributes
|
|
array entry.</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%">(PTR(SPP))</td>
|
|
<td align="left" valign="top" width="60%">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 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">Message descriptor 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>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Number of message descriptor attributes</strong></dt>
|
|
|
|
<dd>OUTPUT; BINARY(4)
|
|
|
|
<p>Tells the snap-in program how many message descriptor entries are in the
|
|
array being passed.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Format name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(8)
|
|
|
|
<p>The variable containing the format name of the parameter list in which
|
|
information is being passed. This field must be set to VDFF0100.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Return code</strong></dt>
|
|
|
|
<dd>OUTPUT; BINARY(4)<br>
|
|
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td valign="top"><em>0</em></td>
|
|
<td valign="top">Data was valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>1</em></td>
|
|
<td valign="top">Data was not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top"><em>2</em></td>
|
|
<td valign="top">Severe error encountered</td>
|
|
</tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
<h3><a name="HDRVDFFMTS">Message Descriptors</a></h3>
|
|
|
|
<p>A message descriptor consists of:</p>
|
|
|
|
<ul>
|
|
<li>A Validate Data Field Exit common header section<br>
|
|
<br>
|
|
</li>
|
|
|
|
<li>A list data section that contains the data to be validated. The following
|
|
table shows valid format names for message descriptors that are passed to the
|
|
validate data field exit program.<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%">Original 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">RPYL0100</td>
|
|
<td align="LEFT" valign="TOP">Reply-to address 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">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>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
|
|
<br>
|
|
<h3><a name="HDRVDFMHDR">Validate Data Field Exit 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 can be used with all of the
|
|
formats that can be passed using this exit. There may be one or more entries
|
|
after the common header section.</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">Reserved (must be set to zero)</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">Message descriptor 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 in 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="HDRVDFMFMT">Message Descriptor Formats for Validate Data Field
|
|
Exit</a></h3>
|
|
|
|
<p>One of the following message descriptor formats is used to describe the data
|
|
that follows the common header.</p>
|
|
|
|
<br>
|
|
<h3><a name="HDRRTRMB">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 the 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="HDRVDFM1">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 (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">Origin address</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
<h3><a name="HDRVDFM2">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 (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">Envelope</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
<h3><a name="HDRVDFM3">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 (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">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="HDRVDFM8">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</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="HDRRTV10B">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="HDRVDFM4">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="60%">Length of this list 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 (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">Report-to address</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
<h3><a name="HDRVDFM5">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 list 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 (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">Attachment reference</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
<h3><a name="HDRVDFMDE">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>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>
|
|
|
|
<p><strong>Note:</strong> The reason code and diagnostic code fields are
|
|
assumed to contain values that are documented in <em>CCITT Data Communication
|
|
Networks Message Handling Systems 1988 Recommendation for X.400-X.420</em> for
|
|
fields Non-delivery-reason-code and Non-delivery-diagnostic-code.</p>
|
|
|
|
<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 entry 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>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="10 90" -->
|
|
<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>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>
|
|
</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>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>
|
|
|
|
<p><strong>Note:</strong> The reason code and diagnostic code fields are
|
|
assumed to contain values that are documented in <em>CCITT Data Communication
|
|
Networks Message Handling Systems 1988 Recommendation for X.400-X.420</em> for
|
|
fields Non-delivery-reason-code and Non-delivery-diagnostic-code.</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:</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>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 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>
|
|
<hr>
|
|
<p>Exit Program Introduced: V3R1</p>
|
|
|
|
<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>
|
|
|