| Property | Type | Description | |
|---|---|---|---|
| $_namespace | Horde_Kolab_Storage_Folder_Namespace | Memory cache for the namespace of this driver. | |
| $charset | string | Charset used by this driver. |
| Method | Description | |
|---|---|---|
| __construct ( Horde_Kolab_Storage_Factory $factory, array $params = [] ) | Constructor. | |
| fetchBodypart ( string $mailbox, 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. | |
| fetchHeaders ( string $folder, array $uid ) : Horde_Mime_Headers | Retrieves the message headers. | |
| fetchStructure ( string $mailbox, array $uids ) : Horde_Mime_Part | Retrieves the messages for the given message ids. | |
| getAuth ( ) : string | Return the id of the user currently authenticated. | |
| getBackend ( ) : mixed | Returns the actual backend driver. | |
| getId ( ) : string | Return the unique connection id. | |
| getModifiable ( string $folder, string $obid, array $object ) : Horde_Kolab_Storage_Driver_Modifiable | Return a modifiable message object. | |
| getNamespace ( ) : Horde_Kolab_Storage_Folder_Namespace | Retrieve the namespace information for this connection. | |
| getParam ( string $key, mixed $default = null ) : mixed | Return a parameter setting for this connection. | |
| getParameters ( ) : array | Return the connection parameters. | |
| getParams ( ) : array | Return all parameter settings for this connection. | |
| 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. | |
| getStampFromToken ( string $folder, string $token, array $ids ) : 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. This method, as opposed to self::getStamp(), uses the IMAP client's token to calculate the changes. | |
| hasCatenateSupport ( ) : boolean | Checks if the backend supports CATENATE. | |
| setBackend ( mixed $backend ) : null | Set the backend driver. | |
| setParam ( string $key, mixed $value ) : null | Set a parameter setting for this connection. |
| Method | Description | |
|---|---|---|
| _getAnnotateMoreEntry ( string $name ) : array | Split a name for the METADATA extension into the correct syntax for the older ANNOTATEMORE version. | |
| decodeList ( array $list ) : array | Decode a list of IMAP path names from the driver charset to UTF-8. | |
| decodeListKeys ( array $list ) : array | Decode the keys of a list of IMAP path names from the driver charset to UTF-8. | |
| decodePath ( string $path ) : string | Decode IMAP path names from the driver charset to UTF-8. | |
| encodePath ( string $path ) : string | Encode IMAP path names from UTF-8 to the driver charset. | |
| getFactory ( ) : Horde_Kolab_Storage_Factory | Return the factory. |
| public __construct ( Horde_Kolab_Storage_Factory $factory, array $params = [] ) | ||
| $factory | Horde_Kolab_Storage_Factory | A factory for helper objects. |
| $params | array | Connection parameters. |
| protected _getAnnotateMoreEntry ( string $name ) : array | ||
| $name | string | A name for a metadata entry. |
| return | array | A list of two elements: The entry name and the value type. |
| protected decodeList ( array $list ) : array | ||
| $list | array | The the driver charset encoded path names. |
| return | array | The path names in UTF-8. |
| protected decodeListKeys ( array $list ) : array | ||
| $list | array | The list with the driver charset encoded path names as keys. |
| return | array | The list with path names in UTF-8 as keys. |
| protected decodePath ( string $path ) : string | ||
| $path | string | The the driver charset encoded path name. |
| return | string | The path name in UTF-8. |
| protected encodePath ( string $path ) : string | ||
| $path | string | The UTF-8 encoded path name. |
| return | string | The path name in the driver charset. |
| public fetchHeaders ( string $folder, array $uid ) : Horde_Mime_Headers | ||
| $folder | string | The folder to fetch the message from. |
| $uid | array | The message UID. |
| return | Horde_Mime_Headers | The message headers. |
| public fetchStructure ( string $mailbox, array $uids ) : Horde_Mime_Part | ||
| $mailbox | string | The mailbox to fetch the messages from. |
| $uids | array | The message UIDs. |
| return | Horde_Mime_Part | The message structure parsed into a Horde_Mime_Part instance. |
| public getBackend ( ) : mixed | ||
| return | mixed | The backend driver. |
| protected getFactory ( ) : Horde_Kolab_Storage_Factory | ||
| return | Horde_Kolab_Storage_Factory | The factory. |
| public getModifiable ( string $folder, string $obid, array $object ) : Horde_Kolab_Storage_Driver_Modifiable | ||
| $folder | string | The folder to access. |
| $obid | string | The backend ID of the object to retrieve from the folder. |
| $object | array | The object data. |
| return | Horde_Kolab_Storage_Driver_Modifiable | The modifiable message object. |
| public getNamespace ( ) : Horde_Kolab_Storage_Folder_Namespace | ||
| return | Horde_Kolab_Storage_Folder_Namespace | The initialized namespace handler. |
| public getParameters ( ) : array | ||
| return | array | The connection parameters. |
| public getStampFromToken ( string $folder, string $token, array $ids ) : Horde_Kolab_Storage_Folder_Stamp | ||
| $folder | string | Return the stamp for this folder. |
| $token | string | A sync token provided by the IMAP server. |
| $ids | array | An array of UIDs that we know about. |
| return | Horde_Kolab_Storage_Folder_Stamp | A stamp indicating the current folder status. |
| public hasCatenateSupport ( ) : boolean | ||
| return | boolean | True if the backend supports CATENATE. |
| public setBackend ( mixed $backend ) : null | ||
| $backend | mixed | The driver that should be used. |
| return | null | |
| protected Horde_Kolab_Storage_Folder_Namespace $_namespace | ||
| return | Horde_Kolab_Storage_Folder_Namespace | |
