API Routine Descriptions



TABLE 1 - Message Enqueue API
Message Enqueue API
Description
imme_init

Begin a message enqueue context.

imme_end

Close an enqueue context.

imme_add_recipient Specify an Envelope and/or header To:, Cc:, and Bcc: address

imme_write_header

Output a header structure into a meesage being enqueued

imme_write_text Output a text string to the message header or body
imme_enqueue End the message and enqueue it; dispose of the message enqueue context
imme_start_envelope Start a new message; specify teh envelope From: address
imme_copy Copy the queued message to a new message being enqueued
imme_abort Abort a message and dispose of the message enqueue context


TABLE 2 - Message Dequeue API
Message Dequeue API

Description

immd_init Prepare for one or more message dequeues; create a dequeue context
immd_end

Dispose of a message dequeue context

immd_get_message start processing the next message to dequeue.
immd_get_recipient Read the next envelope To: address
immd_read_header

Read the header of a message

immd_read_text Read a line from a message; line feed record terminator is not stripped by API
immd_mime_decode Decode the message as a MIME multipart message.
immd_read_failure_log Read a line from the message delivery failure log, if present
immd_rewind Go back to the start of the message header
immd_dequeue Remove a message from the message queue
immd_defer Defer a message for later reprocessing
immd_return Sends a delivery status notification for the message.
immd_return_add_entry Generates a delivery status for one recipient


TABLE 3 - Address Parsing API
Address Parsing API
Description
imadr_parse_list Parse a list of addresses producing an address context
imadr_get Extract an individual address from a list of parsed addresses
imadr_get_property Extract a property of an individual address from a list of parsed addresses
imadr_free Dispose of an address context
imadr_parse_one Parse an address and return the specified property


TABLE 4 -   Message Header API
Message Header API
Description
imhdr_add_line Add one header line to a header structure. Creates the header structure if necessary
imhdr_get_line Extract a header line from a header
imhdr_delete_line Remove a header line from a header
imhdr_free_line Free a header line
imhdr_free Free a header object
imhdr_alloc Allocate a header object


TABLE 5 - IMTA management API
IMTA management API
Description
imta_init Initialize the MTA
imta_end Deallocate SIMS data structures and resources
imta_get_date Obtain the current date and time
imta_parse_date Parse a valid RFC 1123 date
imta_get_hostname Obtain the official local host name
imta_debug Write a line of text to a channel log file
imta_set_debug Set enqueue and dequeue debugging flags
imctr_load Load channel counters
imctr_get Obtain specific channel counters
imctr_free Dispose of a list of channel counters





Copyright © 1999 Sun Microsystems, Inc. All Rights Reserved.