kerio::jsonapi::admin::Aliases Interface Reference

import "Aliases.idl";

Public Member Functions
void	check (out kerio::web::StringList result, in string checkString)
void	create (out kerio::web::ErrorList errors, out kerio::web::CreateResultList result, in AliasList aliases)
void	get (out AliasList list, out long totalItems, in kerio::web::SearchQuery query, in kerio::web::KId domainId)
void	getMailPublicFolderList (out PublicFolderList publicFolderList, in kerio::web::KId domainId)
void	getTargetList (out AliasTargetList list, out long totalItems, in kerio::web::SearchQuery query, in kerio::web::KId domainId)
void	remove (out kerio::web::ErrorList errors, in kerio::web::KIdList aliasIds)
void	set (out kerio::web::ErrorList errors, in kerio::web::KIdList aliasIds, in Alias pattern)

Detailed Description

Alias management

Member Function Documentation

void kerio::jsonapi::admin::Aliases::check	(	out kerio::web::StringList	result,
		in string	checkString
	)

Obtain a list of mail addresses and/or public folders on which given string will be expanded.

Parameters

result	- list of expansions
checkString	- string to be checked

void kerio::jsonapi::admin::Aliases::create	(	out kerio::web::ErrorList	errors,
		out kerio::web::CreateResultList	result,
		in AliasList	aliases
	)

Create new aliases

Parameters

errors	- list of error messages for appropriate new aliases
result	- list of IDs of created aliases
aliases	- new alias entities

void kerio::jsonapi::admin::Aliases::get	(	out AliasList	list,
		out long	totalItems,
		in kerio::web::SearchQuery	query,
		in kerio::web::KId	domainId
	)

Obtain list of aliases.

Parameters

list	- aliases
totalItems	- amount of aliases for given search condition, useful when limit is defined in query
query	- query conditions and limits
domainKId	- domain identification

void kerio::jsonapi::admin::Aliases::getMailPublicFolderList	(	out PublicFolderList	publicFolderList,
		in kerio::web::KId	domainId
	)

Obtain a list of mail public folders in the given domain.

Parameters

publicFolderList	- list of public folders
domainId	- global identification of the domain

void kerio::jsonapi::admin::Aliases::getTargetList	(	out AliasTargetList	list,
		out long	totalItems,
		in kerio::web::SearchQuery	query,
		in kerio::web::KId	domainId
	)

Obtain a list of alias targets.

Parameters

list	- alias targets
totalItems	- amount of aliases for given search condition, useful when a limit is defined in the query
query	- query conditions and limits
domainId	- global identification of the domain

void kerio::jsonapi::admin::Aliases::remove	(	out kerio::web::ErrorList	errors,
		in kerio::web::KIdList	aliasIds
	)

Delete aliases.

Parameters

errors	- error message list
aliasList	- list of global identifiers of aliases to be deleted

void kerio::jsonapi::admin::Aliases::set	(	out kerio::web::ErrorList	errors,
		in kerio::web::KIdList	aliasIds,
		in Alias	pattern
	)

Set an existing alias.

Parameters

errors	- error message list
aliasIds	- list of alias global identifier(s)
pattern	- pattern to use for new values

---

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

• Aliases.idl