User manual AMX I!-EQUIPMENTMONITOR

[. . . ] instruction manual i!-EquipmentMonitor i n t e g ra t i o n !S o l u t i o n s Software Limited Agreement LIMITED WARRANTY LIMITED WARRANTY. AMX Corporation warrants that the SOFTWARE will perform substantially in accordance with the accompanying written materials for a period of ninety (90) days from the date of receipt. Any implied warranties on the SOFTWARE and hardware are limited to ninety (90) days and one (1) year, respectively. [. . . ] The friendly name of the sender (if one was supplied). A string containing the recipient's email address or addresses. The friendly name of the recipient if one was supplied. A string containing the data and time the email was sent. The names of the files attached. The subject and body are the items you need most in the structure. The count of file attachments tells you the total number of files attached but the cAttachments containing up to POP3_ATTACH_MAX (default is 5) file names. Only the file names are supplied for reference. Continued i!-EquipmentMonitor 5 Running i!-EquipmentMonitor You can use the following code to loop through the downloaded emails whenever new email arrives: DATA_EVENT[dvPop3Socket] { OFFLINE: { STACK_VAR INTEGER nLoop Integer nLoop1 For (nLoop=1;nLoop<=nPop3QtyMail;nLoop++) { SEND_STRING 0, 'i!Email Test-Print Message' SEND_STRING 0, ' ' SEND_STRING 0, "'Message #', Itoa(nLoop)" SEND_STRING 0, "'Date:', sPop3EmailMessage[nLoop]. cDate" SEND_STRING 0, "'From: "', sPop3EmailMessage[nLoop]. cFromPersonal, '" <', sPop3EmailMessage[nLoop]. cFrom, '>'" SEND_STRING 0, "'To: "', sPop3EmailMessage[nLoop]. cToPersonal, '" <', sPop3EmailMessage[nLoop]. cTo, '>'" SEND_STRING 0, "'Subject:', sPop3EmailMessage[nLoop]. cSubject" SEND_STRING 0, "'Message:', sPop3EmailMessage[nLoop]. cMessage" SEND_STRING 0, "'Attachments:', Itoa(sPop3EmailMessage[nLoop]. nAttachCount)" For (nLoop1=1;nLoop1<=sPop3EmailMessage[nLoop]. nAttachCount;nLoop1++) SEND_STRING 0, "'Attachment ', Itoa(nLoop1), ':', sPop3EmailMessage[nLoop]. cAttachments[nLoop1]" SEND_STRING 0, ' ' } } } Once the emails are processed, you can delete any emails you like by calling Pop3ClearEmailMessage () or Pop3ClearAllEmailMessages (). Pop3ClearEmailMessage allows you to delete one email at a time; Pop3ClearAllEmailMessages () allows you to delete all the emails at once. Configuring for Timezone The i!-EquipmentMonitorOut. axi file can read the time zone information from i!-TimeManager and includes this information in email and notifications. Simply include the i!-TimeManager moodule and make sure to name the i!-TimeManager virtual device 'vdvTmEvents'. The file 'i!-EquipmentMonitorTest with i!-TimeManager. axs' provides an example of using these two applications together. Using i!-TimeManager is recommended for use with i!-EquipmentMonitor since some email clients may improperly display the time when the email or notification was sent. i!-TimeManager provides i!-EquipmentMonitor with a universal time reference, including any Daylight Savings time offsets, and includes this information in the email or notification. The i!-TimeManager Module is not included with i!-EquipmentMonitor. To obtain the i!-TimeManager Module (i!-TimeManager. tko), please download the i!-TimeManager install from our web site. 6 i!-EquipmentMonitor Running i!-EquipmentMonitor i!-EquipmentMonitorOut. axi Constants The following table lists i!-EquipmentMonitorOut. axi constants. i!-EquipmentMonitorOut. axi Constants dvSmtpSocket SMTP_VERSION SMTP_PORT SMTP_SERVER_TO SMTP_URL_MAX SMTP_USER_MAX SMTP_LINE_MAX SMTP_MAX_EMAILS SMTP_MSG_MAX The IP device number for sending e-mails (default = 0:10:0}. IP Port that the SMTP server is listening on (default = 25). Timeout in 1/10 for contacting the SMTP server (default = 1200). Maximum length for e-mail server name (default = 1000). Maximum length for e-mail addresses (default = 500). Maximum length for date, subject and attached file (default = 256). Maximum length for number of queued e-mails (default = 10). Maximum length for e-mail message (default = 2000). Continued i!-EquipmentMonitor 7 Running i!-EquipmentMonitor Structures The following defines an i!-EquipmentMonitorOut. axi structure: Structure _sSMTPMessage { CHAR cDate[SMTP_LINE_MAX]; CHAR cSource[SMTP_USER_MAX]; CHAR cDest[SMTP_USER_MAX]; CHAR cSubject[SMTP_LINE_MAX]; CHAR cMessage[SMTP_MSG_MAX]; CHAR cFile[SMTP_LINE_MAX]; } Variable The following is an i!-EquipmentMonitorOut. axi variable: VOLATILE CHAR bSMTPDebug Set to 1 to enable debugging Functions The following are a list of i!-EquipmentMonitorOut. axi functions: i!-EquipmentMonitorOut. axi Functions SmtpQueMessage Call this to send an e-mail message. Syntax: SLONG SmtpQueMessage(CHAR Source[], CHAR Dest[], CHAR Subject[], CHAR Message[], CHAR File[]) SmtpQueMessage has these arguments: Source: Dest: Subject: Message: File: String containing the senders e-mail address. [. . . ] Syntax: SLONG Pop3ClearEmailMessage(Integer MsgNum) Pop3ClearEmailMessage has these arguments: MsgNum: The message number of the e-mail to be deleted. Pop3ClearEmailMessage returns these values: -1 and 0: Example: Pop3ClearEmailMessage(1) Remarks: Pop3ClearEmailMessage should be called when you want to delete a message from the internally stored e-mail list. Deleting an e-mail from the internally stored list will most likely affect message ordering. Pop3ClearEmailMessage updates nPop3QtyMail and nPop3TotalMail accordingly. This function does not delete an e-mail from the server. [. . . ]