Interface Horde_Kolab_Storage_Folder

The interface describing a Kolab folder.

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

Direct known implementers

Horde_Kolab_Storage_Folder_Base, Horde_Kolab_Storage_Folder_Decorator_Base

Indirect known implementers

Horde_Kolab_Storage_Folder_Decorator_Trigger

Package: Kolab\Storage
Category: Kolab
License: LGPL 2.1
Author: Stuart Binge omicron@mighty.co.za
Author: Gunnar Wrobel wrobel@pardus.de
Author: Thomas Jarosch thomas.jarosch@intra2net.com
Link: http://pear.horde.org/index.php?package=Kolab_Storage
Located at Horde/Kolab/Storage/Folder.php

Methods summary
`public string`	# `getPath( )` Return the storage path of the folder. Return the storage path of the folder. Returns `string` The storage path of the folder.
`public string`	# `getTitle( )` Returns a readable title for this folder. Returns a readable title for this folder. Returns `string` The folder title.
`public string`	# `getNamespace( )` Return the namespace type of the folder. Return the namespace type of the folder. Returns `string` The namespace type of the folder.
`public string`	# `getPrefix( )` Return the namespace prefix of the folder. Return the namespace prefix of the folder. Returns `string` The namespace prefix of the folder. Since Horde_Kolab_Storage 1.1.0
`public string`	# `getOwner( )` Returns the owner of the folder. Returns the owner of the folder. Returns `string` The owner of this folder.
`public string`	# `getSubpath( )` Returns the folder path without namespace components. Returns the folder path without namespace components. Returns `string` The subpath of this folder.
`public string`	# `getParent( )` Returns the folder parent. Returns the folder parent. Returns `string` The parent of this folder.
`public boolean`	# `isDefault( )` Is this a default folder? Is this a default folder? Returns `boolean` Boolean that indicates the default status.
`public null`	# `save( array $attributes = null )` Saves the folder. Saves the folder. Parameters `$attributes` <p>An array of folder attributes. You can set any attribute but there are a few special ones like 'type', 'default', 'owner' and 'desc'.</p> Returns `null`
`public null`	# `deleteMessage( string $id, boolean $trigger = true )` Delete the specified message from this folder. Delete the specified message from this folder. Parameters `$id` IMAP id of the message to be deleted. `$trigger` Should the folder be triggered? Returns `null`
`public boolean`	# `moveMessage( string $id, string $folder )` Move the specified message to the specified folder. Move the specified message to the specified folder. Parameters `$id` IMAP id of the message to be moved. `$folder` Name of the receiving folder. Returns `boolean` True if successful.
`public null`	# `moveMessageToShare( string $id, string $share )` Move the specified message to the specified share. Move the specified message to the specified share. Parameters `$id` IMAP id of the message to be moved. `$share` Name of the receiving share. Returns `null`
`public boolean`	# `saveObject( array & $object, integer $data_version, string $object_type, string $id = null, array & $old_object = null )` Save an object in this folder. Save an object in this folder. Parameters `$object` The array that holds the data of the object. `$data_version` The format handler version. `$object_type` The type of the kolab object. `$id` <p>The IMAP id of the old object if it existed before</p> `$old_object` <p>The array that holds the current data of the object.</p> Returns `boolean` True on success.

Packages

Classes

Interfaces

Interface Horde_Kolab_Storage_Folder

Direct known implementers

Indirect known implementers

Returns

Returns

Returns

Returns

Since

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns