kerio::jsonapi::admin::Delivery Interface Reference

Public Member Functions
void	addEtrnDownloadList (out kerio::web::ErrorList errors, in EtrnDownloadList downloads)
void	addPop3AccountList (out kerio::web::ErrorList errors, in Pop3AccountList accounts)
void	addPop3SortingList (out kerio::web::ErrorList errors, in Pop3SortingList sortings)
void	addScheduledActionList (out kerio::web::ErrorList errors, in ScheduledActionList actions)
void	downloadEtrn ()
void	getEtrnDownloadList (out EtrnDownloadList list, out long totalItems, in kerio::web::SearchQuery query)
void	getEtrnTimeout (out long seconds)
void	getInternetSettings (out InternetSettings settings)
void	getPop3AccountList (out Pop3AccountList list, out long totalItems, in kerio::web::SearchQuery query)
void	getPop3SortingList (out Pop3SortingList list, out long totalItems, in kerio::web::SearchQuery query)
void	getRasNames (out kerio::web::StringList names)
void	getScheduledActionList (out ScheduledActionList list, out long totalItems, in kerio::web::SearchQuery query)
void	removeEtrnDownloadList (out kerio::web::ErrorList errors, in kerio::web::KIdList ids)
void	removePop3AccountList (out kerio::web::ErrorList errors, in kerio::web::KIdList ids)
void	removePop3SortingList (out kerio::web::ErrorList errors, in kerio::web::KIdList ids)
void	removeScheduledActionList (out kerio::web::ErrorList errors, in kerio::web::KIdList ids)
void	runPop3Downloads ()
void	setEtrnDownload (in kerio::web::KId downloadId, in EtrnDownload download)
void	setEtrnTimeout (in long seconds)
void	setInternetSettings (in InternetSettings settings)
void	setPop3Account (in kerio::web::KId accountId, in Pop3Account account)
void	setPop3Sorting (in kerio::web::KId sortingId, in Pop3Sorting sorting)
void	setScheduledAction (in kerio::web::KId actionId, in ScheduledAction action)

Member Function Documentation

void kerio::jsonapi::admin::Delivery::addEtrnDownloadList	(	out kerio::web::ErrorList	errors,
		in EtrnDownloadList	downloads
	)

Add new ETRN downloads.

Parameters

errors	- list of error messages
downloads	- new ETRN download records

void kerio::jsonapi::admin::Delivery::addPop3AccountList	(	out kerio::web::ErrorList	errors,
		in Pop3AccountList	accounts
	)

Add new POP3 accounts.

Parameters

errors	- list of error messages
accounts	- new POP3 account records

void kerio::jsonapi::admin::Delivery::addPop3SortingList	(	out kerio::web::ErrorList	errors,
		in Pop3SortingList	sortings
	)

Add new POP3 sorting rules.

Parameters

errors	- list of error messages
sortings	- new POP3 sorting records

void kerio::jsonapi::admin::Delivery::addScheduledActionList	(	out kerio::web::ErrorList	errors,
		in ScheduledActionList	actions
	)

Add scheduled actions.

Parameters

errors	- list of error messages
actions	- new scheduler actions

void kerio::jsonapi::admin::Delivery::downloadEtrn

(

)

Start ETRN downloads.

void kerio::jsonapi::admin::Delivery::getEtrnDownloadList	(	out EtrnDownloadList	list,
		out long	totalItems,
		in kerio::web::SearchQuery	query
	)

Obtain list of ETRN download items.

Parameters

list	- ETRN download records
totalItems	- amount of records for given search condition, useful when a limit is defined in the query
query	- query conditions and limits

void kerio::jsonapi::admin::Delivery::getEtrnTimeout

(

out long

seconds

)

Get timeout for ETRN reply on dial-up line

Parameters

seconds

- number of seconds for ETRN timeout

void kerio::jsonapi::admin::Delivery::getInternetSettings

(

out InternetSettings

settings

)

Obtain Internet connection settings.

Parameters

settings

- Internet connection settings

