kerio::jsonapi::webmail::folders::Folders Interface Reference

import "Folders.idl";

Public Member Functions
void	clearToItemId (in kerio::web::KId itemId)
void	create (out kerio::web::ErrorList errors, out kerio::web::CreateResultList result, in FolderList folders)
void	get (out FolderList list)
void	getShared (out FolderList list, in kerio::web::KId mailboxId)
void	getPublic (out FolderList list)
void	getSubscribed (out SharedMailboxList list)
void	getAutoCompleteContactsFolderId (out kerio::web::KId folderId)
void	getSharedMailboxList (out SharedMailboxList mailboxes)
void	moveByType (out kerio::web::ErrorList errors, in kerio::web::KId targetId, in kerio::web::KIdList ids)
void	set (out kerio::web::ErrorList errors, in FolderList folders)
void	remove (out kerio::web::ErrorList errors, in kerio::web::KIdList ids, in boolean recursive)
void	removeByType (out kerio::web::ErrorList errors, in kerio::web::KIdList ids)
void	getPermissions (out FolderPermissionList permissions, in kerio::web::KId folderId)
void	setPermissions (in FolderPermissionList permissions, in kerio::web::KId folderId, in boolean recursive)
void	getSubscriptionList (out kerio::web::KIdList folderIds)
void	setSubscriptionList (in kerio::web::KIdList folderIds)
void	copyAllMessages (in kerio::web::KId sourceId, in kerio::web::KId destId, in boolean doMove)

Detailed Description

Folder store manager class

Member Function Documentation

void kerio::jsonapi::webmail::folders::Folders::clearToItemId

(

in kerio::web::KId

itemId

)

Remove all items in folder older then given item ID including. If folder is type of 'FMail' the items are moved to Delete Items or throw away if folder is Delete Items.

Parameters

itemId

- the last item ID

void kerio::jsonapi::webmail::folders::Folders::copyAllMessages	(	in kerio::web::KId	sourceId,
		in kerio::web::KId	destId,
		in boolean	doMove
	)

Copies (or moves) all messages from the source folder to the destination

Parameters

sourceId	- ID of the source folder
destId	- ID of the destionation folder
doMove	- if true move the messages instead of copy the

void kerio::jsonapi::webmail::folders::Folders::create	(	out kerio::web::ErrorList	errors,
		out kerio::web::CreateResultList	result,
		in FolderList	folders
	)

Create new folders

Parameters

errors	- error message list
result	- list of ID of crated folders.
folders	- list of folders to create

void kerio::jsonapi::webmail::folders::Folders::get

(

out FolderList

list

)

Obtain list of folders of currently logged user

Parameters

list	- list of folders

void kerio::jsonapi::webmail::folders::Folders::getAutoCompleteContactsFolderId

(

out kerio::web::KId

folderId

)

Obtain ID of special folder for auto-complete contacts

Parameters

folderId

- ID of special folder

void kerio::jsonapi::webmail::folders::Folders::getPermissions	(	out FolderPermissionList	permissions,
		in kerio::web::KId	folderId
	)

Get sharing permissions

Parameters

permissions	- sharing settings
folderId	- ID of folder

void kerio::jsonapi::webmail::folders::Folders::getPublic

(

out FolderList

list

)

Obtain list of public folders which currently logged user can access

Parameters

list	- list of public folders

void kerio::jsonapi::webmail::folders::Folders::getShared	(	out FolderList	list,
		in kerio::web::KId	mailboxId
	)

Obtain list of folders which currently logged user can access

Parameters

list	- list of folders

void kerio::jsonapi::webmail::folders::Folders::getSharedMailboxList

(

out SharedMailboxList

mailboxes

)

Obtain list of mailboxes with their folders which currently logged user can access

Parameters

mailboxes

- list of mailboxes with their folders

void kerio::jsonapi::webmail::folders::Folders::getSubscribed

(

out SharedMailboxList

list

)

Obtain list of folders acording SubscriptionList.

Parameters

list	- list of folders

void kerio::jsonapi::webmail::folders::Folders::getSubscriptionList

(

out kerio::web::KIdList

folderIds

)

Get list of subscribed folders

Parameters

folder

IDs

void kerio::jsonapi::webmail::folders::Folders::moveByType	(	out kerio::web::ErrorList	errors,
		in kerio::web::KId	targetId,
		in kerio::web::KIdList	ids
	)

Move folder. Sub-folders of different types are moved to a parent folder, therefore it's safe to call this method even if it isn't known if some sub-folders are there. Take a note that mail folders are moved recursively (the whole subtree)! Folders of other types (e.g. calendars) are not moved recursively.

Parameters

errors	- error message list
targetId	- target folder ID
ids	- folder IDs

void kerio::jsonapi::webmail::folders::Folders::remove	(	out kerio::web::ErrorList	errors,
		in kerio::web::KIdList	ids,
		in boolean	recursive
	)

Remove folder. Sub-folders are removed if recursive is true.

Parameters

errors	- error message list
ids	- folder IDs
recursive	- remove sub-folders

void kerio::jsonapi::webmail::folders::Folders::removeByType	(	out kerio::web::ErrorList	errors,
		in kerio::web::KIdList	ids
	)

Remove folder. Sub-folders of different types are moved to a parent folder, therefore it's safe to call this method even if it isn't known if some sub-folders are there. Take a note that mail folders are removed recursively! Folders of other types (e.g. calendars) are not removed recursively.

Parameters

errors	- error message list
ids	- folder IDs

void kerio::jsonapi::webmail::folders::Folders::set	(	out kerio::web::ErrorList	errors,
		in FolderList	folders
	)

Set folder properties

Parameters

errors	- error message list
folders	- properties to save

void kerio::jsonapi::webmail::folders::Folders::setPermissions	(	in FolderPermissionList	permissions,
		in kerio::web::KId	folderId,
		in boolean	recursive
	)

Set sharing permissions

Parameters

permissions	- sharing settings
folderId	- ID of folder
recursively	- if true all permissions in subfolders are replaced by these permissions

void kerio::jsonapi::webmail::folders::Folders::setSubscriptionList

(

in kerio::web::KIdList

folderIds

)

Set list of subscribed folders

Parameters

folder

IDs

---

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

• Folders.idl