All Classes Files Functions Variables Enumerations Enumerator Groups Pages
kerio::jsonapi::admin::UserTemplate Struct Reference

import "UserTemplates.idl";

Public Attributes

kerio::web::KId id
string name
 [REQUIRED FOR CREATE] [USED BY QUICKSEARCH] name of template (displayed in list of templates)
string description
 [USED BY QUICKSEARCH] description of template (displayed after its selection)
UserAuthType authType
 supported values must be retrieved from engine by ServerInfo::getSupportedAuthTypes()
boolean isPasswordReversible
 typically SHA1
boolean hasDefaultSpamRule
 should be spam rule enabled?
UserRight role
 list of user roles (excluding public/archive folder rights)
ValidFor scope
 scope of template
kerio::web::KId domainId
 not relevant for templating, only for filter (condition)
UserEmailAddressList emailAddresses
 filled only if domain is set
UserGroupList userGroups
 filled only if domain is set
EmailForwarding emailForwarding
 email forwarding setting
ItemCountLimit itemLimit
 max. number of items
kerio::web::SizeLimit diskSizeLimit
 max. disk usage
boolean hasDomainRestriction
 user can send/receive from/to his domain only
kerio::web::SizeLimit outMessageLimit
 limit of outgoing message
boolean publishInGal
 publish user in global address list
CleanOut cleanOutItems
 Items clean-out settings.
boolean allowPasswordChange
 if it is set to false the password can be changed only by the administrator
IdEntity accessPolicy
 ID and name of Access Policy applied for user. Only ID is writable.
kerio::web::KId companyContactId
 ID of company contact associated with this template.
kerio::web::KId homeServerId
 ID of distributed domain home server guid associated with this template.

Detailed Description

Details of user template - meaning is the same as in structure User

Member Data Documentation

IdEntity kerio::jsonapi::admin::UserTemplate::accessPolicy

ID and name of Access Policy applied for user. Only ID is writable.

boolean kerio::jsonapi::admin::UserTemplate::allowPasswordChange

if it is set to false the password can be changed only by the administrator

UserAuthType kerio::jsonapi::admin::UserTemplate::authType

supported values must be retrieved from engine by ServerInfo::getSupportedAuthTypes()

CleanOut kerio::jsonapi::admin::UserTemplate::cleanOutItems

Items clean-out settings.

kerio::web::KId kerio::jsonapi::admin::UserTemplate::companyContactId

ID of company contact associated with this template.

string kerio::jsonapi::admin::UserTemplate::description

[USED BY QUICKSEARCH] description of template (displayed after its selection)

kerio::web::SizeLimit kerio::jsonapi::admin::UserTemplate::diskSizeLimit

max. disk usage

kerio::web::KId kerio::jsonapi::admin::UserTemplate::domainId

not relevant for templating, only for filter (condition)

UserEmailAddressList kerio::jsonapi::admin::UserTemplate::emailAddresses

filled only if domain is set

EmailForwarding kerio::jsonapi::admin::UserTemplate::emailForwarding

email forwarding setting

boolean kerio::jsonapi::admin::UserTemplate::hasDefaultSpamRule

should be spam rule enabled?

boolean kerio::jsonapi::admin::UserTemplate::hasDomainRestriction

user can send/receive from/to his domain only

kerio::web::KId kerio::jsonapi::admin::UserTemplate::homeServerId

ID of distributed domain home server guid associated with this template.

boolean kerio::jsonapi::admin::UserTemplate::isPasswordReversible

typically SHA1

ItemCountLimit kerio::jsonapi::admin::UserTemplate::itemLimit

max. number of items

string kerio::jsonapi::admin::UserTemplate::name

[REQUIRED FOR CREATE] [USED BY QUICKSEARCH] name of template (displayed in list of templates)

kerio::web::SizeLimit kerio::jsonapi::admin::UserTemplate::outMessageLimit

limit of outgoing message

boolean kerio::jsonapi::admin::UserTemplate::publishInGal

publish user in global address list

UserRight kerio::jsonapi::admin::UserTemplate::role

list of user roles (excluding public/archive folder rights)

ValidFor kerio::jsonapi::admin::UserTemplate::scope

scope of template

UserGroupList kerio::jsonapi::admin::UserTemplate::userGroups

filled only if domain is set


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