PHP Интерфейс Horde_Kolab_Storage_Driver, horde

Copyright 2004-2016 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
См. ссылку: http://pear.horde.org/index.php?package=Kolab_Storage
Автор: Gunnar Wrobel ([email protected])
Показать файл Открыть проект Примеры использования интерфейса

Открытые методы

Метод Описание
appendMessage ( string $folder, resource $msg ) : mixed Appends a message to the given folder.
create ( string $folder ) : null Create the specified folder.
createBackend ( ) : mixed Create the backend driver.
delete ( string $folder ) : null Delete the specified folder.
deleteAcl ( string $folder, string $user ) : null Delete the access rights for user on a folder.
deleteMessages ( string $folder, integer $uids ) : null Deletes messages from the specified folder.
expunge ( string $folder ) : null Expunges messages in the current folder.
fetchBodypart ( string $folder, array $uid, array $id ) : resource | string Retrieves a bodypart for the given message ID and mime part ID.
fetchComplete ( string $folder, array $uid ) : array Retrieves a complete message.
fetchHeaders ( string $folder, array $uid ) : Horde_Mime_Headers Retrieves the message headers.
fetchStructure ( string $folder, array $uids ) : array Retrieves the messages for the given message ids.
getAcl ( string $folder ) : array Retrieve the access rights for a folder.
getAnnotation ( string $folder, string $annotation ) : string Fetches the annotation from a folder.
getAuth ( ) : string Return the id of the user currently authenticated.
getBackend ( ) : mixed Returns the actual backend driver.
getId ( ) : string Return the unique connection id.
getMyAcl ( string $folder ) : string Retrieve the access rights the current user has on a folder.
getNamespace ( ) : Horde_Kolab_Storage_Driver_Namespace Retrieve the namespace information for this connection.
getParameters ( ) : array Return the connection parameters.
getStamp ( string $folder ) : Horde_Kolab_Storage_Folder_Stamp Returns a stamp for the current folder status. This stamp can be used to identify changes in the folder data.
getUids ( string $folder ) : array Returns the message ids of the messages in this folder.
hasAclSupport ( ) : boolean Does the backend support ACL?
hasCatenateSupport ( ) : boolean Checks if the backend supports CATENATE.
listAnnotation ( string $annotation ) : array Retrieves the specified annotation for the complete list of folders.
listFolders ( ) : array Retrieves a list of folders from the server.
moveMessage ( integer $uid, string $old_folder, string $new_folder ) : null Moves a message to a new folder.
rename ( string $old, string $new ) : null Rename the specified folder.
setAcl ( string $folder, string $user, string $acl ) : null Set the access rights for a folder.
setAnnotation ( string $folder, string $annotation, array $value ) : null Sets the annotation on a folder.
setBackend ( mixed $backend ) : null Set the backend driver.
status ( string $folder ) : array Returns the status of the current folder.

Описание методов

appendMessage() публичный Метод

Appends a message to the given folder.
public appendMessage ( string $folder, resource $msg ) : mixed
$folder string The folder to append the message(s) to.
$msg resource The message to append.
Результат mixed True or the UID of the new message in case the backend supports UIDPLUS.

create() публичный Метод

Create the specified folder.
public create ( string $folder ) : null
$folder string The folder to create.
Результат null

createBackend() публичный Метод

Create the backend driver.
public createBackend ( ) : mixed
Результат mixed The backend driver.

delete() публичный Метод

Delete the specified folder.
public delete ( string $folder ) : null
$folder string The folder to delete.
Результат null

deleteAcl() публичный Метод

Delete the access rights for user on a folder.
public deleteAcl ( string $folder, string $user ) : null
$folder string The folder to act upon.
$user string The user to delete the ACL for
Результат null

deleteMessages() публичный Метод

Deletes messages from the specified folder.
public deleteMessages ( string $folder, integer $uids ) : null
$folder string The folder to delete messages from.
$uids integer IMAP message ids.
Результат null

expunge() публичный Метод

Expunges messages in the current folder.
public expunge ( string $folder ) : null
$folder string The folder to expunge.
Результат null

fetchBodypart() публичный Метод

Retrieves a bodypart for the given message ID and mime part ID.
public fetchBodypart ( string $folder, array $uid, array $id ) : resource | string
$folder string The folder to fetch the messages from.
$uid array The message UID.
$id array The mime part ID.
Результат resource | string The body part, as a stream resource or string.

fetchComplete() публичный Метод

