Public Member Functions |
void | getHostname (out string hostname) |
void | checkHostname (in string hostname) |
void | checkMxRecord (in string domainName) |
void | setHostname (in string hostname) |
void | getDistributableDomains (out kerio::web::StringList domainNames, in ClusterAuthentication authentication) |
void | createDistributableDomain (out ClusterError result, in string domainName, in ClusterAuthentication authentication) |
void | createPrimaryDomain (in string domainName) |
void | createAdministratorAccount (in string loginName, in string password) |
void | getMessageStorePath (out string path, out LongNumber freeSpace) |
void | setMessageStorePath (in string path) |
void | getDirs (out DirectoryList dirList, in string fullPath) |
void | checkMessageStorePath (out DirectoryAccessResult result, out LongNumber freeSpace, in string path) |
void | setClientStatistics (in boolean isEnabled) |
void | getCentralManagementStatus (out CentralManagementStatus status) |
void | getCentralManagement (out CentralManagementConfig config) |
void | setCentralManagement (in boolean isEnabled) |
void | finish () |
void | getNamedConstantList (out NamedConstantList constants) |
void | getBrowserLanguages (out kerio::web::StringList calculatedLanguage) |
void | getProductInfo (out ProductInfo info) |
void | getEula (out string content) |
void | getEncryptionStatus (out string status, out string action, out EncryptionError error, out EncryptionProgress progress) |
Member Function Documentation
void kerio::jsonapi::admin::Init::checkHostname |
( |
in string |
hostname | ) |
|
Check existence of domain name in the DNS. Existence of DN record with type "A" in appropriate DNS zone.
- Parameters
-
hostname | - fully qualified domain name of the server |
void kerio::jsonapi::admin::Init::checkMessageStorePath |
( |
out DirectoryAccessResult |
result, |
|
|
out LongNumber |
freeSpace, |
|
|
in string |
path |
|
) |
| |
Check if message store path is correct and can be created in the file system.
- Parameters
-
result | - result of the check |
freeSpace | - amount of free space in the directory |
path | - full path to message store directory |
void kerio::jsonapi::admin::Init::checkMxRecord |
( |
in string |
domainName | ) |
|
Check existence of MX record in the DNS for specified domain.
- Parameters
-
domainName | - fully qualified domain name |
void kerio::jsonapi::admin::Init::createAdministratorAccount |
( |
in string |
loginName, |
|
|
in string |
password |
|
) |
| |
Creates the administrator account. This account will be created in primary domain.
- Parameters
-
loginName | - login name for administrator (without domain name) |
password | - administrator password |
Connect server to cluster as slave and create distributable domain.
- Parameters
-
result | - if ClusterErrorType is not clSuccess, error argument contains additional error info |
domainName | - domain which can be distributed (they have a directory service set) and exist on master server. |
authentication | - Structure with a credential. Credential will be used when connected is false. |
void kerio::jsonapi::admin::Init::createPrimaryDomain |
( |
in string |
domainName | ) |
|
Creates the primary email domain.
- Parameters
-
domainName | - fully qualified name of the domain |
void kerio::jsonapi::admin::Init::finish |
( |
| ) |
|
Finish initial configuration of Kerio Connect.
void kerio::jsonapi::admin::Init::getBrowserLanguages |
( |
out kerio::web::StringList |
calculatedLanguage | ) |
|
Returns a list of user-preferred languages set in browser.
- Parameters
-
calculatedLanguage | - a list of 2-character language codes |
Get Central Management status (MyKerio).
void kerio::jsonapi::admin::Init::getDirs |
( |
out DirectoryList |
dirList, |
|
|
in string |
fullPath |
|
) |
| |
Obtain a list of directories in a particular path.
- Parameters
-
dirList | - List of directories |
fullPath | - directory for listing, if full path is empty logical drives will be listed |
void kerio::jsonapi::admin::Init::getDistributableDomains |
( |
out kerio::web::StringList |
domainNames, |
|
|
in ClusterAuthentication |
authentication |
|
) |
| |
Retrieve domains, which can be distributed, from the master server as a standalone server.
- Parameters
-
domainNames | - List of domains which can be distributed (they have a directory service set). |
authentication | - Structure with a credential. Credential will be used when connected is false. |
Returns the encryption information
- Parameters
-
result | - encryption information |
void kerio::jsonapi::admin::Init::getEula |
( |
out string |
content | ) |
|
Obtain EULA.
- Parameters
-
content | - plain text of EULA |
void kerio::jsonapi::admin::Init::getHostname |
( |
out string |
hostname | ) |
|
Returns FQDN (fully qualified domain name) of the server (e.g. mail.companyname.com).
- Parameters
-
hostname | - name of the server |
void kerio::jsonapi::admin::Init::getMessageStorePath |
( |
out string |
path, |
|
|
out LongNumber |
freeSpace |
|
) |
| |
Get current path to message store. Default path is "store" subdirectory in installation directory.
- Parameters
-
path | - full path to message store directory |
freeSpace | - amount of free space in the directory |
void kerio::jsonapi::admin::Init::getNamedConstantList |
( |
out NamedConstantList |
constants | ) |
|
Server side list of constants.
- Parameters
-
constants | - list of constants |
void kerio::jsonapi::admin::Init::getProductInfo |
( |
out ProductInfo |
info | ) |
|
Get basic information about product and its version.
- Parameters
-
info | - structure with basic information about product |
void kerio::jsonapi::admin::Init::setCentralManagement |
( |
in boolean |
isEnabled | ) |
|
Set Central Management settings (MyKerio).
- Parameters
-
isEnabled | - flag if central management is enabled |
void kerio::jsonapi::admin::Init::setClientStatistics |
( |
in boolean |
isEnabled | ) |
|
Set client statistics settings.
- Parameters
-
isEnabled | - flag if statistics are enabled |
void kerio::jsonapi::admin::Init::setHostname |
( |
in string |
hostname | ) |
|
Set Internet hostname of the server. This name is used for server identification in SMTP, POP3 and similar protocols.
- Parameters
-
hostname | - new fully qualified domain name of the server |
void kerio::jsonapi::admin::Init::setMessageStorePath |
( |
in string |
path | ) |
|
Set path to message store directory.
- Parameters
-
path | - full path to message store directory |
The documentation for this interface was generated from the following file: