Overview

Packages

  • Kolab
    • Storage

Classes

  • Horde_Kolab_Storage_Base
  • Horde_Kolab_Storage_Cache
  • Horde_Kolab_Storage_Cache_Data
  • Horde_Kolab_Storage_Cache_List
  • Horde_Kolab_Storage_Cached
  • Horde_Kolab_Storage_Data_Base
  • Horde_Kolab_Storage_Data_Cached
  • Horde_Kolab_Storage_Data_Decorator_Log
  • Horde_Kolab_Storage_Data_Format_Mime
  • Horde_Kolab_Storage_Data_Modifiable
  • Horde_Kolab_Storage_Data_Old
  • Horde_Kolab_Storage_Data_Parser_Structure
  • Horde_Kolab_Storage_Data_Query_History_Base
  • Horde_Kolab_Storage_Data_Query_History_Cache
  • Horde_Kolab_Storage_Data_Query_Preferences_Base
  • Horde_Kolab_Storage_Data_Query_Preferences_Cache
  • Horde_Kolab_Storage_Decorator_Synchronization
  • Horde_Kolab_Storage_Driver_Base
  • Horde_Kolab_Storage_Driver_Cclient
  • Horde_Kolab_Storage_Driver_Decorator_Base
  • Horde_Kolab_Storage_Driver_Decorator_Log
  • Horde_Kolab_Storage_Driver_Decorator_Timer
  • Horde_Kolab_Storage_Driver_Imap
  • Horde_Kolab_Storage_Driver_Mock
  • Horde_Kolab_Storage_Driver_Mock_Data
  • Horde_Kolab_Storage_Driver_Pear
  • Horde_Kolab_Storage_Driver_Rcube
  • Horde_Kolab_Storage_Exception
  • Horde_Kolab_Storage_Exception_Pear
  • Horde_Kolab_Storage_Factory
  • Horde_Kolab_Storage_Folder_Base
  • Horde_Kolab_Storage_Folder_Decorator_Base
  • Horde_Kolab_Storage_Folder_Decorator_Trigger
  • Horde_Kolab_Storage_Folder_Namespace
  • Horde_Kolab_Storage_Folder_Namespace_Config
  • Horde_Kolab_Storage_Folder_Namespace_Element
  • Horde_Kolab_Storage_Folder_Namespace_Element_Other
  • Horde_Kolab_Storage_Folder_Namespace_Element_Personal
  • Horde_Kolab_Storage_Folder_Namespace_Element_Shared
  • Horde_Kolab_Storage_Folder_Namespace_Element_SharedWithPrefix
  • Horde_Kolab_Storage_Folder_Namespace_Fixed
  • Horde_Kolab_Storage_Folder_Namespace_Imap
  • Horde_Kolab_Storage_Folder_Stamp_Uids
  • Horde_Kolab_Storage_Folder_Type
  • Horde_Kolab_Storage_List_Base
  • Horde_Kolab_Storage_List_Decorator_Cache
  • Horde_Kolab_Storage_List_Decorator_Log
  • Horde_Kolab_Storage_List_Query_Acl_Base
  • Horde_Kolab_Storage_List_Query_Acl_Cache
  • Horde_Kolab_Storage_List_Query_ActiveSync_Base
  • Horde_Kolab_Storage_List_Query_ActiveSync_Cache
  • Horde_Kolab_Storage_List_Query_List_Base
  • Horde_Kolab_Storage_List_Query_List_Cache
  • Horde_Kolab_Storage_List_Query_Share_Base
  • Horde_Kolab_Storage_List_Query_Share_Cache
  • Horde_Kolab_Storage_QuerySet_Base
  • Horde_Kolab_Storage_QuerySet_Cached
  • Horde_Kolab_Storage_QuerySet_Uncached
  • Horde_Kolab_Storage_Synchronization
  • Horde_Kolab_Storage_Translation
  • Horde_Kolab_Storage_Uncached

Interfaces

  • Horde_Kolab_Storage
  • Horde_Kolab_Storage_Data
  • Horde_Kolab_Storage_Data_Format
  • Horde_Kolab_Storage_Data_Parser
  • Horde_Kolab_Storage_Data_Query
  • Horde_Kolab_Storage_Data_Query_History
  • Horde_Kolab_Storage_Data_Query_Preferences
  • Horde_Kolab_Storage_Driver
  • Horde_Kolab_Storage_Folder
  • Horde_Kolab_Storage_Folder_Stamp
  • Horde_Kolab_Storage_List
  • Horde_Kolab_Storage_List_Query
  • Horde_Kolab_Storage_List_Query_Acl
  • Horde_Kolab_Storage_List_Query_ActiveSync
  • Horde_Kolab_Storage_List_Query_List
  • Horde_Kolab_Storage_List_Query_Share
  • Horde_Kolab_Storage_Queriable
  • Horde_Kolab_Storage_Query
  • Horde_Kolab_Storage_QuerySet
  • Overview
  • Package
  • Class
  • Tree

Class Horde_Kolab_Storage_Driver_Imap

The IMAP driver class for accessing Kolab storage.

Copyright 2009-2012 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.

Horde_Kolab_Storage_Driver_Base implements Horde_Kolab_Storage_Driver
Extended by Horde_Kolab_Storage_Driver_Imap
Package: Kolab\Storage
Category: Kolab
License: LGPL 2.1
Author: Gunnar Wrobel wrobel@pardus.de
Link: http://pear.horde.org/index.php?package=Kolab_Storage
Located at Horde/Kolab/Storage/Driver/Imap.php
Methods summary
public mixed
# createBackend( )

Create the backend driver.

Create the backend driver.

Returns

mixed
The backend driver.
public array
# listFolders( )

Retrieves a list of folders from the server.

Retrieves a list of folders from the server.

Returns

array
The list of folders.
public null
# create( string $folder )

Create the specified folder.

Create the specified folder.

Parameters

$folder
The folder to create.

Returns

null
public null
# delete( string $folder )

Delete the specified folder.

Delete the specified folder.

Parameters

$folder
The folder to delete.

Returns

null
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
public boolean
# hasAclSupport( )

Does the backend support ACL?

Does the backend support ACL?

Returns

boolean
True if the backend supports ACLs.
public An
# getAcl( Horde_Kolab_Storage_Folder $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

An
array of rights.
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.
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
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
public array
# listAnnotation( string $annotation )

Retrieves the specified annotation for the complete list of folders.

Retrieves the specified annotation for the complete list of folders.

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.
public string
# getAnnotation( string $folder, string $annotation )

Fetches the annotation from a folder.

Fetches the annotation from a folder.

Parameters

$folder
The name of the folder.
$annotation
The annotation to get.

Returns

string
The annotation value.
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
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.

Overrides

Horde_Kolab_Storage_Driver_Base::getNamespace()
public null
# select( string $folder, mixed $mode = Horde_Imap_Client::OPEN_AUTO )

Opens the given folder.

Opens the given folder.

Parameters

$folder
The folder to open
$mode

Returns

null
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'.
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.
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.

Overrides

Horde_Kolab_Storage_Driver_Base::fetchComplete()
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.

Overrides

Horde_Kolab_Storage_Driver_Base::fetchStructure()
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.

Overrides

Horde_Kolab_Storage_Driver_Base::fetchBodypart()
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.
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
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
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
Methods inherited from Horde_Kolab_Storage_Driver_Base
__construct(), fetch(), getAuth(), getBackend(), getId(), getModifiable(), getParam(), getParameters(), getParams(), getParser(), getStamp(), hasCatenateSupport(), setBackend(), setParam(), setParser()
API documentation generated by ApiGen