Retrieves a complete message.
public fetchComplete ( string $folder, array $uid ) : array
$folder string The folder to fetch the messages from.
$uid array The message UID.
Результат array The message encapsuled as an array that contains a Horde_Mime_Headers and a Horde_Mime_Part object.

fetchHeaders() публичный Метод

Retrieves the message headers.
public fetchHeaders ( string $folder, array $uid ) : Horde_Mime_Headers
$folder string The folder to fetch the message from.
$uid array The message UID.
Результат Horde_Mime_Headers The message headers.

fetchStructure() публичный Метод

Retrieves the messages for the given message ids.
public fetchStructure ( string $folder, array $uids ) : array
$folder string The folder to fetch the messages from.
$uids array The message UIDs.
Результат array An array of message structures parsed into Horde_Mime_Part instances.

getAcl() публичный Метод

Retrieve the access rights for a folder.
public getAcl ( string $folder ) : array
$folder string The folder to retrieve the ACL for.
Результат array An array of rights.

getAnnotation() публичный Метод

Fetches the annotation from a folder.
public getAnnotation ( string $folder, string $annotation ) : string
$folder string The name of the folder.
$annotation string The annotation to get.
Результат string The annotation value.

getAuth() публичный Метод

Return the id of the user currently authenticated.
public getAuth ( ) : string
Результат string The id of the user that opened the connection.

getBackend() публичный Метод

If there is no driver set the driver should be constructed within this method.
public getBackend ( ) : mixed
Результат mixed The backend driver.

getId() публичный Метод

Return the unique connection id.
public getId ( ) : string
Результат string The connection id.

getMyAcl() публичный Метод

Retrieve the access rights the current user has on a folder.
public getMyAcl ( string $folder ) : string
$folder string The folder to retrieve the user ACL for.
Результат string The user rights.

getNamespace() публичный Метод

Retrieve the namespace information for this connection.
public getNamespace ( ) : Horde_Kolab_Storage_Driver_Namespace
Результат Horde_Kolab_Storage_Driver_Namespace The initialized namespace handler.

getParameters() публичный Метод

Return the connection parameters.
public getParameters ( ) : array
Результат array The connection parameters.

getStamp() публичный Метод

Returns a stamp for the current folder status. This stamp can be used to identify changes in the folder data.
public getStamp ( string $folder ) : Horde_Kolab_Storage_Folder_Stamp
$folder string Return the stamp for this folder.
Результат Horde_Kolab_Storage_Folder_Stamp A stamp indicating the current folder status.

getUids() публичный Метод

Returns the message ids of the messages in this folder.
public getUids ( string $folder ) : array
$folder string Check the status of this folder.
Результат array The message ids.

hasAclSupport() публичный Метод

Does the backend support ACL?
public hasAclSupport ( ) : boolean
Результат boolean True if the backend supports ACLs.

hasCatenateSupport() публичный Метод

Checks if the backend supports CATENATE.
public hasCatenateSupport ( ) : boolean
Результат boolean True if the backend supports CATENATE.

listAnnotation() публичный Метод

Retrieves the specified annotation for the complete list of folders.
public listAnnotation ( string $annotation ) : array
$annotation string The name of the annotation to retrieve.
Результат array An associative array combining the folder names as key with the corresponding annotation value.

listFolders() публичный Метод

Retrieves a list of folders from the server.
public listFolders ( ) : array
Результат array The list of folders.

moveMessage() публичный Метод

Moves a message to a new folder.
public moveMessage ( integer $uid, string $old_folder, string $new_folder ) : null
$uid integer IMAP message id.
$old_folder string Source folder.
$new_folder string Target folder.
Результат null

rename() публичный Метод

Rename the specified folder.
public rename ( string $old, string $new ) : null
$old string The folder to rename.
$new string The new name of the folder.
Результат null

setAcl() публичный Метод

Set the access rights for a folder.
public setAcl ( string $folder, string $user, string $acl ) : null
$folder string The folder to act upon.
$user string The user to set the ACL for.
$acl string The ACL.
Результат null

setAnnotation() публичный Метод

Sets the annotation on a folder.
public setAnnotation ( string $folder, string $annotation, array $value ) : null
$folder string The name of the folder.
$annotation string The annotation to set.
$value array The values to set
Результат null

setBackend() публичный Метод

Set the backend driver.
public setBackend ( mixed $backend ) : null
$backend mixed The driver that should be used.
Результат null

status() публичный Метод

Returns the status of the current folder.
public status ( string $folder ) : array
$folder string Check the status of this folder.
Результат array An array that contains 'uidvalidity' and 'uidnext'.