Message Transfer System Interface

script cmts.cpl

interface MTS

COM progId Carapace.MTS

script	`cmts.cpl`
interface	`MTS`
COM progId	`Carapace.MTS`

The MTS interface provides access to the message transfer system for sending messages to local or remote users. The MTS delivers messages directly into message stores for local users and queues messages for delivery to remote MTAs (message transfer agents).

MTS Creation

An MTS is created by using the create function eg.

    (create MTS ms)

where ms is a MessageStore object.

MTS Properties

property name property type description

errorClass Integer (read-only) the error class for MTS errors

queueId String (read-only) identifier for the MTA queue currently being used

remoteMTA String (read-only) name for the remote MTA currently being accessed

addressType String (read-only) type of addressing understood by this MTA

retryInterval Integer (read-only) interval (minutes) between retrying connections to this MTA

warnInterval Integer (read-only) interval (minutes) when warnings are sent if the MTA cannot be contacted

expiryInterval Integer (read-only) interval (minutes) when undeliverable messages to this MTA are expired

log Log log for the transfer sessions

property name	property type	description
`errorClass`	Integer	(read-only) the error class for MTS errors
`queueId`	String	(read-only) identifier for the MTA queue currently being used
`remoteMTA`	String	(read-only) name for the remote MTA currently being accessed
`addressType`	String	(read-only) type of addressing understood by this MTA
`retryInterval`	Integer	(read-only) interval (minutes) between retrying connections to this MTA
`warnInterval`	Integer	(read-only) interval (minutes) when warnings are sent if the MTA cannot be contacted
`expiryInterval`	Integer	(read-only) interval (minutes) when undeliverable messages to this MTA are expired
`log`	Log	log for the transfer sessions

MTS Methods

method name description

queue use the supplied queue to a remote MTA

mtaQueues list the queues for the given remote MTA

submit submit a message to the MTS for delivery to the supplied recipients

transferQueue transfer all queued messages to the remote MTA -- returns the no. of messages transferred

isLocal determine if the recipient is local<

method name	description
`queue`	use the supplied queue to a remote MTA
`mtaQueues`	list the queues for the given remote MTA
`submit`	submit a message to the MTS for delivery to the supplied recipients
`transferQueue`	transfer all queued messages to the remote MTA -- returns the no. of messages transferred
`isLocal`	determine if the recipient is local<

`queue`

Use the supplied queue to a remote MTA. The queue details are retrieved from the database. The name of the MTA is returned.

Arguments:

queueId String

Return type: String

`mtaQueues`

List the queues for the given remote MTA.

Arguments:

mtaName String

Return type: List

`submit`

Submit a message to the MTS for delivery to the supplied recipients. The message store interface is used for local recipients, otherwise the remote MTA is used for onward delivery.

A delivery identifier is returned.

Arguments:

sender String

recipients String

msg Object

Return type: String

`transferQueue`

Transfer all queued messages to the remote MTA -- returns the no. of messages transferred.

Arguments: none

Return type: Integer

`isLocal`

Determine if the recipient is local. The empty List () is returned if the recipient is not local.

Arguments:

recipient String

Return type: Object

Contents Index Current topic: audit Related topics: databases