webadmin::SmtpRelay Interface Reference

Public Member Functions
void	get (out SmtpRelayConfig config)
void	set (in SmtpRelayConfig config)
void	test (out kerio::web::ErrorList errors, in SmtpRelayConfig config, in string address)
void	getStatus (out kerio::web::ErrorList errors)

Member Function Documentation

void webadmin::SmtpRelay::get

(

out SmtpRelayConfig

config

)

Returns SMTP Relay configuration

Exceptions

kerio::web::ApiException

-32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation."

void webadmin::SmtpRelay::getStatus

(

out kerio::web::ErrorList

errors

)

Returns result of last test call

Parameters

errors

- list of errors 1000 Operation failed. - "Unable to resolve IP address for the specified SMTP relay." 1000 Operation failed. - "Connection to SMTP relay is denied by Traffic rules." 1000 Operation failed. - "Connection to SMTP relay failed. Check hostname, authentication information and traffic rules." 1000 Operation failed. - "Connection to SMTP relay failed. Internal error."

Exceptions

kerio::web::ApiException

-32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation."

void webadmin::SmtpRelay::set

(

in SmtpRelayConfig

config

)

Stores SMTP Relay configuration

Exceptions

kerio::web::ApiException

-32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation."

void webadmin::SmtpRelay::test	(	out kerio::web::ErrorList	errors,
		in SmtpRelayConfig	config,
		in string	address
	)

Sends email and returns errors, empty errors means OK

Parameters

errors	- list of errors 1000 Operation failed. - "Unable to resolve IP address for the specified SMTP relay." 1000 Operation failed. - "Connection to SMTP relay is denied by Traffic rules." 1000 Operation failed. - "Connection to SMTP relay failed. Check hostname, authentication information and traffic rules." 1000 Operation failed. - "Connection to SMTP relay failed. Internal error."
config	- configuration structure of smtp relay module
address	- email address where to send testing message. Recipient.

Exceptions

kerio::web::ApiException

-32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation."

---

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

• SmtpRelay.idl