ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/off3b.htm

85 lines
3.7 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>Using AnyMail/400 Mail Server Framework APIs</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. -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- OFF3A SCRIPT A converted by B2H R4.1 (346) (CMS) by HOLTJM at -->
<!-- RCHVMW2 on 4 Feb 1999 at 15:00:55 -->
<!-- File Edited November 2001 -->
<!-- End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<!-- Java sync-link -->
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
</script>
<a name="Top_Of_Page"></a>
<h2>Using AnyMail/400 Mail Server Framework APIs</h2>
<p>The mail server framework can be configured for up to 128 types in each type
group. On each iSeries<SUP>(TM)</SUP> system, type configuration defines the list of the types
that the system can process. The data that is passed to the Create Mail Message
API must be in a type that is supported by the system.</p>
<p>A message type is associated with each recipient of the message and is used
to tailor the processing of the message. Message types are usually assigned
when address resolution takes place.</p>
<p>A message is the sum of all of the data in the message descriptors. These
message descriptors are passed to the Create Mail Message (QzmfCrtMailMsg) API
using the array of message descriptor attributes.</p>
<p><a href="#FIGMSGDEX">Figure 1</a> is an example of a message descriptor that
has three descriptor lists being passed: 1) recipient list, 2) envelope list,
and 3) originator list. The attachment list, original recipient list, reply-to
address list, report-on address list, and report-to address list are optional
descriptor lists.</p>
<p><strong><a name="FIGMSGDEX">Figure 1. Example of a Message Descriptor for
the Create Mail Message (QzmfCrtMailMsg) or Change Mail Message
(QzmfChgMailMsg) API</a></strong></p>
<p><img src="RBAFX564.gif" alt="Message descriptor"></p>
<p>If no errors are encountered during the creation of the mail message, the
mail message identifier field contains the unique message identifier associated
with the message. If a reserved mail message identifier had been passed, then
the reserved mail message identifier is put in the mail message identifier
parameter. If any errors are encountered during the creation process, an error
message is generated and the mail message identifier returned is set to
zeros.</p>
<p>All messages referred to in this section are issued synchronously.</p>
<p>All displacements are base 0 unless otherwise specified.</p>
<p>The <cite>AnyMail/400 Mail Server Framework Developer Guide</cite>,
GG24-4449, focuses on the technical details needed to understand how the mail
server framework works. It provides information about how to write programs
that create MSF messages or act on MSF messages as MSF exit point programs.</p>
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center">
<a href="#Top_Of_Page">Top</a> |
<a href="off1.htm">Office APIs</a> |
<a href="aplist.htm">APIs by category</a></td>
</tr>
</table>
</center>
</body>
</html>