KIMAP::GetAclJob Class
Gets the ACL for a mailbox. More...
| Header: | #include <KIMAP/GetAclJob> |
| CMake: | find_package(KPim6IMAP REQUIRED)target_link_libraries(mytarget PRIVATE KPim6::IMAP) |
| Inherits: | KIMAP::AclJobBase |
Public Functions
| GetAclJob(KIMAP::Session *session) | |
| virtual | ~GetAclJob() override |
| QMap<QByteArray, Acl::Rights> | allRights() const |
| bool | hasRightEnabled(const QByteArray &identifier, KIMAP::Acl::Right right) const |
| QList<QByteArray> | identifiers() const |
| Acl::Rights | rights(const QByteArray &identifier) const |
Reimplemented Protected Functions
| virtual void | doStart() override |
| virtual void | handleResponse(const KIMAP::Response &response) override |
Detailed Description
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.
Member Function Documentation
[explicit] GetAclJob::GetAclJob(KIMAP::Session *session)
[override virtual noexcept] GetAclJob::~GetAclJob()
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.
[override virtual protected] void GetAclJob::doStart()
[override virtual protected] void GetAclJob::handleResponse(const KIMAP::Response &response)
bool GetAclJob::hasRightEnabled(const QByteArray &identifier, KIMAP::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.
identifier the identifier to check the rights for
right the right to check for
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.
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.
identifier the identifier to check the rights for