void kerio::jsonapi::admin::Delivery::getPop3AccountList	(	out Pop3AccountList	list,
		out long	totalItems,
		in kerio::web::SearchQuery	query
	)

Obtain list of POP3 accounts.

Parameters

list	- POP3 accounts
totalItems	- amount of accounts for given search condition, useful when a limit is defined in the query
query	- query conditions and limits

void kerio::jsonapi::admin::Delivery::getPop3SortingList	(	out Pop3SortingList	list,
		out long	totalItems,
		in kerio::web::SearchQuery	query
	)

Obtain list of POP3 sorting rules

Parameters

list	- POP3 sorting records
totalItems	- amount of records for given search condition, useful when a limit is defined in the query
query	- query conditions and limits

void kerio::jsonapi::admin::Delivery::getRasNames

(

out kerio::web::StringList

names

)

Obtain Remote Access Service. Valid information available on Windows only.

Parameters

names

- list of available RAS names

void kerio::jsonapi::admin::Delivery::getScheduledActionList	(	out ScheduledActionList	list,
		out long	totalItems,
		in kerio::web::SearchQuery	query
	)

Obtain a list of scheduler actions.

Parameters

list	- scheduler actions
totalItems	- amount of actions for given search condition, useful when limit is defined in query
query	- query conditions and limits

void kerio::jsonapi::admin::Delivery::removeEtrnDownloadList	(	out kerio::web::ErrorList	errors,
		in kerio::web::KIdList	ids
	)

Remove ETRN download items.

Parameters

errors	- error message list
ids	- identifier list of ETRN download records to be deleted

void kerio::jsonapi::admin::Delivery::removePop3AccountList	(	out kerio::web::ErrorList	errors,
		in kerio::web::KIdList	ids
	)

Remove POP3 accounts.

Parameters

errors	- list of error messages
ids	- identifier list of POP3 account records to be deleted

void kerio::jsonapi::admin::Delivery::removePop3SortingList	(	out kerio::web::ErrorList	errors,
		in kerio::web::KIdList	ids
	)

Remove POP3 sorting rules.

Parameters

errors	- list of error messages
ids	- identifier list of POP3 sorting records to be deleted

void kerio::jsonapi::admin::Delivery::removeScheduledActionList	(	out kerio::web::ErrorList	errors,
		in kerio::web::KIdList	ids
	)

Remove scheduled actions.

Parameters

errors	- error message list
ids	- identifier list of scheduler actions to be deleted

void kerio::jsonapi::admin::Delivery::runPop3Downloads

(

)

Proceed all POP3 downloads right now.

void kerio::jsonapi::admin::Delivery::setEtrnDownload	(	in kerio::web::KId	downloadId,
		in EtrnDownload	download
	)

Set 1 ETRN download item.

Parameters

downloadId	- updated ETRN download identifier
download	- new ETRN download record

void kerio::jsonapi::admin::Delivery::setEtrnTimeout

(

in long

seconds

)

Set timeout for ETRN reply on dial-up line.

Parameters

seconds

- number of seconds for ETRN timeout

void kerio::jsonapi::admin::Delivery::setInternetSettings

(

in InternetSettings

settings

)

Set Internet connection settings.

Parameters

settings

- Internet connection settings

void kerio::jsonapi::admin::Delivery::setPop3Account	(	in kerio::web::KId	accountId,
		in Pop3Account	account
	)

Set POP3 account.

Parameters

accountId	- updated POP3 account identifier
account	- new POP3 account record

void kerio::jsonapi::admin::Delivery::setPop3Sorting	(	in kerio::web::KId	sortingId,
		in Pop3Sorting	sorting
	)

Set POP3 sorting rule.

Parameters

sortingId	- updated POP3 sorting identifier
sorting	- new POP3 sorting record

void kerio::jsonapi::admin::Delivery::setScheduledAction	(	in kerio::web::KId	actionId,
		in ScheduledAction	action
	)

Set a scheduled action.

Parameters

actionId	- updated action identifier
action	- new scheduler actions

---

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

• Delivery.idl