Raritan PX2/PX3 JSON-RPC API
Smtp.idl
1 
4 module devsettings {
5 
7  interface Smtp_2_0_0 {
8 
9  constant int ERR_INVALID_PARAMS = 1;
10 
12  structure Configuration {
13  string host;
14  int port;
15  boolean useTls;
17  string caCertChain;
18  string sender;
19  boolean useAuth;
20  string username;
21  string password;
22  int retryCount;
24  };
25 
31  Configuration getConfiguration();
32 
41  int setConfiguration(in Configuration cfg);
42 
44  structure TestResult {
45  int status;
46  string message;
47  };
48 
58  TestResult testConfiguration(in Configuration cfg, in vector<string> recipients);
59 
60  };
61 
62 }
int retryCount
Number of attempts at sending the email.
Definition: Smtp.idl:22
int retryInterval
Sending retry interval in minutes.
Definition: Smtp.idl:23
int status
Status code; 0 if OK.
Definition: Smtp.idl:45
boolean useAuth
SMTP server requires authentication.
Definition: Smtp.idl:19
string caCertChain
TLS CA certificate chain.
Definition: Smtp.idl:17
Result of SMTP configuration test.
Definition: Smtp.idl:44
Device Settings.
Definition: Modbus.idl:4
string password
Password; write-only, empty to leave unchanged.
Definition: Smtp.idl:21
string message
Status message.
Definition: Smtp.idl:46
SMTP settings interface.
Definition: Smtp.idl:7
string host
SMTP server host name or IP address.
Definition: Smtp.idl:13
SMTP server configuration.
Definition: Smtp.idl:12
string sender
Sender email address.
Definition: Smtp.idl:18
string username
Authentication user name.
Definition: Smtp.idl:20
boolean allowOffTimeRangeCerts
allow expired and not yet valid TLS certificates
Definition: Smtp.idl:16
int port
SMTP server port.
Definition: Smtp.idl:14
boolean useTls
Enforce TLS usage.
Definition: Smtp.idl:15