User Guide

SendGatewayMessage 831

SendGatewayMessage

Description

Sends an outgoing message through a ColdFusion MX event gateway.

Returns

String. The value returned depends on the gateway type.

See also

GetGatewayHelper

; “IM gateway message sending commands”, “SMS Gateway CFEvent

structure and commands”, “CFML event gateway SendGatewayMessage data parameter”, and

“Sending a message using the SendGatewayMessage function” in Chapter 42, “Using Event

Gateways,” in ColdFusion MX Developer’s Guide

History

ColdFusion MX 7: Added this function.

Parameters

Usage

The SendGatewayMessage function calls the specified gateway’s outgoingMessage method. The

value returned by the function depends on the gateway type. The following table describes the

return values for standard ColdFusion MX gateway types:

Parameter Description

gatewayID Identifier of the gateway to send the message. Must be the Gateway ID of one of

the ColdFusion event gateway instances configured on the ColdFusion MX

Administrator Event Gateways section’s Gateways page.

data A ColdFusion structure. The contents of the structure depend on the event

gateway type, but typically include a MESSAGE field that contains the message to

send and a field that contains the destination address.

Gateway type Return values

Asynchronous CFML If the message was queued for delivery to the CFC, returns True; False,

otherwise.

Lotus SameTime If the message or command was successful, returns OK.

If an error occurred, returns a string indicating the cause.