Documentation

Horde_Kolab_Storage_Folder

The interface describing a Kolab folder.

Copyright 2004-2017 Horde LLC (http://www.horde.org/)

See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Tags
category

Kolab

author

Stuart Binge omicron@mighty.co.za

author

Gunnar Wrobel wrobel@pardus.de

author

Thomas Jarosch thomas.jarosch@intra2net.com

license

http://www.horde.org/licenses/lgpl21 LGPL 2.1

Table of Contents

getNamespace()  : string
Return the namespace type of the folder.
getOwner()  : string
Returns the owner of the folder.
getParent()  : string
Returns the folder parent.
getPath()  : string
Return the storage path of the folder.
getPrefix()  : string
Return the namespace prefix of the folder.
getSubpath()  : string
Returns the folder path without namespace components.
getTitle()  : string
Returns a readable title for this folder.
getType()  : string
The type of this folder.
isDefault()  : bool
Is this a default folder?

Methods

getNamespace()

Return the namespace type of the folder.

public getNamespace() : string
Return values
string

The namespace type of the folder.

getOwner()

Returns the owner of the folder.

public getOwner() : string
Return values
string

The owner of this folder.

getParent()

Returns the folder parent.

public getParent() : string
Return values
string

The parent of this folder.

getPath()

Return the storage path of the folder.

public getPath() : string
Return values
string

The storage path of the folder.

getPrefix()

Return the namespace prefix of the folder.

public getPrefix() : string
Return values
string

The namespace prefix of the folder.

getSubpath()

Returns the folder path without namespace components.

public getSubpath() : string
Return values
string

The subpath of this folder.

getTitle()

Returns a readable title for this folder.

public getTitle() : string
Return values
string

The folder title.

getType()

The type of this folder.

public getType() : string
Return values
string

The folder type.

isDefault()

Is this a default folder?

public isDefault() : bool
Return values
bool

Boolean that indicates the default status.

Search results