Echelon i.LON SmartServer 2.0 - Manual (Page 317)

i.LON SmartServer 2.0 Programmer’s Reference 19-17
<UCPTstate> This property specifies whether to start a test or
get the current status of the test. This property
may be set to one of the following values:
• ST_BEGIN. Starts the test.
• ST_STATUS. Returns the status of the test.
Required
<UCPTemailAddress> A string specifying the e-mail address to where
the test e-mail will be sent. Optional
<UCPToriginator> A string specifying the originator of the e-mail
message. Optional
<UCPTemailSubject> A string specifying the subject line of the test
e-mail message. Optional
<UCPTemailFormat> A string specifying the text of the test e-mail
message. Note that you may not include flags
such as those used by the Alarm Notifier
application. Optional
<UCPTemailAttachment> A string specifying a full path on the SmartServer
flash disk of a file to be attached to the test e-mail
message such as “/root/AlarmLog/sumlog1.csv”
if you were attaching an alarm log. Optional
UCPTcount This property specifies the number of times the
e-mail message will be sent. Optional
Note: If you are checking the status of a test (<UCPTstate> is set to ST_STATUS), you only need to
provide the <UCPTTestType> and <UCPTstate> properties.
The following examples demonstrate how to use the SystemService_Test function to test that the
default SMTP e-mail server can send out e-mail messages and check the status of the test:
Request (test the SMTP e-mail server)
<SystemService_Test xmlns="http://wsdl.echelon.com/web_services_ns/ilon100/v4.0/message/">
<iLONSystemService>
<Test>
<UCPTtestType>SMTP_TEST</UCPTtestType>
<UCPTstate>ST_BEGIN</UCPTstate>
<UCPTemailAddress>[email protected]</UCPTemailAddress>
<UCPToriginator>sender</UCPToriginator>
<UCPTemailSubject>This is a test</UCPTemailSubject>
<UCPTemailFormat></UCPTemailFormat>
<UCPTemailAttachment></UCPTemailAttachment>
</Test>
</iLONSystemService>
</SystemService_Test>
Request (check the status of the SMTP e-mail server test)
<SystemService_Test xmlns="http://wsdl.echelon.com/web_services_ns/ilon100/v4.0/message/">
<iLONSystemService>
<Test>
<UCPTtestType>SMTP_TEST</UCPTtestType>
<UCPTstate>ST_STATUS</UCPTstate>
</iLONSystemService>
</SystemService_Test>