OmniMessaging ZLE Adapter Programmer's Guide 6.2

OmniMessaging ZLE Mail Adapter Installation Guide
Opsol Confidential and Proprietary 3
1 INTRODUCTION
The purpose of this document is to help a programmer to write servers to use the
OmniMessaging ZLE Adapter to send mails to the outside world or to retrieve mails
from the Omni message store. The invoking application is expected to do one
pathway Server Class Send to the OmniMessaging Zle Adapter server class to send
or retrieve a message.
The Zle Adapter is a Pathway server, accepting Serverclass Send requests. The DDL
schemas of the IPCs are provided so that any application running on NonStop
Himalaya system can invoke it. In other words, the Zle Adapter interface supports
requests from all COBOL, C, Java, Tal, pTal, and Tuxedo etc applications.
Along with sending mails to outside world, Zle Adapter is also capable of retrieving
messages with attachments and creates guardian files for attachments. These files
can be later used for business processing. Messages less than 32K are sent via the
Serverclass Send memory buffer. Depending upon the Serverclass Send request
type, it also retrieves/sends messages using memory segments and avoids
reading/writing to guardian files. The Zle Adapter also retrieves header information
from a message.
2 Prerequisite
Please refer to OmniMessaging Installation Guide for the installation of Zle Adapter.
For latest copy please visit http://www.zlemail.com/
3 Functionalities Supported with ZleAdapter
OmniMessaging is a pathway application with the default process name $OMNI1. Zle
Adapter is a server class within this pathway environment. It is configured with
default name ZLE01-SRV. Any application can invoke Zle Adapter with a simple
Serverclass Send request.
Based on the type of request to be made, entity structures like OMNI_sendMessage
OMNI_getMessage etc. can be used in a SERVERCLASS_SEND_ call to Zle Adapter.
Following is a brief explanation of how the requests can be sent to Zle Adapter and
what are the responses received.
3.1 General outline
The IPC structures used to send SERVERCLASS_SEND_ requests to the Zle Adapter
are defined in the header file ADAPT.H provided with the installation PAK file. The
IPC has following structure:
Header: This consists of OMNI_ReqType and ADAPT_ReturnCode. The request_type
defines the type of request like OMNI_SEND, OMNI_GET, OMNI_DELETE etc. The
returnCode defines the result of the server class send operation like
OMNI_MSG_SEND_SUCCESS, OMNI_MSG_SEND_FAIL etc.