KIMAP::ListRightsJob Class

Lists the possible and automatic rights for an identifier on a mailbox. More...

Header: #include <KIMAP/ListRightsJob>
CMake: find_package(KPim6IMAP REQUIRED)
target_link_libraries(mytarget PRIVATE KPim6::IMAP)
Inherits: KIMAP::AclJobBase

Public Functions

ListRightsJob(KIMAP::Session *session)
virtual ~ListRightsJob() override
Acl::Rights defaultRights()
QByteArray identifier()
QList<Acl::Rights> possibleRights()
void setIdentifier(const QByteArray &identifier)

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.

Member Function Documentation

[explicit] ListRightsJob::ListRightsJob(KIMAP::Session *session)

[override virtual noexcept] ListRightsJob::~ListRightsJob()

Acl::Rights ListRightsJob::defaultRights()

The rights that will always be assigned to the identifier, regardless of the access control list.

For example, under the UNIX permission model, the owner of a mailbox will always have the Acl::Admin right.

QByteArray ListRightsJob::identifier()

The identifier that will be looked up

See also setIdentifier().

QList<Acl::Rights> ListRightsJob::possibleRights()

The rights it is possible to assign to the identifier.

The rights are grouped by those that are tied together. For each set of rights in the returned list, either all or none of those rights may be set, but not only some of them.

For example, under the UNIX permission model, the following rights are all controlled by the "write" flag, and hence must either all be set or all be not set:

void ListRightsJob::setIdentifier(const QByteArray &identifier)

Sets the identifier that should be looked up

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.

identifier the identifier to list the rights for

See also identifier().