• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.14.10 API Reference
  • KDE Home
  • Contact Us
 

KIMAP Library

  • KIMAP
  • MyRightsJob
Public Member Functions | Protected Member Functions | List of all members
KIMAP::MyRightsJob Class Reference

#include <myrightsjob.h>

Inheritance diagram for KIMAP::MyRightsJob:
KIMAP::AclJobBase

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

virtual void doStart ()
 
virtual void handleResponse (const Message &response)
 
- 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:

  • Acl::Lookup
  • Acl::Read
  • Acl::Insert
  • Acl::CreateMailbox
  • Acl::DeleteMailbox
  • Acl::Admin

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

Definition at line 56 of file myrightsjob.h.

Constructor & Destructor Documentation

◆ MyRightsJob()

MyRightsJob::MyRightsJob ( Session *  session)
explicit

Definition at line 44 of file myrightsjob.cpp.

◆ ~MyRightsJob()

MyRightsJob::~MyRightsJob ( )
virtual

Definition at line 49 of file myrightsjob.cpp.

Member Function Documentation

◆ doStart()

void MyRightsJob::doStart ( )
protectedvirtual

Definition at line 53 of file myrightsjob.cpp.

◆ handleResponse()

void MyRightsJob::handleResponse ( const Message &  response)
protectedvirtual

Definition at line 60 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 72 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 78 of file myrightsjob.cpp.


The documentation for this class was generated from the following files:
  • myrightsjob.h
  • myrightsjob.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Jul 21 2022 00:00:00 by doxygen 1.9.5 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KIMAP Library

Skip menu "KIMAP Library"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Related Pages

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal