IMP_Imap_Acl
in package
Management of IMAP Access Control Lists.
Tags
Table of Contents
Properties
- $_cache : array<string|int, mixed>
- Cached data for getRightsMbox().
Methods
- addRights() : mixed
- Adds rights to an ACL on the server.
- canEdit() : bool
- Can the current user edit the ACL for this mailbox?
- getACL() : mixed
- Retrieve the existing ACLs for a mailbox from the server.
- getRights() : array<string|int, mixed>
- Return master list of ACL rights.
- getRightsMbox() : Horde_Imap_Client_Data_AclRights
- Return list of rights available on the server.
- removeRights() : mixed
- Removes rights to an ACL on the server.
Properties
$_cache
Cached data for getRightsMbox().
protected
array<string|int, mixed>
$_cache
= array()
Methods
addRights()
Adds rights to an ACL on the server.
public
addRights(IMP_Mailbox $mbox, string $user, string $rights) : mixed
Parameters
- $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.
Tags
canEdit()
Can the current user edit the ACL for this mailbox?
public
canEdit(IMP_Mailbox $mbox) : bool
Parameters
- $mbox : IMP_Mailbox
-
The mailbox name.
Return values
bool —True if the current user has administrative rights.
getACL()
Retrieve the existing ACLs for a mailbox from the server.
public
getACL(IMP_Mailbox $mbox[, bool $user = false ]) : mixed
Parameters
- $mbox : IMP_Mailbox
-
The mailbox to get the ACL for.
- $user : bool = false
-
Return only the current user's rights?
Tags
Return values
mixed —If $user is false, see Horde_Imap_Client_Base::getACL(). If $user is true, see Horde_Imap_Client_Base::getMyACLRights().
getRights()
Return master list of ACL rights.
public
getRights() : array<string|int, mixed>
Return values
array<string|int, mixed> —A list of ACL rights. Keys are the right identifiers, values are arrays containing two entries: 'desc' and 'title'.
getRightsMbox()
Return list of rights available on the server.
public
getRightsMbox(IMP_Mailbox $mbox, string $user) : Horde_Imap_Client_Data_AclRights
Parameters
- $mbox : IMP_Mailbox
-
The mailbox name.
- $user : string
-
The ACL identifier (user) to query.
Return values
Horde_Imap_Client_Data_AclRights —An ACL rights object.
removeRights()
Removes rights to an ACL on the server.
public
removeRights(IMP_Mailbox $mbox, string $user, string $rights) : mixed
Parameters
- $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.