OmniMessaging ZLE Adapter Programmer's Guide 6.2

OmniMessaging ZLE Mail Adapter Installation Guide
Opsol Confidential and Proprietary 9
Appendix
3.11 Header file - ADAPT.H
• All the supported IPC structures are defined in this file.
• Client applications have to include this header file in their source.
• This file is provided with the PAK file ZINSTALL.
Some sections of the header file are listed below.
/* Request types supported by Zle adapter */
typedef enum
{ OMNI_SEND = 0, /* To compose and send a message */
OMNI_GET, /* To retrieve a message based on the message Id or UID – attachments
as guardian files */
OMNI_DELETE, /* To delete a message based on the message Id or UID */
OMNI_LIST, /* To list details of maximum 10 messages from a mailbox */
OMNI_STORE,
OMNI_SEND_SMTP,
OMNI_GETOSS, /* To retrieve a message based on the message Id or UID – attachments
as OSS files */
OMNI_GETTEL, /* To retrieve a message along with header information based on the
message Id – attachments as guardian files */
OMNI_GET_ERR,
OMNI_FORWARD, /* To forward a message based on the message Id */
OMNI_GET_SEG,
OMNI_DEL_MSG
} OMNI_ReqType;
/* Return codes for the Pathsend */
typedef enum
{ OMNI_MSG_SEND_SUCCESS = 6000,
OMNI_MSG_SEND_FAIL,
OMNI_INVALID_REQUEST,
OMNI_MSG_GET_SUCCESS,
OMNI_MSG_GET_FAIL,
OMNI_MSG_DEL_SUCCESS,
OMNI_MSG_DEL_FAIL,
OMNI_MSG_LIST_SUCCESS,
OMNI_MSG_LIST_FAIL,
OMNI_MSG_GET_OSS_SUCCESS,
OMNI_MSG_GET_OSS_FAIL,
OMNI_MSG_GET_TEL_SUCCESS,
OMNI_MSG_GET_TEL_FAIL,
OMNI_MSG_SEND_SMTP_SUCCESS,
OMNI_MSG_SEND_SMTP_FAIL,
OMNI_MSG_GET_ERR_SUCCESS,
OMNI_MSG_GET_ERR_FAIL,
OMNI_MSG_FORWARD_SUCCESS,
OMNI_MSG_FORWARD_FAIL,
OMNI_MSG_NONEXISTENT,
OMNI_MSG_EXCEEDS_LIMIT,
OMNI_NONEXISTENT_RECIPIENT,
OMNI_MSG_ATTS_EXCEED_LIMIT,