API Documentation
\

\Horde_Kolab_Storage_List_Manipulation

Describes Kolab folder list manipulators.

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.

Summary

Methods
Properties
Constants
createFolder()
deleteFolder()
renameFolder()
registerListener()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

createFolder()

createFolder(string  $folder, string  $type = null) : NULL

Create a new folder.

Parameters

string $folder

The path of the folder to create.
string $type

An optional type for the folder.

Returns

NULL

deleteFolder()

deleteFolder(string  $folder) : NULL

Delete a folder.

WARNING: Do not use this call in case there is still data present in the folder. You are required to empty any data set before removing the folder. Otherwise there is no guarantee you can adhere to that Kolab specification that might require the triggering of remote systems to inform them about the removal of the folder.

Parameters

string $folder

The path of the folder to delete.

Returns

NULL

renameFolder()

renameFolder(string  $old, string  $new) : NULL

Rename a folder.

Parameters

string $old

The old path of the folder.
string $new

The new path of the folder.

Returns

NULL