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 routines are used to parse and extract message addresses.
Routine Name |
Description |
---|---|
Dispose of an address context |
|
Extract the Nth individual address from a list of parsed addresses |
|
Parse a list of addresses, producing an address context |
Dequeue routines are used for dequeuing messages.
Routine Name |
Description |
---|---|
Obtain information about a queued message |
|
Obtain the next message line from a queued message |
|
Complete or cancel a message dequeue |
|
Set the disposition of a recipient address |
|
Obtain the next recipient address from a queued message |
|
Move the read point for a queued message back to the start of its outermost header |
|
Begin processing queued messages |
|
Return the thread ID associated with the specified dequeue context. |
Enqueue routines are used for enqueuing messages.
Routine Name |
Description |
---|---|
Copy a message from a dequeue context |
|
Complete or cancel a message submission |
|
Obtain information about a message submission |
|
Begin a message submission |
|
Add recipients to a message |
|
Output a line to the message header or body |
|
Output a line to the message header or body |
Error handling routines used for error status retrieval.
Routine Name |
Description |
---|---|
Obtain the value of the last error status for this thread |
|
Map an error status code to a printable string |
These routines are used for initialization.
Routine Name |
Description |
---|---|
Release resources used by the MTA SDK |
|
Initialize the MTA SDK |
Logging and diagnostics routines are used to write diagnostic messages to debug log files.
Routine Name |
Description |
---|---|
Write internal diagnostic information to the debug log file |
|
Write to the debug log file |
|
Write to the debug log file |
These routines are used to parse and decode a MIME formatted message.
Routine Name |
Description |
---|---|
Decode a MIME formatted message; can also convert non-MIME formats to MIME |
|
Copy a message part |
|
Delete a message part |
|
Obtain the value of an integer-valued parameter |
|
Obtain the value of a string-valued parameter |
|
Obtain the Content-type or Content-disposition parameter list |
These routines are used for miscellaneous tasks.
Routine Name |
Description |
---|---|
Close the MTA accounting log file |
|
Determine which channel an address rewrites to |
|
Obtain the value of the MTA BLOCK_SIZE option |
|
Obtain the channel name for the running program |
|
Determine the host name associated with a channel |
|
Generate a date-time string for use in an RFC 822 Date: header line |
|
Obtain the postmaster’s address |
|
Obtain the minimum thread stack size needed for arbitrary SDK operations |
|
Generate a unique string |
|
Obtain the major version number of the MTA SDK |
|
Obtain the minor version number of the MTA SDK |
|
Obtain the revision number of the MTA SDK |
The following table lists the routines used to process option files and gives a brief description of each.
Routine Name |
Description |
---|---|
Open and read a channel option file |
|
Obtain the value associated with an integer-valued option |
|
Obtain the value associated with a real-valued option |
|
Obtain the value associated with a string-valued option |
|
Dispose of an option file context |