kerio::jsonapi::admin::MailingLists Interface Reference

Public Member Functions
void	addMlUserList (out kerio::web::ErrorList errors, in UserOrEmailList members, in kerio::web::KId mlId)
void	create (out kerio::web::ErrorList errors, out kerio::web::CreateResultList result, in MlList mailingLists)
void	exportMlUsersToCsv (out kerio::web::Download fileDownload, in MlMembership kind, in kerio::web::KId mlId)
void	get (out MlList list, out long totalItems, in kerio::web::SearchQuery query, in kerio::web::KId domainId)
void	getMlUserList (out UserOrEmailList list, out long totalItems, in kerio::web::SearchQuery query, in kerio::web::KId mlId)
void	getMlUserListFromCsv (out MLMemberImporteeList members, in string fileId, in kerio::web::KId mlToImport)
void	getSuffixes (out kerio::web::StringList suffixes)
void	getTrusteeTargetList (out TrusteeTargetList 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 mlIds)
void	removeMlUserList (out kerio::web::ErrorList errors, in UserOrEmailList members, in kerio::web::KId mlId)
void	set (out kerio::web::ErrorList errors, in kerio::web::KIdList mlIds, in Ml pattern)

Member Function Documentation

void kerio::jsonapi::admin::MailingLists::addMlUserList	(	out kerio::web::ErrorList	errors,
		in UserOrEmailList	members,
		in kerio::web::KId	mlId
	)

Add one or more members/moderators to a mailing list.

Parameters

errors	- appropriate error messages
members	- ML members and/or moderators
mlId	- unique ML identifier

void kerio::jsonapi::admin::MailingLists::create	(	out kerio::web::ErrorList	errors,
		out kerio::web::CreateResultList	result,
		in MlList	mailingLists
	)

Create new mailing lists.

Parameters

errors	- error message list
result	- list of IDs of created mailing lists
mailingLists	- mailing list entities

void kerio::jsonapi::admin::MailingLists::exportMlUsersToCsv	(	out kerio::web::Download	fileDownload,
		in MlMembership	kind,
		in kerio::web::KId	mlId
	)

Export of mailing list users of specified membership type.

Parameters

kind	- membership type
mlId	- unique ML identifier
fileDownload	- description of output file

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

Obtain a list of mailing lists.

Parameters

list	- mailing lists
totalItems	- amount of MLs for given search condition, useful when a limit is defined in search query
query	- query conditions and limits
domainName	- domain identification

void kerio::jsonapi::admin::MailingLists::getMlUserList	(	out UserOrEmailList	list,
		out long	totalItems,
		in kerio::web::SearchQuery	query,
		in kerio::web::KId	mlId
	)

Obtain list of mailing list users including membership type.

Parameters

list	- mailing list members and/or moderators
totalItems	- amount of MLs members for given search condition, useful when a limit is defined in search query
query	- orderBy definition (conditions and limit are ignored)
mlId	- unique ML identifier

void kerio::jsonapi::admin::MailingLists::getMlUserListFromCsv	(	out MLMemberImporteeList	members,
		in string	fileId,
		in kerio::web::KId	mlToImport
	)

Parse CSV file in format 'Email, FullName' and return list of members.

Parameters

members	- ML members and/or moderators
fileId	- ID of the uploaded file
mlToImport	- unique ML identifier or empty string if XML does not exist yet

void kerio::jsonapi::admin::MailingLists::getSuffixes

(

out kerio::web::StringList

suffixes

)

Obtain all suffixes of mailing list. These are forbidden in a name of mailing list to avoid of misbehaviour during processing of special commands of mailing list.

Parameters

suffixes

- list of suffixes

void kerio::jsonapi::admin::MailingLists::getTrusteeTargetList	(	out TrusteeTargetList	list,
		out long	totalItems,
		in kerio::web::SearchQuery	query,
		in kerio::web::KId	domainId
	)

Obtain a list of potential mailing list archive rights targets.

Parameters

list	- trustee targets
query	- query attributes and limits
domain	- domain restriction

void kerio::jsonapi::admin::MailingLists::remove	(	out kerio::web::ErrorList	errors,
		in kerio::web::KIdList	mlIds
	)

Remove mailing lists.

Parameters

errors	- error message list
mlIds	- list of global identifiers of MLs to be deleted

void kerio::jsonapi::admin::MailingLists::removeMlUserList	(	out kerio::web::ErrorList	errors,
		in UserOrEmailList	members,
		in kerio::web::KId	mlId
	)

Remove member(s)/moderator(s) from a mailing list.

Parameters

errors	- appropriate error messages
members	- ML members and/or moderators
mlId	- unique ML identifier

void kerio::jsonapi::admin::MailingLists::set	(	out kerio::web::ErrorList	errors,
		in kerio::web::KIdList	mlIds,
		in Ml	pattern
	)

Create a new mailing list.

Parameters

errors	- error message list
mlIds	- ML global identifiers
pattern	- pattern to use for new values

---

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

• MailingLists.idl