AMX i!-EquipmentMonitor - Manual (Page 16)

Running i!-EquipmentMonitor
12 i!-EquipmentMonitor
Functions
The following table lists i!EmailIn.axi functions.
i!-EquipmentMonitorIn.axi Functions
Pop3ClearAllEmail
Messages
Deletes all e-mails
from the internally
stored email list.
Syntax:
Pop3ClearAllEmailMessages()
Pop3ClearAllEmailMessages has no arguments.
Example:
Pop3ClearAllEmailMessages()
Remarks:
Pop3ClearAllEmailMessages should be called when you want to delete all
messages from the internally stored e-mail list. Pop3ClearAllEmailMessages
updates nPop3QtyMail and nPop3TotalMail accordingly. This function does not
delete e-mails from the server.
Pop3ClearEmail
Message
Deletes an e-mail
from the internally
stored e-mail list.
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: If the MsgNum is invalid the e-mail was deleted successfully.
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.
Pop3GetEmail
Retrieves e-mail
from the server.
Syntax:
Pop3GetEmail(CHAR Delete)
Pop3GetEmail has these arguments:
Delete: 1 or 0. 1 will delete all e-mails from the server as they are retrieved; 0 will
leave all e-mails on the server.
Example:
Pop3GetEmail(1)
Remarks:
Pop3GetEmail should be called when you want to manually force the retrieval of e-mail
from the server. By default, it is not retrieved from the server automatically, and calling
Pop3GetEmail
is the only way to retrieve e-mail. If you have called Pop3SetRefresh
to enable automatical e-mail retrieval, calling Pop3GetEmail also resets the timer so
e-mail will not be retrieved again until the current refresh time has expired.