Methods summary
public
|
|
public
string
|
#
getDriverName( )
Return the class name of the decorated driver.
Return the class name of the decorated driver.
Returns
string The class name of the decorated driver.
|
public
mixed
|
#
createBackend( )
Create the backend driver.
Create the backend driver.
Returns
mixed The backend driver.
Implementation of
|
public
mixed
|
#
getBackend( )
Returns the actual backend driver.
Returns the actual backend driver.
If there is no driver set the driver should be constructed within this
method.
Returns
mixed The backend driver.
Implementation of
|
public
null
|
#
setBackend( mixed $backend )
Set the backend driver.
Parameters
- $backend
- The driver that should be used.
Returns
null
Implementation of
|
public
Horde_Kolab_Storage_Data_Parser
|
#
getParser( )
Returns the parser for data objects.
Returns the parser for data objects.
Returns
Implementation of
|
public
null
|
|
public
string
|
#
getAuth( )
Return the id of the user currently authenticated.
Return the id of the user currently authenticated.
Returns
string The id of the user that opened the connection.
Implementation of
|
public
string
|
#
getId( )
Return the unique connection id.
Return the unique connection id.
Returns
string The connection id.
Implementation of
|
public
array
|
#
getParameters( )
Return the connection parameters.
Return the connection parameters.
Returns
array The connection parameters.
Implementation of
|
public
boolean
|
#
hasCatenateSupport( )
Checks if the backend supports CATENATE.
Checks if the backend supports CATENATE.
Returns
boolean True if the backend supports CATENATE.
Implementation of
|
public
array
|
#
listFolders( )
Retrieves a list of mailboxes from the server.
Retrieves a list of mailboxes from the server.
Returns
array The list of mailboxes.
Implementation of
|
public
null
|
#
create( string $folder )
Create the specified folder.
Create the specified folder.
Parameters
- $folder
- The folder to create.
Returns
null
Implementation of
|
public
null
|
#
delete( string $folder )
Delete the specified folder.
Delete the specified folder.
Parameters
- $folder
- The folder to delete.
Returns
null
Implementation of
|
public
null
|
#
rename( string $old, string $new )
Rename the specified folder.
Rename the specified folder.
Parameters
- $old
- The folder to rename.
- $new
- The new name of the folder.
Returns
null
Implementation of
|
public
boolean
|
#
hasAclSupport( )
Does the backend support ACL?
Does the backend support ACL?
Returns
boolean True if the backend supports ACLs.
Implementation of
|
public
array
|
#
getAcl( string $folder )
Retrieve the access rights for a folder.
Retrieve the access rights for a folder.
Parameters
- $folder
- The folder to retrieve the ACL for.
Returns
array An array of rights.
Implementation of
|
public
string
|
#
getMyAcl( string $folder )
Retrieve the access rights the current user has on a folder.
Retrieve the access rights the current user has on a folder.
Parameters
- $folder
- The folder to retrieve the user ACL for.
Returns
string The user rights.
Implementation of
|
public
null
|
#
setAcl( string $folder, string $user, string $acl )
Set the access rights for a folder.
Set the access rights for a folder.
Parameters
- $folder
- The folder to act upon.
- $user
- The user to set the ACL for.
- $acl
- The ACL.
Returns
null
Implementation of
|
public
null
|
#
deleteAcl( string $folder, string $user )
Delete the access rights for user on a folder.
Delete the access rights for user on a folder.
Parameters
- $folder
- The folder to act upon.
- $user
- The user to delete the ACL for
Returns
null
Implementation of
|
public
array
|
#
listAnnotation( string $annotation )
Retrieves the specified annotation for the complete list of mailboxes.
Retrieves the specified annotation for the complete list of mailboxes.
Parameters
- $annotation
- The name of the annotation to retrieve.
Returns
array An associative array combining the folder names as key with
the corresponding annotation value.
Implementation of
|
public
string
|
#
getAnnotation( string $entry, string $folder )
Fetches the annotation on a folder.
Fetches the annotation on a folder.
Parameters
- $entry
- The entry to fetch.
- $folder
- The name of the folder.
Returns
string The annotation value.
Implementation of
|
public
null
|
#
setAnnotation( string $folder, string $annotation, array $value )
Sets the annotation on a folder.
Sets the annotation on a folder.
Parameters
- $folder
- The name of the folder.
- $annotation
- The annotation to set.
- $value
- The values to set
Returns
null
Implementation of
|
public
Horde_Kolab_Storage_Driver_Namespace
|
#
getNamespace( )
Retrieve the namespace information for this connection.
Retrieve the namespace information for this connection.
Returns
Horde_Kolab_Storage_Driver_Namespace The initialized namespace handler.
Implementation of
|
public
Horde_Kolab_Storage_Folder_Stamp
|
#
getStamp( string $folder )
Returns a stamp for the current folder status. This stamp can be used to
identify changes in the folder data.
Returns a stamp for the current folder status. This stamp can be used to
identify changes in the folder data.
Parameters
- $folder
- Return the stamp for this folder.
Returns
Implementation of
|
public
array
|
#
status( string $folder )
Returns the status of the current folder.
Returns the status of the current folder.
Parameters
- $folder
- Check the status of this folder.
Returns
array An array that contains 'uidvalidity' and 'uidnext'.
Implementation of
|
public
array
|
#
getUids( string $folder )
Returns the message ids of the messages in this folder.
Returns the message ids of the messages in this folder.
Parameters
- $folder
- Check the status of this folder.
Returns
array The message ids.
Implementation of
|
public
array
|
#
fetch( string $folder, array $uids, array $options = array() )
Fetches the objects for the specified UIDs.
Fetches the objects for the specified UIDs.
Parameters
- $folder
- The folder to access.
- $uids
- The message UIDs.
- $options
- Additional options.
<pre>- type - (string) The data type.
- version - (int) The format version.
- raw - (bool) Should the raw data be returned?</pre>
Returns
array The parsed objects.
Implementation of
|
public
array
|
#
fetchStructure( string $folder, array $uids )
Retrieves the messages for the given message ids.
Retrieves the messages for the given message ids.
Parameters
- $folder
- The folder to fetch the messages from.
- $uids
- The message UIDs.
Returns
array An array of message structures parsed into Horde_Mime_Part
instances.
Implementation of
|
public
resource|string
|
#
fetchBodypart( string $folder, array $uid, array $id )
Retrieves a bodypart for the given message ID and mime part ID.
Retrieves a bodypart for the given message ID and mime part ID.
Parameters
- $folder
- The folder to fetch the messages from.
- $uid
- The message UID.
- $id
- The mime part ID.
Returns
resource|string The body part, as a stream resource or string.
Implementation of
|
public
array
|
#
fetchComplete( string $folder, array $uid )
Retrieves a complete message.
Retrieves a complete message.
Parameters
- $folder
- The folder to fetch the messages from.
- $uid
- The message UID.
Returns
array The message encapsuled as an array that contains a
Horde_Mime_Headers and a Horde_Mime_Part object.
Implementation of
|
public
mixed
|
#
appendMessage( string $folder, resource $msg )
Appends a message to the given folder.
Appends a message to the given folder.
Parameters
- $folder
- The folder to append the message(s) to.
- $msg
- The message to append.
Returns
mixed True or the UID of the new message in case the backend
supports UIDPLUS.
Implementation of
|
public
null
|
#
deleteMessages( string $folder, integer $uids )
Deletes messages from the specified folder.
Deletes messages from the specified folder.
Parameters
- $folder
- The folder to delete messages from.
- $uids
- IMAP message ids.
Returns
null
Implementation of
|
public
null
|
#
moveMessage( integer $uid, string $old_folder, string $new_folder )
Moves a message to a new folder.
Moves a message to a new folder.
Parameters
- $uid
- IMAP message id.
- $old_folder
- Source folder.
- $new_folder
- Target folder.
Returns
null
Implementation of
|
public
null
|
#
expunge( string $folder )
Expunges messages in the current folder.
Expunges messages in the current folder.
Parameters
- $folder
- The folder to expunge.
Returns
null
Implementation of
|