KIMAP::MyRightsJob Class

Determine the rights the currently-logged-in user has on the current mailbox. More...

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

Public Functions

MyRightsJob(KIMAP::Session *session)
virtual ~MyRightsJob() override
bool hasRightEnabled(KIMAP::Acl::Right right)
Acl::Rights rights()

Reimplemented Protected Functions

virtual void doStart() override
virtual void handleResponse(const KIMAP::Response &response) override

Detailed Description

This should take into account the full access control list.

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

The current user must have one of the following rights on the mailbox for this job to succeed:

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

Member Function Documentation

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

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

[override virtual protected] void MyRightsJob::doStart()

[override virtual protected] void MyRightsJob::handleResponse(const KIMAP::Response &response)

bool MyRightsJob::hasRightEnabled(KIMAP::Acl::Right right)

Check whether the current user has the a particular right on the mailbox.

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

right the right to check for

Acl::Rights MyRightsJob::rights()

Get the rights for the current user on the mailbox.

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