Send IM (Instant Message)

Declaration

<AMSENDIM SERVICE="text (options)" USERNAME="text"  PASSWORD="text (encrypted)" TO="text">Text (The Message to Send)</AMSENDIM>

See Also

Exchange | Execute Web Service | Get Email | HTTP Get | HTTP Post/Put | Map Drive | MSMQ | Send E-mail | Send IM | Twitter

Description

Sends an IM (Instant Message) via Windows Live Messenger, Yahoo Messenger, AIM, Google Talk or ICQ. This action automates three operations; the login, message transmission and logoff process.

Practical Usage

Enhances instant messaging by allowing automated messages to be sent upon schedule or when a particular event or condition takes place on the system. In a business standpoint, instant messaging is essentially the text version of a phone call. Organizations that work in groups, teams or on projects may prefer IM over e-mail because it can be used to share vital information between teammates or group/project members in real-time.

Parameters

General Properties

Property

Type

Req'd

Default

Markup

Description

Service

Text (options)

Yes

Windows Live Messenger

SERVICE="yahoo"

The instant messaging service that this action will use to send the message. You must have a valid IM account registered with the specified service. The available services are:

  • Windows Live Messenger (default)

  • Yahoo Messenger

  • AIM

  • Google Talk

  • ICQ

Username

Text

Yes

(Empty)

TIMEOUT="2"

The username of the IM account used to send the message.

Password

Text

Yes

(Empty)

MEASURE="minutes"

The password of the IM account in which to authenticate with.

Recipient Account

Text

Yes

(Empty)

TO="theAccountID"

The recipient that this action will send an instant message to. This can be an account ID, account name, email address or other valid form of identification that the selected IM service allows. Press the Load button to load the list of recipients for the selected service.

Message

Text

No

(Empty)

.....>The Message</AMSENDIM>

The message body to send.

Delay (seconds)

Number

No

5

DELAY="7"

This action combines three procedures; the login, message transmission and logoff process. The Delay parameter indicates the amount of delay time to set for this action to ensure that proper login, IM transmission and logoff occurs. The default value is 5 seconds, which means that a 5 second delay will occur between login and IM transmission and another 5 second delay will occur after transmission and before logoff, totalling 10 seconds.

NOTE: To ensure reliability, the lowest recommended value should be 2 seconds.

Check Port

Yes/No

No

No

CHECKPORT="no"

In order to connect to a specific IM service, you'll need to enable TCP connections on specific ports. If this parameter is set to YES, AutoMate will verify the status of the port used by the specified IM service, and if blocked, will properly display a "Port must be allowed" error message. If set to NO, port checking is bypassed, speeding up execution. However, if the associated port is blocked, AutoMate may unexpectedly freeze or crash, at which point,  no error message is displayed. This parameter is set YES by default. The default ports used by each service are as follows:   

  • Windows Live Messenger - 1863

  • ICQ -  5190

  • AIM = 5190

  • Yahoo Messenger - 5050

  • GoogleTalk Port1 - 5222

  • GoogleTalk Port2 - 5223

NOTE: HTTP/HTTPS ports also need to be open in order for this action to work. Port 80 is most often used by HTTP and port 443 by HTTPS.

Description Properties

The Description tab allows you to customize the text description of any step as it appears in the Task Builder's Steps Pane.

More on setting custom step description

Error Causes Properties

The Error Causes tab properties lets you instruct a task step to react only to specific errors or ignore certain errors that should cause it to fail.

More on Error Causes properties

On Error Properties

The On Error tab properties lets you determine what the task should do if a particular step encounters an error as defined in the Error Causes properties.

More about On Error properties

Additional Notes

Expressions, Variables & Functions

A percent sign is used as a special character in AutoMate to indicate the beginning and end of an expression. This allows variables, functions and other expressions to be entered in any text parameter of a task's properties. For example: %1+1% inside a task will resolve to 2 at runtime. A more elaborate example is %FileDateTime(myFile)% which results to the date/time of myFile. To help construct expressions, you can open Expression Builder by clicking the Insert Expression (%) button or by pressing F2.

More on expressions

More on variables

More on functions

More on extended functions
More on the expression builder

Example

NOTE: The code below can be copied and pasted directly into the Steps pane of the Task Builder.

 

Description: Send message "The Message" to "theAccountID" using Windows Live Messenger.

 

<AMSENDIM SERVICE="aim" USERNAME="theUser" PASSWORD="AM1CznaRue2JCdyhHCv59LCBw==aME" TO="theAccountID" DELAY="10">The Message to Send</AMSENDIM>

 

 

Description: Send message "This is the message body." to "theRecipient@domain.com" on "Windows Live Messenger". Port checking is bypassed.

 

<AMSENDIM USERNAME="user@domain.com" PASSWORD="AM2ooXWPhaeg5OihdM+ZZ7nlw==aME" TO="theRecipient@domain.com" DELAY="10" MESSAGE="This is the message body." CHECKPORT="no" />