AMX i!-EquipmentMonitor User Manual

Page 14

Advertising
background image

Running i!-EquipmentMonitor

10

i!-EquipmentMonitor

i!-EquipmentMonitorOut.axi Functions (Cont.)

SmtpSetUser

Call this to
configure the
username and
password for SMTP
server
authentication to send
outbound emails.

SmtpSetUser(CHAR LogInName[],CHAR LogInPass[])

SmtpSetUser has these arguments:

LogInNameString containing the username for the SMTP server.

LogInPassString containing the password for them STMP server.

SmtpSetUser doe not return any values.

Example:

SmtpSetUser ('MyUserName','MyPassword')

Remarks:

SmtpSetUser should be called to configure i!-EquipmentMonitor to send emails to an
SMTP server that required authentication.

EncrBase64Encode

This function is used
internally to encrypt the
username and
password for SMTP
server
authentication.

You should not have to call this function directly. To configure SMTP authentication,
please see the SmtpSetUser() function.

ConfigNotify

Sets your notification
paramaters for your
use.

Syntax:

ConfigNotify(CHAR Source[],CHAR Dest[],CHAR Subject[])

ConfigNotify has these arguments:

Source

String containing the senders email address.

Dest

String containing the recipients email address or addresses.

Subject

String containing the subject of the email.

ConfigNotify does not return a value.

Example:

ConfigNotify('[email protected]','[email protected]','Equipment

Notification Room 301')

Remarks:

ConfigNotify should be called in DEFINE_START of your application. You must also
call the SmtpSetServer Function.

The To parameter can contain multiple addresses separated by a ";".

SendNotify

Call this function to
send an equipment
notification.

Syntax:

SLONG SendNotify(CHAR Message[],CHAR File[])

SendNotify has these arguments:

Message

String containing the message body of the email.

File

String containing the ASCII (text) only file name to attach to the email.

SendNotify returns these values:

-1

If the message was not successfully queued for sending.

>0

If the message was successfully queued for sending.

Example:

SendNotify('The VCR needs to be cleaned.','')

Remarks:

SendNotify should be called if you want to send a notification. The To, From and
Subject used in the ConfigNotify function is included in the notification.

The file parameter is the path and file of an ASCII (text) only file contained on the
Master's file systems. This file is transmitted as an attachment.

Continued

Advertising