PHP Class IMP_Imap_Acl, horde

Author: Chris Hastie ([email protected])

Author: Michael Slusarz ([email protected])

Protected Properties

Property	Type	Description
$_cache	array	Cached data for getRightsMbox().

Method	Description
addRights ( IMP_Mailbox $mbox, string $user, string $rights )	Adds rights to an ACL on the server.
canEdit ( IMP_Mailbox $mbox ) : boolean	Can the current user edit the ACL for this mailbox?
getACL ( IMP_Mailbox $mbox, boolean $user = false ) : mixed	Retrieve the existing ACLs for a mailbox from the server.
getRights ( ) : array	Return master list of ACL rights.
getRightsMbox ( IMP_Mailbox $mbox, string $user ) : Horde_Imap_Client_Data_AclRights	Return list of rights available on the server.
removeRights ( IMP_Mailbox $mbox, string $user, string $rights )	Removes rights to an ACL on the server.

Adds rights to an ACL on the server.

public addRights ( IMP_Mailbox $mbox, string $user, string $rights )
$mbox	IMP_Mailbox	The mailbox on which to edit the ACL.
$user	string	The user to grant rights to.
$rights	string	The rights to add.

Can the current user edit the ACL for this mailbox?

public canEdit ( IMP_Mailbox $mbox ) : boolean
$mbox	IMP_Mailbox	The mailbox name.
return	boolean	True if the current user has administrative rights.

Retrieve the existing ACLs for a mailbox from the server.

public getACL ( IMP_Mailbox $mbox, boolean $user = false ) : mixed
$mbox	IMP_Mailbox	The mailbox to get the ACL for.
$user	boolean	Return only the current user's rights?
return	mixed	If $user is false, see Horde_Imap_Client_Base::getACL(). If $user is true, see Horde_Imap_Client_Base::getMyACLRights().

Return master list of ACL rights.

public getRights ( ) : array
return	array	A list of ACL rights. Keys are the right identifiers, values are arrays containing two entries: 'desc' and 'title'.

Return list of rights available on the server.

public getRightsMbox ( IMP_Mailbox $mbox, string $user ) : Horde_Imap_Client_Data_AclRights
$mbox	IMP_Mailbox	The mailbox name.
$user	string	The ACL identifier (user) to query.
return	Horde_Imap_Client_Data_AclRights	An ACL rights object.

Removes rights to an ACL on the server.

public removeRights ( IMP_Mailbox $mbox, string $user, string $rights )
$mbox	IMP_Mailbox	The mailbox on which to edit the ACL.
$user	string	The user to remove rights from.
$rights	string	The rights to remove. If empty, removes the entire ACL.

Cached data for getRightsMbox().

protected array $_cache
return	array