PHP 클래스 Horde_Kolab_Storage_Driver_Pear, horde

링크 보기: http://pear.horde.org/index.php?package=Kolab_Storage

저자: Gunnar Wrobel ([email protected])

상속: extends Horde_Kolab_Storage_Driver_Base

공개 메소드들

메소드	설명
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 ( $folder ) : mixed	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.
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.
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.
status ( string $folder ) : array	Returns the status of the current folder.

보호된 메소드들

메소드	설명
_parseStructure ( object $data ) : Horde_Mime_Part	Parse the output from imap_fetchstructure() into a MIME Part object.

메소드 상세

_parseStructure() 보호된 메소드

Parse the output from imap_fetchstructure() into a MIME Part object.

protected _parseStructure ( object $data ) : Horde_Mime_Part
$data	object	Data from imap_fetchstructure().
리턴	Horde_Mime_Part	A MIME Part object.

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 ( $folder ) : mixed
리턴	mixed	True or a PEAR error in case of an error.

fetchBodypart() 공개 메소드

Retrieves a bodypart for the given message ID and mime part ID.

public fetchBodypart ( string $folder, array $uid, array $id ) : resource
$folder	string	The folder to fetch the messages from.
$uid	array	The message UID.
$id	array	The mime part ID.
리턴	resource	The body part, as a stream resource.

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.

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.

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.

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.

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 on 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

select() 공개 메소드

Opens the given folder.

public select ( string $folder ) : null
$folder	string	The folder to open
리턴	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

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', 'uidnext', and 'token'.