1580 lines
48 KiB
HTML
1580 lines
48 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>Create Mail Message (QzmfCrtMailMsg) 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 -->
|
|
<!-- This file has undergone html cleanup June 2002 by JET -->
|
|
<!--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>Create Mail Message (QzmfCrtMailMsg) API</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%">Output</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">Reserved mail message identifier</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(32)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">3</td>
|
|
<td align="left" valign="top">Creation message type</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</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">5</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">6</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">7</td>
|
|
<td align="left" valign="top">Error code</td>
|
|
<td align="left" valign="top">I/O</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
Service Program: QZMFASRV<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: No<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The Create Mail Message (QzmfCrtMailMsg) API creates a single electronic
|
|
mail message.</p>
|
|
|
|
<p>The input to this API is a parameter list which includes an array of message
|
|
descriptor attributes. Message descriptor attributes define the basic
|
|
characteristics of the message descriptor such as the format name associated
|
|
with it, a pointer to it, and its length. Each message descriptor has a common
|
|
header, which defines such things as the number of entries in the message
|
|
descriptor and where the first entry is located. Following the common header is
|
|
a list of individual entries, which contain information that define the
|
|
message. The format name defines the format of the individual entries in the
|
|
message descriptor data. The following message descriptor formats are used.</p>
|
|
|
|
<p><strong>Original recipient entry.</strong> An entry that contains the
|
|
addresses of the original recipients of the message.</p>
|
|
|
|
<p><strong>Originator entry.</strong> An entry that contains the addresses of
|
|
the originators of the message.</p>
|
|
|
|
<p><strong>Envelope entry.</strong> An entry that defines the format that is
|
|
used to pass envelopes. An envelope is a string of data representing
|
|
information about the message, aside from the attachments and its recipients.
|
|
This may include the text of the message.</p>
|
|
|
|
<p><strong>Recipient entry.</strong> An entry that contains information about
|
|
the recipient of the message. This includes the address of the recipient.
|
|
Recipient addresses are reported on when the message cannot be delivered to the
|
|
recipient.</p>
|
|
|
|
<p><strong>Reply-to address entry.</strong> An entry that contains the address
|
|
to be replied to.</p>
|
|
|
|
<p><strong>Report-on address entry.</strong> An entry that defines the address
|
|
to be reported on.</p>
|
|
|
|
<p><strong>Report-to address entry.</strong> An entry that defines an address
|
|
to be reported to in case errors are encountered delivering messages to a
|
|
recipient.</p>
|
|
|
|
<p><strong>Attachment reference entry.</strong> A reference to an attachment
|
|
that is associated with the message. Attachments may include the text of the
|
|
message.</p>
|
|
|
|
<br>
|
|
<!-- Please NOTE: DO NOT DELETE THIS SECTION if this API has no authorities and locks. -->
|
|
<!-- Instead, use the commented out coding below to indicate NONE. -->
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<!-- Use this if there are no authorities and locks. -->
|
|
<p>None.</p>
|
|
|
|
<br>
|
|
<h3>Required Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Mail message identifier</strong></dt>
|
|
|
|
<dd>OUTPUT; CHAR(32)
|
|
|
|
<p>The variable containing a unique message identifier associated with this
|
|
message. The mail message identifier is composed of characters A through Z and
|
|
0 through 9 only. On completion of this API, if a reserved mail message
|
|
identifier field is not set to blanks, this variable contains the reserved mail
|
|
message identifier. Otherwise, this field contains the identifier associated
|
|
with the message created by the API. If an error occurs during processing, the
|
|
identifier is set to zeros and a notification of the error is made in the error
|
|
code parameter. See <a href="QZMFARMI.htm">Reserve Mail Message Identifier
|
|
(QzmfRsvMailMsgId) API</a> for information on reserving mail message
|
|
identifiers.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Reserved mail message identifier</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(32)
|
|
|
|
<p>The variable containing the reserved mail message identifier associated with
|
|
this message. If the reserved mail message identifier field is set to blanks,
|
|
then a unique mail message identifier associated with this message is returned
|
|
in the mail message identifier field after the API has completed running and
|
|
has created a message. If the reserved mail message identifier field is not set
|
|
to blanks, then it is assumed that the field contains a reserved mail message
|
|
identifier. The reserved mail message identifier is returned in the mail
|
|
message identifier variable when the API has completed successfully. If the
|
|
value of the reserved mail message identifier field is not a reserved mail
|
|
message identifier, then error message CPFAF8B is generated. See <a href=
|
|
"QZMFARMI.htm">Reserve Mail Message Identifier (QzmfRsvMailMsgId) API</a> for
|
|
information on reserving mail message identifiers.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Creation message type</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(4)
|
|
|
|
<p>The message type that the originator intended to create. This is used to
|
|
indicate the message type associated with the mail server framework
|
|
message.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Message descriptor attributes</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(*)
|
|
|
|
<p>An array containing message descriptor attributes entries (see <a href=
|
|
"off3b.htm#FIGMSGDEX">Example of a Message Descriptor for the Create Mail
|
|
Message (QzmfCrtMailMsg) or Change Mail Message (QzmfChgMailMsg) API</a>). A
|
|
message descriptor attributes entry is required for each of the following
|
|
message descriptors:</p>
|
|
|
|
<ul>
|
|
<li>Originator entry<br>
|
|
<br>
|
|
</li>
|
|
|
|
<li>Envelope entry<br>
|
|
<br>
|
|
</li>
|
|
|
|
<li>Recipient entry</li>
|
|
</ul>
|
|
|
|
<p>The following table shows the data that must be provided for each message
|
|
descriptor attributes entry. The other message descriptors are optional.</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%">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 zero)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</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. A
|
|
minimum of three message descriptor attributes entries is required (originator
|
|
entry, envelope entry, and recipient entry).</p>
|
|
</dd>
|
|
|
|
<dt><strong>Format name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(8)
|
|
|
|
<p>The variable containing the format name of the parameter list passed to the
|
|
API. This field must be set to CRTM0100.</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="HDRCFMTLST">Message Descriptors</a></h3>
|
|
|
|
<p>A message descriptor consists of:</p>
|
|
|
|
<ul>
|
|
<li>A create message common header section<br>
|
|
<br>
|
|
</li>
|
|
|
|
<li>The actual message descriptor format. The following table shows valid
|
|
message descriptor formats.<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">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>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
|
|
<br>
|
|
<h3><a name="HDRCRTMHDR">Create Message Common Header</a></h3>
|
|
|
|
<p>The following table shows the common header section that is always included
|
|
at the beginning of a message descriptor.</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>
|
|
|
|
<p>The common header is used for all of the different formats that can be
|
|
supplied on the API. A specific format name can only be supplied in one of the
|
|
message descriptor common headers when this API is called. There may be zero or
|
|
more list items after the common header section.</p>
|
|
|
|
<br>
|
|
<h3><a name="HDRCRTMFMT">Message Descriptor Formats for Create Mail
|
|
Message</a></h3>
|
|
|
|
<p>If there is data after the common header, one of the following message
|
|
descriptor formats must be used. There may be multiple instances of the formats
|
|
following the common header, depending on the size of the message
|
|
descriptor.</p>
|
|
|
|
<br>
|
|
<h3><a name="HDRRTRMW1">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">Reserved (must be set to zero)</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">Reserved (must be set to zero)</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="HDRCRTM1">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">Reserved (set to zero)</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">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="HDRCRTM2">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">Reserved (set to zero)</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">Reserved (set to zero)</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="HDRCRTM3">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">Reserved (set to zero)</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="HDRCRTM4">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">Reserved (set to zero)</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">Reserved (set to zero)</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="HDRRTVMX0">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">Reserved (set to zero)</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">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">Reply-to address</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
<h3><a name="HDRCRTM5">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 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">Reserved (set to zero)</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">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="HDRCRTM6">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">Reserved (set to zero)</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">Reserved (set to zero)</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="HDRCRTMDE">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>
|
|
|
|
<!-- <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>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 the 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 he
|
|
common header.</p>
|
|
|
|
<p><strong>Message descriptor 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>RPYL0100</em></td>
|
|
<td valign="top">Reply-to address 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>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>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>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>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 and including 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>
|
|
|
|
<!-- <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>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>Reply requested flag.</strong> A flag that indicates 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 and including 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>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>
|
|
|
|
<br>
|
|
<br>
|
|
<h3>Error Messages</h3>
|
|
|
|
<table width="100%" cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<th align="left" valign="top">Message ID</th>
|
|
<th align="left" valign="top">Error Message Text</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF24B4 E</td>
|
|
<td valign="top">Severe error while addressing parameter list.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C90 E</td>
|
|
<td valign="top">Literal value cannot be changed.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9872 E</td>
|
|
<td valign="top">Program or service program &1 in library &2 ended.
|
|
Reason code &3.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFAF80 E</td>
|
|
<td valign="top">Syntax error on call to MSF API. Reason code &1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFAF81 E</td>
|
|
<td valign="top">Parameter value error on call to MSF API. Reason code
|
|
&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 &1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFAF87 E</td>
|
|
<td valign="top">MSF validate data field exit program error occurred.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFAF88 E</td>
|
|
<td valign="top">Error occurred on call to MSF exit point program.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFAF8B E</td>
|
|
<td valign="top">Reserved mail message identifier is not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFAF8D E</td>
|
|
<td valign="top">Reserved mail message identifier already used.</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>
|
|
|