AdvancedOptions.idl

Go to the documentation of this file.

/**
 * @file   AdvancedOptions.idl
 * @brief  Set custom options for store directories, fulltext search, webmail, security policy, software updates, master authentication, http proxy.
 *
 * @author Dusan Juhas, Frantisek Boranek
 *
 * @copyright Copyright © 2017 Kerio Technologies s.r.o.
 */

#import <kerio/web/idl/SharedStructures.idl>
#import <AdminStructures.idl> //DistanceOrNull

module kerio {
module jsonapi {
module admin {

struct MiscellaneousOptions {
   boolean logHostNames;            ///< Log hostnames for incoming connections
   boolean showProgramNameAndVersion;  ///< Show program name and version in network communication for non-authenticated users
   boolean insertXEnvelopeTo;       ///< Insert X-Envelope-To header to locally delivered messages
   boolean enableTNEFDecoding;         ///< Enable decoding of TNEF messages (winmail.dat attachments)
   boolean enableUUEncodedConversion;  ///< Enable conversion of uuencoded messages to MIME
};

struct StoreDirectoryOptions {
   string storePath;                         ///< Path to the store directory
   string archivePath;                          ///< Path to the archive
   string backupPath;                           ///< Path to the backup
   kerio::web::ByteValueWithUnits watchdogSoftLimit;  ///< If the available disk space falls below this value, a warning message is displayed
   kerio::web::ByteValueWithUnits watchdogHardLimit;  ///< If the available disk space falls below this value, Kerio MailServer is stopped and an error message is displayed. Administrator's action is required.
};

struct MasterAuthenticationOptions {
   boolean isEnabled;               ///< Enable master authentication to this server
   kerio::web::KId groupRestriction;   ///< Allow master authentication only from IP address group
   string password;              ///< [WriteOnly] Master password
};

struct HttpProxyOptions {
   boolean isEnabled;   ///< Use HTTP proxy for antivirus updates, Kerio update checker and other web services
   string address;
   long port;

   boolean requiresAuthentication;  ///< Proxy requires authentication
   string userName;
   string password;
};

struct OperatorOptions {
   boolean isEnabled;
   string address;
};

struct UpdateCheckerOptions {
   boolean autoCheck;            ///< Automatically check for new versions
   boolean checkBetaVersion;     ///< Check also for beta versions

   DistanceOrNull timeFromLastCheck;      ///< [ReadOnly]
   string downloadedFile;        ///< [ReadOnly]
   UpdateInfo updateInfo;        ///< [ReadOnly]

   string kocVersion;            ///< [ReadOnly]
   string koffVersion;           ///< [ReadOnly]
   string kspVersion;            ///< [ReadOnly]
   string kscVersion;            ///< [ReadOnly]
};

enum KoffUpgradePolicy {
   KoffUPolicyAskVoluntary,         ///< Ask user for each version change and do not allow the update.
   KoffUPolicyAskRequired,          ///< Ask user for each version change and require the update.
   KoffUPolicyAlwaysSilent,         ///< Do update for each version change. Update silently when Outlook starts. Ask users when Outlook is running and require update.
   KoffUPolicyOnStartSilent,        ///< default, available in WebAdmin. Do update for each version change. Update silently when Outlook starts. When Outlook is running do nothing and wait for next Outlook start.
   KoffUPolicyOnlyIfNecessaryAsk,      ///< Update only if necessary. Ask users and require the update.
   KoffUPolicyOnlyIfNecessarySilent ///< available in WebAdmin, Update only if necessary. Update silently when Outlook starts. Ask users when Outlook is running and require update.
};

struct KoffOptions {
   KoffUpgradePolicy upgradePolicy;
};

/** State of index */
enum FulltextStatus {
   IndexRebuilding,  ///< reindexing is in progress
   IndexMessages,    ///< indexing new delivered messages
   IndexFinished,    ///< reindexing is finnished, it also mean "Up To Date"
   IndexDisabled,    ///< indexing is disabled
   IndexError,       ///< some error occured
   IndexErrorLowSpace   ///< available disk space is below Soft Limit
};

/** [READ ONLY] progres of index */
struct FulltextRebuildStatus {
   FulltextStatus status;  ///< [READ ONLY] state of rebuild process
   long usersLeft;         ///< [status IndexRebuilding] - the current number of user re-indexed mailboxes
   long messagesLeft;      ///< [status IndexMessages] - number of new delivered messages to index
   long size;           ///< index size or estimate size in status IndexMessages or IndexRebuilding
   long freeSpace;         ///< free space in path for index files
};

struct FulltextSetting {
   boolean enabled;  ///< enabled/disabled
   string  path;     ///< path to directory where are indexes
};

/** Scope of reindex */
enum FulltextScope {
   IndexAll,      ///< all users to reindex
   IndexDomain,   ///< only users from domain to reindex
   IndexUser      ///< only user to reindex
};

struct FulltextRebuildingCommand {
   FulltextScope  scope;
   kerio::web::KId id;     ///< domain id for scope 'IndexDomain' or user id for scope 'IndexUser'
};

struct ButtonColor {
   boolean isEnabled;      ///< Is used
   string textColor;
   string backgroundColor;
};

struct AdditionalInfo {
   boolean isEnabled;      ///< Is used
   string text;
};

struct WebmailCustomLoginPage {
   CustomImage logo;
   ButtonColor buttonColor;
   AdditionalInfo additionalInfo;
};

struct WebMailOptions {
   long messageSizeLimit;           ///< Maximum size of message that can be sent from the WebMail interface (HTTP POST size)

   TimeLimit sessionExpireTimeout;     ///< Session expire timeout
   TimeLimit maximumSessionDuration;   ///< Maximum session duration
   boolean forceLogout;          ///< Force WebMail logout if user's IP address changes (prevents session hijacking and session fixation attacks)

   WebmailCustomLoginPage customLoginPage;   ///< Use custom logo in WebMail login page
   CustomImage            customClientLogo; ///< Use custom logo in Kerio Connect Client
};

struct UserQuota {
   QuotaNotification notification; ///< option for notification
   long warningLimit;            ///< limit in per cent
   string email;              ///< if quota is exceeded the notification will be sent to this address
};

struct AdvancedOptionsSetting {
   MiscellaneousOptions miscellaneous;
   StoreDirectoryOptions storeDirectory;
   MasterAuthenticationOptions masterAuthentication;
   HttpProxyOptions httpProxy;
   UpdateCheckerOptions updateChecker;
   WebMailOptions webMail;
   UserQuota userQuota;
   FulltextSetting fulltext;
   KoffOptions koffOptions;
   OperatorOptions operatorOptions;
};


interface AdvancedOptions {
   /**
    * Check for updates.
    *
    * @param options - new version details
    */
   void checkUpdates(out UpdateCheckerOptions options);

   /**
    * Obtain Advanced options.
    *
    * @param options - current advanced options
    */
   void get(out AdvancedOptionsSetting options);

   /**
    * Get information about index status.
    *
    * @param info - structure with information
    */
   void getFulltextStatus(out FulltextRebuildStatus info);

   /**
    * Set advanced options.
    *
    * @param options - options to be updated
    */
   void set(in AdvancedOptionsSetting options);

   /**
    * Launch re-index according parameters.
    *
    * @param parameters - parameters for launching re-index
    */
   void startRebuildFulltext(in FulltextRebuildingCommand parameters);
};

}; }; };//end of namespace