| Метод | Описание | |
|---|---|---|
| __construct ( Horde_Kolab_Storage_Factory $factory, array $params = [] ) | Constructor. | |
| 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 | Retrieves a bodypart for the given message ID and mime part ID. | |
| fetchComplete ( string $folder, array $uid ) : array | Retrieves a complete message. | |
| 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. | |
| getId ( ) : string | Return the unique connection id. | |
| getMyAcl ( string $folder ) : string | Retrieve the access rights the current user has on a folder. | |
| getUids ( string $folder ) : array | Returns the message ids of the messages in this folder. | |
| hasAclSupport ( ) : boolean | Does the backend support ACL? | |
| listAnnotation ( string $annotation ) : array | Retrieves the specified annotation for the complete list of folders. | |
| listFolders ( ) : array | Retrieves a list of folders on 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. | |
| select ( string $folder ) : null | Opens the given 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. | |
| setGroups ( array $groups ) : null | Set a group list. | |
| status ( string $folder ) : array | Returns the status of the current folder. |
| Метод | Описание | |
|---|---|---|
| _convertToExternal ( string $mbox ) : string | Convert the internal folder name into an external folder id. | |
| _convertToInternal ( string $folder ) : string | Convert the external folder id to an internal folder name. | |
| _failOnMissingFolder ( string $folder ) : null | Error out in case the provided folder is missing. | |
| _failOnNoAdmin ( string $folder ) : null | Error out in case the user is no admin of the specified folder. | |
| _folderAdmin ( string $folder, string $user ) : boolean | Is the user a folder admin (or one of the global groups)? | |
| _folderAdminForGroup ( string $folder, string $user ) : boolean | Is the folder visible to a group the user belongs to? | |
| _folderAdminForUnique ( string $folder, string $user ) : boolean | Is the exact specified user an admin for the folder? | |
| _folderMissing ( string $folder ) : null | Error out indicating that the user does not have the required permissions. | |
| _folderVisible ( string $folder, string $user ) : boolean | Is the folder visible to the specified user (or a global group)? | |
| _folderVisibleToGroup ( string $folder, string $user ) : boolean | Is the folder visible to a group the user belongs to? | |
| _folderVisibleToUnique ( string $folder, string $user ) : boolean | Is the folder visible to exactly the specified user? | |
| _permissionDenied ( ) : null | Error out indicating that the user does not have the required permissions. |
| public __construct ( Horde_Kolab_Storage_Factory $factory, array $params = [] ) | ||
| $factory | Horde_Kolab_Storage_Factory | A factory for helper objects. |
| $params | array | Connection parameters. |
| 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. |
| public createBackend ( ) : mixed | ||
| Результат | mixed | The backend driver. |
| public hasAclSupport ( ) : boolean | ||
| Результат | boolean | True if the backend supports ACLs. |
| 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. |
| public listFolders ( ) : array | ||
| Результат | array | The list of folders. |