kerio::jsonapi::admin::Domains Interface Reference

import "Domains.idl";

Public Member Functions
void	checkPublicFoldersIntegrity ()
void	create (out kerio::web::ErrorList errors, out kerio::web::CreateResultList result, in DomainList domains)
void	generatePassword (out string password, in kerio::web::KId domainId)
void	get (out DomainList list, out long totalItems, in kerio::web::SearchQuery query)
void	getDkimDnsRecord (out string detail, in string domain)
void	getSettings (out DomainSetting setting)
void	getUserCountInfo (out UserDomainCountInfo countInfo, in kerio::web::KId domainId)
void	remove (out kerio::web::ErrorList errors, in kerio::web::KIdList domainIds)
void	rename (out ClusterError error, in kerio::web::KId domainId, in string newName)
void	saveFooterImage (out string imgUrl, in string fileId)
void	saveWebMailLogo (out string logoUrl, in string fileId, in kerio::web::KId domainId)
void	set (out kerio::web::ErrorList errors, in kerio::web::KIdList domainIds, in Domain pattern)
void	setSettings (in DomainSetting setting)
void	testDomainController (out kerio::web::ErrorList errors, in kerio::web::StringList hostnames, in DirectoryServiceConfiguration config, in kerio::web::KId domainId)
void	testDkimDnsStatus (out kerio::web::ErrorList errors, in kerio::web::StringList hostnames)
void	getDomainFooterPlaceholders (out NamedConstantList placeholders)

Detailed Description

Domain management

Member Function Documentation

void kerio::jsonapi::admin::Domains::checkPublicFoldersIntegrity

(

)

Check integrity of all public folders. If corrupted folder is found, try to fix it.

void kerio::jsonapi::admin::Domains::create	(	out kerio::web::ErrorList	errors,
		out kerio::web::CreateResultList	result,
		in DomainList	domains
	)

Create new domains.

Parameters

errors	- error message list
result	- particular results for all items
domains	- new domain entities

void kerio::jsonapi::admin::Domains::generatePassword	(	out string	password,
		in kerio::web::KId	domainId
	)

Generate password which meets current password policy of a given domain.

Parameters

password	- generated password
domainId	- ID of the domain

void kerio::jsonapi::admin::Domains::get	(	out DomainList	list,
		out long	totalItems,
		in kerio::web::SearchQuery	query
	)

Obtain a list of domains.

Parameters

list	- domains
totalItems	- amount of domains for given search condition, useful when limit is defined in kerio::web::SearchQuery
query	- query conditions and limits

void kerio::jsonapi::admin::Domains::getDkimDnsRecord	(	out string	detail,
		in string	domain
	)

DKIM requires public key in DNS for domain. Returns DNS TXT record to be added into DNS.

void kerio::jsonapi::admin::Domains::getDomainFooterPlaceholders

(

out NamedConstantList

placeholders

)

Return all supported placeholders for domain footer

void kerio::jsonapi::admin::Domains::getSettings

(

out DomainSetting

setting

)

Get settings common in all domains.

Parameters

setting

- domain global setting

void kerio::jsonapi::admin::Domains::getUserCountInfo	(	out UserDomainCountInfo	countInfo,
		in kerio::web::KId	domainId
	)

Get information about user count and limit for domain. Disabled users are not counted.

Parameters

countInfo	- structure with users count and limit
domainId	- ID of the domain which will be renamed

void kerio::jsonapi::admin::Domains::remove	(	out kerio::web::ErrorList	errors,
		in kerio::web::KIdList	domainIds
	)

Remove domains.

Parameters

errors	- error message list
domainIds	- list of global identifiers of domains to be deleted

void kerio::jsonapi::admin::Domains::rename	(	out ClusterError	error,
		in kerio::web::KId	domainId,
		in string	newName
	)

Start domain renaming process.

Parameters

error	- error message
domainId	- ID of the domain which will be renamed
newName	- new domain name

void kerio::jsonapi::admin::Domains::saveFooterImage	(	out string	imgUrl,
		in string	fileId
	)

Save a new footer's image.

Parameters

imgUrl	- url to saved image
fileId	- id of uploaded file

void kerio::jsonapi::admin::Domains::saveWebMailLogo	(	out string	logoUrl,
		in string	fileId,
		in kerio::web::KId	domainId
	)

Save a new logo.

Parameters

logoUrl	- path to the saved file
fileId	- ID of the uploaded file
domainId	- global domain identifier

void kerio::jsonapi::admin::Domains::set	(	out kerio::web::ErrorList	errors,
		in kerio::web::KIdList	domainIds,
		in Domain	pattern
	)

Set existing domains to given pattern.

Parameters

errors	- error message list
domainIds	- list of the domain's global identifier(s)
pattern	- pattern to use for new values

void kerio::jsonapi::admin::Domains::setSettings

(

in DomainSetting

setting

)

Set settings for all domains.

Parameters

setting

- domain global settings

void kerio::jsonapi::admin::Domains::testDkimDnsStatus	(	out kerio::web::ErrorList	errors,
		in kerio::web::StringList	hostnames
	)

Tests DKIM DNS TXT status for domain list.

Parameters

errors	- error message
hostnames	- hostnames checked for DKIM public key in DNS

void kerio::jsonapi::admin::Domains::testDomainController	(	out kerio::web::ErrorList	errors,
		in kerio::web::StringList	hostnames,
		in DirectoryServiceConfiguration	config,
		in kerio::web::KId	domainId
	)

Test connection between Kerio Connect and domain controller.

Parameters

errors	- error message
hostnames	- directory server (primary and secondary if any)
config	- directory service configuration. If password is empty then it is taken from domain by 'domainId'.
domainId	- global domain identifier

---

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

• Domains.idl