Sun Java System Messaging Server 6 2005Q4 MTA Developer's Reference

Summary of SDK Routines

This sections contains a series of tables, one for each of the following logical groups of commands:

Each table lists the routines that comprise the group and gives a brief description of each.

Address Parsing

Address parsing routines are used to parse and extract message addresses.

Routine Name  

Description  

mtaAddressFinish()

Dispose of an address context 

mtaAddressGetN()

Extract the Nth individual address from a list of parsed addresses 

mtaAddressParse()

Parse a list of addresses, producing an address context 

Dequeue

Dequeue routines are used for dequeuing messages.

Routine Name  

Description  

mtaDequeueInfo()

Obtain information about a queued message 

mtaDequeueLineNext()

Obtain the next message line from a queued message 

mtaDequeueMessageFinish()

Complete or cancel a message dequeue 

mtaDequeueRecipientDisposition()

Set the disposition of a recipient address 

mtaDequeueRecipientNext()

Obtain the next recipient address from a queued message 

mtaDequeueRewind()

Move the read point for a queued message back to the start of its outermost header 

mtaDequeueStart()

Begin processing queued messages 

mtaDequeueThreadId()

Return the thread ID associated with the specified dequeue context. 

Enqueue

Enqueue routines are used for enqueuing messages.

Routine Name  

Description  

mtaEnqueueCopyMessage()

Copy a message from a dequeue context 

mtaEnqueueFinish()

Complete or cancel a message submission 

mtaEnqueueInfo()

Obtain information about a message submission 

mtaEnqueueStart()

Begin a message submission 

mtaEnqueueTo()

Add recipients to a message 

mtaEnqueueWrite()

Output a line to the message header or body 

mtaEnqueueWriteLine()

Output a line to the message header or body 

Error Handling

Error handling routines used for error status retrieval.

Routine Name  

Description  

mtaErrno()

Obtain the value of the last error status for this thread 

mtaStrError()

Map an error status code to a printable string 

Initialization

These routines are used for initialization.

Routine Name  

Description  

mtaDone()

Release resources used by the MTA SDK 

mtaInit()

Initialize the MTA SDK 

Logging and Diagnostics

Logging and diagnostics routines are used to write diagnostic messages to debug log files.

Routine Name  

Description  

mtaDebug()

Write internal diagnostic information to the debug log file 

mtaLog()

Write to the debug log file 

mtaLogv()

Write to the debug log file 

MIME Parsing and Decoding

These routines are used to parse and decode a MIME formatted message.

Routine Name  

Description  

mtaDecodeMessage()

Decode a MIME formatted message; can also convert non-MIME formats to MIME 

mtaDecodeMessagePartCopy()

Copy a message part 

mtaDecodeMessagePartDelete()

Delete a message part 

mtaDecodeMessageInfoInt()

Obtain the value of an integer-valued parameter 

mtaDecodeMessageInfoString()

Obtain the value of a string-valued parameter 

mtaDecodeMessageInfoParams()

Obtain the Content-type or Content-disposition parameter list

Miscellaneous

These routines are used for miscellaneous tasks.

Routine Name  

Description  

mtaAccountingLogClose()

Close the MTA accounting log file 

mtaAddressToChannel()

Determine which channel an address rewrites to 

mtaBlockSize()

Obtain the value of the MTA BLOCK_SIZE option

mtaChannelGetName()

Obtain the channel name for the running program 

mtaChannelToHost()

Determine the host name associated with a channel 

mtaDateTime()

Generate a date-time string for use in an RFC 822 Date: header line

mtaPostmasterAddress()

Obtain the postmaster’s address 

mtaStackSize()

Obtain the minimum thread stack size needed for arbitrary SDK operations 

mtaUniqueString()

Generate a unique string 

mtaVersionMajor()

Obtain the major version number of the MTA SDK 

mtaVersionMinor()

Obtain the minor version number of the MTA SDK 

mtaVersionRevision()

Obtain the revision number of the MTA SDK 

Option File Processing

The following table lists the routines used to process option files and gives a brief description of each.

Routine Name  

Description  

mtaOptionStart()

Open and read a channel option file 

mtaOptionInt()

Obtain the value associated with an integer-valued option 

mtaOptionFloat()

Obtain the value associated with a real-valued option 

mtaOptionString()

Obtain the value associated with a string-valued option 

mtaOptionFinish()

Dispose of an option file context