SendGatewayMessage
831
SendGatewayMessage
Description
Sends an outgoing message through a ColdFusion MX event gateway.
Returns
String. The value returned depends on the gateway type.
Category
Extensibility functions
Function syntax
SendGatewayMessage
(
gatewayID
,
data
)
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.
Summary of Contents for COLFUSION MX 7-CFML
Page 1: ...COLDFUSION MX7 CFML Reference...
Page 20: ...20 Chapter 1 Reserved Words and Variables...
Page 50: ...50 Chapter 2 ColdFusion Tags cfelse br Searching cfif cfloop cfif...
Page 101: ...cfdefaultcase 101 cfdefaultcase cfswitch cfoutput Your grade is grade cfoutput...
Page 115: ...cfdocumentsection 115 cfdocumentsection cfoutput cfdocument...
Page 411: ...cftable 411 cftable body html...
Page 515: ...Chr 515 maxlength 5 p input type Submit name input type RESET cfform...
Page 605: ...GetEncoding 605 WriteOutput The encoding is theEncoding cfscript cfif...
Page 629: ...GetProfileString 629 tr td input type Submit name Submit value Submit td td td tr table form...
Page 655: ...IIf 655 cfoutput IIf Hour Now GTE 12 DE It is afternoon or evening DE It is morning cfoutput b...
Page 664: ...664 Chapter 3 ColdFusion Functions cfelse h3 Conversion error h3 cfif...
Page 687: ...IsStruct 687 cfoutput cfquery cfif cfoutput hr Employee Add Complete cfoutput cfcase cfswitch...
Page 751: ...LSDateFormat 751 hr noshade cfoutput cfloop...
Page 861: ...StructFind 861 cfquery cfif cfoutput hr Employee Add Complete cfoutput cfcase cfswitch...
Page 903: ...Val 903 value Is the beginning numeric name form...
Page 932: ...932 Chapter 3 ColdFusion Functions...
Page 944: ...944 Chapter 4 ColdFusion MX Flash Form Style Reference...
Page 962: ...962 Chapter 5 Application CFC Reference...
Page 1054: ...1054 Chapter 6 ColdFusion MX Event Gateway Reference...