Init.idl

/**
 * @file   init.idl
 * @brief  Initial configuration of Kerio Connect after installation.
 *
 * @author Miroslav Kroc
 *
 * @copyright Copyright © 2017 Kerio Technologies s.r.o.
 */

#import <kerio/web/idl/SharedStructures.idl>
#import <common.idl>
#import <AdminStructures.idl> // DirectoryAccessResult, DirectoryList
#import <DistributedDomain.idl> 


module kerio {
module jsonapi {
module admin {

interface Init {

   /**
    * Returns FQDN (fully qualified domain name) of the server (e.g. mail.companyname.com).
    *
    * @param hostname - name of the server
    */
   void getHostname(out string hostname);

   /**
    * Check existence of domain name in the DNS. Existence of DN record with type "A" in appropriate DNS zone.
    *
    * @param hostname - fully qualified domain name of the server
    */
   void checkHostname(in string hostname);

    /**
     * Check existence of MX record in the DNS for specified domain.
     *
     * @param domainName - fully qualified domain name
     */
   void checkMxRecord(in string domainName);

   /**
    * Set Internet hostname of the server. This name is used for server identification in SMTP, POP3 and similar protocols.
    *
    * @param hostname - new fully qualified domain name of the server
    */
   void setHostname(in string hostname);

   /**
    * Retrieve domains, which can be distributed, from the master server as a standalone server.
    *
    * @param domainNames - List of domains which can be distributed (they have a directory service set).
    * @param authentication - Structure with a credential. Credential will be used when connected is false.
    */
   void getDistributableDomains(out kerio::web::StringList domainNames, in ClusterAuthentication authentication);

   /**
    * Connect server to cluster as slave and create distributable domain.
    *
    * @param result - if ClusterErrorType is not clSuccess, error argument contains additional error info
    * @param domainName - domain which can be distributed (they have a directory service set) and exist on master server.
    * @param authentication - Structure with a credential. Credential will be used when connected is false.
    */
   void createDistributableDomain(out ClusterError result, in string domainName, in ClusterAuthentication authentication);
   
   /**
    * Creates the primary email domain.
    *
    * @param domainName - fully qualified name of the domain
    */
   void createPrimaryDomain(in string domainName);

   /**
    * Creates the administrator account. This account will be created in primary domain.
    *
    * @param loginName - login name for administrator (without domain name)
    * @param password - administrator password
    */
   void createAdministratorAccount(in string loginName, in string password);

   /**
    * Get current path to message store. Default path is "store" subdirectory in installation directory.
    *
    * @param path - full path to message store directory
    * @param freeSpace - amount of free space in the directory
    */
   void getMessageStorePath(out string path, out LongNumber freeSpace);

   /**
   * Set path to message store directory.
   *
   * @param path - full path to message store directory
   */
   void setMessageStorePath(in string path);

   /**
    * Obtain a list of directories in a particular path.
    *
    * @param dirList - List of directories
    * @param fullPath - directory for listing, if full path is empty logical drives will be listed
   */
   void getDirs(out DirectoryList dirList, in string fullPath);

   /**
    * Check if message store path is correct and can be created in the file system.
    *
    * @param result - result of the check
    * @param freeSpace - amount of free space in the directory
    * @param path - full path to message store directory
    */
   void checkMessageStorePath(out DirectoryAccessResult result, out LongNumber freeSpace, in string path);
   
   /**
    * Set client statistics settings.
    *
    * @param isEnabled - flag if statistics are enabled
    */
   void setClientStatistics(in boolean isEnabled);

   /**
    * Finish initial configuration of Kerio Connect.
    */
   void finish();

   /**
    * Server side list of constants.
    *
    * @param constants - list of constants
    */
   void getNamedConstantList(out NamedConstantList constants);

   /**
    * Returns a list of user-preferred languages set in browser.
    *
    * @param calculatedLanguage - a list of 2-character language codes
    */
   void getBrowserLanguages(out kerio::web::StringList calculatedLanguage);

   /**
    * Get basic information about product and its version.
    *
    * @param info - structure with basic information about product
    */
   void getProductInfo(out ProductInfo info);

   /**
    * Obtain EULA.
    *
    * @param content - plain text of EULA
    */
   void getEula(out string content);
};

}; }; };//end of namespace