import "Session.idl";

Public Member Functions
void	canUserChangePassword (out boolean isEligible)
void	getAvailableTimeZones (out kerio::web::StringList zones)
void	getAvailableLanguages (out LangDescriptionList languages)
void	getOutOfOffice (out OutOfOfficeSettings settings)
void	getQuotaInformation (out QuotaInfo quotaInfo)
void	getSettings (out jsonstring settings, in SettingQuery query)
void	getSpamSettings (out SpamSettings settings)
void	getUserVoiceUrl (out string accessUrl)
void	login (out string token, in string userName, in string password, in kerio::web::ApiApplication application)
void	logout (out string redirectUrl)
void	setOutOfOffice (in OutOfOfficeSettings settings)
void	setPassword (in string currentPassword, in string newPassword)
void	setSettings (in jsonstring settings)
void	setSpamSettings (in SpamSettings settings)
void	setUserInfo (in UserInfo userDetails)
void	whoAmI (out UserInfo userDetails)
void	getMobileDeviceList (out kerio::jsonapi::mobile::MobileDeviceList list, out long totalItems, in kerio::web::SearchQuery query)
void	removeMobileDevice (in string deviceId)
void	wipeMobileDevice (in string deviceId, in string password)
void	cancelWipeMobileDevice (in string deviceId)
void	getSignatureImageList (out ImageList list)
void	addSignatureImage (out kerio::web::ErrorList errors, out ImageList result, in kerio::web::KIdList ids)
void	removeSignatureImage (out kerio::web::ErrorList errors, in kerio::web::KIdList ids)

Detailed Description

Currently logged user manager

Member Function Documentation

void kerio::jsonapi::webmail::session::Session::addSignatureImage	(	out kerio::web::ErrorList	errors,
		out ImageList	result,
		in kerio::web::KIdList	ids
	)

Add image into user's store

Parameters

errors	- list of errors
result	- succesfuly added images
ids	- Upload IDs of images to add into user's store

void kerio::jsonapi::webmail::session::Session::cancelWipeMobileDevice ( in string deviceId )

Cancel wiping of user's mobile device.

Parameters

deviceId - ID of user's mobile device to cancel wipe

void kerio::jsonapi::webmail::session::Session::getAvailableLanguages ( out LangDescriptionList languages )

Get list of all languages supported by server.

Parameters

settings - details

void kerio::jsonapi::webmail::session::Session::getAvailableTimeZones ( out kerio::web::StringList zones )

Get list of all available time zones.

Parameters

zones - list of time zones

void kerio::jsonapi::webmail::session::Session::getMobileDeviceList	(	out kerio::jsonapi::mobile::MobileDeviceList	list,
		out long	totalItems,
		in kerio::web::SearchQuery	query
	)

Obtain a list of mobile devices of given user.

Parameters

list	- mobile devices of given user
totalItems	- number of mobile devices found for given user
query	- query attributes and limits

void kerio::jsonapi::webmail::session::Session::getOutOfOffice ( out OutOfOfficeSettings settings )

Obtain the Auto Reply settings

Parameters

settings - details

void kerio::jsonapi::webmail::session::Session::getQuotaInformation ( out QuotaInfo quotaInfo )

Obtain iformations about quota of current user.

void kerio::jsonapi::webmail::session::Session::getSettings	(	out jsonstring	settings,
		in SettingQuery	query
	)

Obtain currently logged user's settings.

Parameters

settings - WAM settings

void kerio::jsonapi::webmail::session::Session::getSignatureImageList ( out ImageList list )

Obtain list of images stored in user account

void kerio::jsonapi::webmail::session::Session::getSpamSettings ( out SpamSettings settings )

Obtain the spam settings

Parameters

settings - details

void kerio::jsonapi::webmail::session::Session::getUserVoiceUrl ( out string accessUrl )

Obtain URL for users' access to UserVoice

Parameters

accessUrl - URL for access to UserVoice

void kerio::jsonapi::webmail::session::Session::login	(	out string	token,
		in string	userName,
		in string	password,
		in kerio::web::ApiApplication	application
	)

Log in given user.

Parameters

token
userName
password
application	- application descriminator, note that with session to admin you cannot log in webmail

void kerio::jsonapi::webmail::session::Session::logout ( out string redirectUrl )

Logout callee.

void kerio::jsonapi::webmail::session::Session::removeMobileDevice ( in string deviceId )

Remove mobile device from the list of user's mobile devices.

Parameters

deviceId - ID of user's mobile device to be removed

void kerio::jsonapi::webmail::session::Session::removeSignatureImage	(	out kerio::web::ErrorList	errors,
		in kerio::web::KIdList	ids
	)

Remove image from user's store

Parameters

ids	- Image IDs to remove

void kerio::jsonapi::webmail::session::Session::setOutOfOffice ( in OutOfOfficeSettings settings )

Set the Auto Reply settings

Parameters

settings - details

void kerio::jsonapi::webmail::session::Session::setPassword	(	in string	currentPassword,
		in string	newPassword
	)

Change password of current user.

Parameters

currentPassword	- current users' password
newPassword	- new users' password

void kerio::jsonapi::webmail::session::Session::setSettings ( in jsonstring settings )

Set settings of the currently logged user.

Parameters

settings - WAM settings

void kerio::jsonapi::webmail::session::Session::setSpamSettings ( in SpamSettings settings )

Set the spam settings

Parameters

settings - details

void kerio::jsonapi::webmail::session::Session::setUserInfo ( in UserInfo userDetails )

Set user details.

Parameters

userDetails - details about the currently logged user

void kerio::jsonapi::webmail::session::Session::whoAmI ( out UserInfo userDetails )

Determines the currently logged user (caller).

Parameters

userDetails - details about the currently logged user

void kerio::jsonapi::webmail::session::Session::wipeMobileDevice	(	in string	deviceId,
		in string	password
	)

Wipe user's mobile device.

Parameters

deviceId	- ID of user's mobile device to be wiped
password	- password of current user

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

Session.idl

Client API for Kerio Connect

Public Member Functions

Detailed Description

Member Function Documentation