SmtpRelay.idl

Go to the documentation of this file.

/**
 * @file     SmtpRelay.idl
 * @brief    API for Smtp relay
 * @version  3
 */

#import <common.idl>

module webadmin {
 
struct SmtpRelayConfig {
   boolean useKManager;
   string server;

   boolean requireSecureConnection;
   boolean authenticationRequired;
   CredentialsConfig credentials;

   kerio::web::OptionalString fromAddress;
};

interface SmtpRelay {

   /**
    * Returns SMTP Relay configuration
    *
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired. - "The user is not logged in." \n
    *          1004  Access denied.   - "Insufficient rights to perform the requested operation."
    */
   void get(out SmtpRelayConfig config);

   /**
    * Stores SMTP Relay configuration
    *
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired. - "The user is not logged in." \n
    *          1004  Access denied.   - "Insufficient rights to perform the requested operation."
    */
   void set(in SmtpRelayConfig config);

   /**
    * Sends email and returns errors, empty errors means OK
    * @param  errors - list of errors \n
    *          1000  Operation failed.   - "Unable to resolve IP address for the specified SMTP relay." \n
    *          1000  Operation failed.   - "Connection to SMTP relay is denied by Traffic rules." \n
    *          1000  Operation failed.   - "Connection to SMTP relay failed. Check hostname, authentication information and traffic rules." \n
    *          1000  Operation failed.   - "Connection to SMTP relay failed. Internal error."
    * @param config - configuration structure of smtp relay module
    * @param address - email address where to send testing message. Recipient.
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired. - "The user is not logged in." \n
    *          1004  Access denied.   - "Insufficient rights to perform the requested operation."
    */
   void test(out kerio::web::ErrorList errors, in SmtpRelayConfig config, in string address);

   /**
    * Returns result of last test call
    * @param  errors - list of errors \n
    *          1000  Operation failed.   - "Unable to resolve IP address for the specified SMTP relay." \n
    *          1000  Operation failed.   - "Connection to SMTP relay is denied by Traffic rules." \n
    *          1000  Operation failed.   - "Connection to SMTP relay failed. Check hostname, authentication information and traffic rules." \n
    *          1000  Operation failed.   - "Connection to SMTP relay failed. Internal error."
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired. - "The user is not logged in." \n
    *          1004  Access denied.   - "Insufficient rights to perform the requested operation."
    */
   void getStatus(out kerio::web::ErrorList errors);
};

}; //webadmin