Legrand / Raritan / Server Technology Xerus™ JSON-RPC API
Loading...
Searching...
No Matches
Classes | Public Member Functions | Public Attributes | List of all members
devsettings::Smtp Interface Reference

SMTP settings interface. More...

Classes

struct  Configuration
 SMTP server configuration. More...
 
struct  TestResult
 Result of SMTP configuration test. More...
 

Public Member Functions

Configuration getConfiguration ()
 Retrieve the SMTP server configuration. More...
 
int setConfiguration (in Configuration cfg)
 Set the SMTP server configuration. More...
 
TestResult testConfiguration (in Configuration cfg, in vector< string > recipients)
 Test an SMTP server configuration. More...
 

Public Attributes

constant int ERR_INVALID_PARAMS = 1
 Invalid parameters. More...
 

Detailed Description

SMTP settings interface.

Definition at line 12 of file Smtp.idl.

Member Function Documentation

◆ getConfiguration()

Configuration devsettings::Smtp::getConfiguration ( )

Retrieve the SMTP server configuration.

Returns
SMTP server configuration

◆ setConfiguration()

int devsettings::Smtp::setConfiguration ( in Configuration  cfg)

Set the SMTP server configuration.

Parameters
cfgNew SMTP server settings
Returns
0 if OK
1 if any parameters are invalid

◆ testConfiguration()

TestResult devsettings::Smtp::testConfiguration ( in Configuration  cfg,
in vector< string >  recipients 
)

Test an SMTP server configuration.

The active server configuration is not changed.

Parameters
cfgSMTP server settings to test
recipientsRecipient email addresses
Returns
Result of configuration test

Member Data Documentation

◆ ERR_INVALID_PARAMS

constant int devsettings::Smtp::ERR_INVALID_PARAMS = 1

Invalid parameters.

Definition at line 14 of file Smtp.idl.


The documentation for this interface was generated from the following file: