KIMAP::MyRightsJob

Search for usage in LXR

#include <myrightsjob.h>

Inheritance diagram for KIMAP::MyRightsJob:

Public Member Functions

 MyRightsJob (Session *session)
 
bool hasRightEnabled (Acl::Right right)
 
Acl::Rights rights ()
 
- 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

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

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.

Definition at line 42 of file myrightsjob.h.

Constructor & Destructor Documentation

◆ MyRightsJob()

MyRightsJob::MyRightsJob ( Session * session)
explicit

Definition at line 36 of file myrightsjob.cpp.

◆ ~MyRightsJob()

MyRightsJob::~MyRightsJob ( )
override

Definition at line 41 of file myrightsjob.cpp.

Member Function Documentation

◆ doStart()

void MyRightsJob::doStart ( )
overrideprotected

Definition at line 45 of file myrightsjob.cpp.

◆ handleResponse()

void MyRightsJob::handleResponse ( const Response & response)
overrideprotected

Definition at line 52 of file myrightsjob.cpp.

◆ hasRightEnabled()

bool MyRightsJob::hasRightEnabled ( 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.

Parameters
rightthe right to check for

Definition at line 63 of file myrightsjob.cpp.

◆ rights()

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.

Definition at line 69 of file myrightsjob.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Jun 21 2024 11:59:25 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.