All Classes Namespaces Files Functions Variables Groups
kerio::jsonapi::webmail::folders::Folder Struct Reference

Public Attributes

kerio::web::KId id
 [READ-ONLY] global identification
kerio::web::KId parentId
 global identification
string name
 folder name displayed in folder tree
string ownerName
 [READ-ONLY] name of owner of folder (available only for 'FPlacePeople', 'FPlaceResources' and 'FPlaceLocations')
string emailAddress
 [READ-ONLY] email of owner of folder (available only for 'FPlacePeople', 'FPlaceResources' and 'FPlaceLocations')
FolderType type
 type of the folder
FolderSubType subType
 [READ-ONLY] type of the folder
FolderPlaceType placeType
 [READ-ONLY] type of place where is folder placed
FolderAccess access
 [READ-ONLY] type of access of currently loged user
boolean isShared
 [READ-ONLY] true if a folder is shared to another user (permissions are not empty)
boolean isDelegated
 [READ-ONLY] true if a folder access is R/W and user is a delegate
long nestingLevel
 [READ-ONLY] number 0 = root folder, 1 = subfolders of root folder, 2 = subfolder of subfolder, ...
long messageCount
 [READ-ONLY] count of items in the folder (not set for root folder)
long messageUnread
 [READ-ONLY] count of unread items (mails or deleted items) in folder, not set for non-mail folder types
longlong messageSize
 [READ-ONLY] size of all messages in the folder (without subdirectories)
boolean checked
 true if a folder is chosen to view
string color
 a color of folder, if string is empty no color is set
boolean published
 [READ-ONLY] true, if folder was published to server

Member Data Documentation

FolderAccess kerio::jsonapi::webmail::folders::Folder::access

[READ-ONLY] type of access of currently loged user

boolean kerio::jsonapi::webmail::folders::Folder::checked

true if a folder is chosen to view

string kerio::jsonapi::webmail::folders::Folder::color

a color of folder, if string is empty no color is set

string kerio::jsonapi::webmail::folders::Folder::emailAddress

[READ-ONLY] email of owner of folder (available only for 'FPlacePeople', 'FPlaceResources' and 'FPlaceLocations')

kerio::web::KId kerio::jsonapi::webmail::folders::Folder::id

[READ-ONLY] global identification

boolean kerio::jsonapi::webmail::folders::Folder::isDelegated

[READ-ONLY] true if a folder access is R/W and user is a delegate

boolean kerio::jsonapi::webmail::folders::Folder::isShared

[READ-ONLY] true if a folder is shared to another user (permissions are not empty)

long kerio::jsonapi::webmail::folders::Folder::messageCount

[READ-ONLY] count of items in the folder (not set for root folder)

longlong kerio::jsonapi::webmail::folders::Folder::messageSize

[READ-ONLY] size of all messages in the folder (without subdirectories)

long kerio::jsonapi::webmail::folders::Folder::messageUnread

[READ-ONLY] count of unread items (mails or deleted items) in folder, not set for non-mail folder types

string kerio::jsonapi::webmail::folders::Folder::name

folder name displayed in folder tree

long kerio::jsonapi::webmail::folders::Folder::nestingLevel

[READ-ONLY] number 0 = root folder, 1 = subfolders of root folder, 2 = subfolder of subfolder, ...

string kerio::jsonapi::webmail::folders::Folder::ownerName

[READ-ONLY] name of owner of folder (available only for 'FPlacePeople', 'FPlaceResources' and 'FPlaceLocations')

kerio::web::KId kerio::jsonapi::webmail::folders::Folder::parentId

global identification

FolderPlaceType kerio::jsonapi::webmail::folders::Folder::placeType

[READ-ONLY] type of place where is folder placed

boolean kerio::jsonapi::webmail::folders::Folder::published

[READ-ONLY] true, if folder was published to server

FolderSubType kerio::jsonapi::webmail::folders::Folder::subType

[READ-ONLY] type of the folder

FolderType kerio::jsonapi::webmail::folders::Folder::type

type of the folder


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