KIMAP::GetAclJob

#include <getacljob.h>

Inheritance diagram for KIMAP::GetAclJob:

Public Member Functions

 GetAclJob (Session *session)
 
QMap< QByteArray, Acl::RightsallRights () const
 
bool hasRightEnabled (const QByteArray &identifier, Acl::Right right) const
 
QList< QByteArrayidentifiers () const
 
Acl::Rights rights (const QByteArray &identifier) const
 
- Public Member Functions inherited from KIMAP::AclJobBase
 AclJobBase (Session *session)
 
QString mailBox () const
 
void setMailBox (const QString &mailBox)
 

Protected Member Functions

void doStart () override
 
void handleResponse (const Response &response) override
 
- Protected Member Functions inherited from KIMAP::AclJobBase
 AclJobBase (JobPrivate &dd)
 

Additional Inherited Members

- Public Types inherited from KIMAP::AclJobBase
enum  AclModifier { Add = 0, Remove, Change }
 

Detailed Description

Gets the ACL for a mailbox.

This job can only be run when the session is in the authenticated (or selected) state.

The user must have the Acl::Admin permission on the mailbox for this job to succeed (see MyRightsJob).

This job requires that the server supports the ACL capability, defined in RFC 4314.

The meaning of identifiers depends on the server implementation, with the following restrictions:

  • "anyone" means any authenticated user, including anonymous
  • an identifier starting with a minus sign ('-') indicates "negative rights": rights that should be taken away from matching users

Other than the above restrictions, ACL identifiers are usually IMAP usernames, but could potentially be group names as well.

Note that negative rights override positive rights: if "fred" and "-fred" are both assigned the 'w' right, the user "fred" will not have the 'w' right.

Definition at line 50 of file getacljob.h.

Member Function Documentation

QMap< QByteArray, Acl::Rights > GetAclJob::allRights ( ) const

Gets the full access control list.

The result of this method is undefined if the job has not yet completed.

See the GetAclJob documentation for an explanation of identifiers; in particular, identifiers starting with '-' specify negative rights.

Definition at line 93 of file getacljob.cpp.

bool GetAclJob::hasRightEnabled ( const QByteArray identifier,
Acl::Right  right 
) const

Check whether an identifier has a given right set.

The result of this method is undefined if the job has not yet completed.

See the GetAclJob documentation for an explanation of identifiers; in particular, identifiers starting with '-' specify negative rights.

Note that this will not tell you whether the net result of all the ACL entries means that a given user has a certain right.

Parameters
identifierthe identifier to check the rights for
rightthe right to check for

Definition at line 72 of file getacljob.cpp.

QList< QByteArray > GetAclJob::identifiers ( ) const

The identifiers present in the ACL.

This method will return an empty list if the job has not yet been run.

See the GetAclJob documentation for an explanation of identifiers; in particular, identifiers starting with '-' specify negative rights.

Definition at line 66 of file getacljob.cpp.

Acl::Rights GetAclJob::rights ( const QByteArray identifier) const

Get the rights associated with an identifier.

The result of this method is undefined if the job has not yet completed.

See the GetAclJob documentation for an explanation of identifiers; in particular, identifiers starting with '-' specify negative rights.

Note that this will not tell you the rights that a given user will have once all the ACL entries have been taken into account.

Parameters
identifierthe identifier to check the rights for

Definition at line 83 of file getacljob.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Thu Oct 22 2020 23:15:43 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.