Class IMP_Imap_Acl

Contains functions related to managing IMAP Access Control Lists.

See the enclosed file COPYING for license information (GPL). If you did not receive this file, see http://www.horde.org/licenses/gpl.

Package: IMP
Category: Horde
License: GPL
Author: Chris Hastie imp@oak-wood.co.uk
Author: Michael Slusarz slusarz@horde.org
Located at Imap/Acl.php

Methods summary
`public`	# `__construct( )` Constructor. Constructor. Throws `IMP_Exception`
`public array`	# `getACL( IMP_Mailbox $mbox, boolean $user = false )` Retrieve the existing ACLs for a mailbox from the server. Retrieve the existing ACLs for a mailbox from the server. Parameters `$mbox` The mailbox to get the ACL for. `$user` Return only the current user's rights? Returns `array` If $user is false, see Horde_Imap_Client_Base::getACL(). If $user is true, see Horde_Imap_Client_Base::getMyACLRights(). Throws `IMP_Exception`
`public`	# `addRights( IMP_Mailbox $mbox, string $user, string $rights )` Adds rights to an ACL on the server. Adds rights to an ACL on the server. Parameters `$mbox` The mailbox on which to edit the ACL. `$user` The user to grant rights to. `$rights` The rights to add. Throws `IMP_Exception`
`public`	# `removeRights( IMP_Mailbox $mbox, string $user, string $rights )` Removes rights to an ACL on the server. Removes rights to an ACL on the server. Parameters `$mbox` The mailbox on which to edit the ACL. `$user` The user to remove rights from. `$rights` <p>The rights to remove. If empty, removes the entire ACL.</p> Throws `IMP_Exception`
`public boolean`	# `canEdit( IMP_Mailbox $mbox )` Can the current user edit the ACL for this mailbox? Can the current user edit the ACL for this mailbox? Parameters `$mbox` The mailbox name. Returns `boolean` True if the current user has administrative rights.
`public array`	# `getRights( )` Return master list of ACL rights. Return master list of ACL rights. Returns `array` A list of ACL rights. Keys are the right identifiers, values are arrays containing two entries: 'desc' and 'title'.
`public Horde_Imap_Client_Data_AclRights`	# `getRightsMbox( IMP_Mailbox $mbox, string $user )` Return list of rights available on the server. Return list of rights available on the server. Parameters `$mbox` The mailbox name. `$user` The ACL identifier (user) to query. Returns `Horde_Imap_Client_Data_AclRights` An ACL rights object.

Packages

Classes

Class IMP_Imap_Acl

Throws

Parameters

Returns

Throws

Parameters

Throws

Parameters

Throws

Parameters

Returns

Returns

Parameters

Returns