• Skip to content
  • Skip to link menu
KDE 4.6 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • KDE Home
  • Contact Us
 

KIMAP Library

  • KIMAP
  • GetAclJob
Public Member Functions | Protected Member Functions

KIMAP::GetAclJob Class Reference

Gets the ACL for a mailbox. More...

#include <getacljob.h>

Inheritance diagram for KIMAP::GetAclJob:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 GetAclJob (Session *session)
QMap< QByteArray, Acl::Rights > allRights () const
bool hasRightEnabled (const QByteArray &identifier, Acl::Right right) const
QList< QByteArray > identifiers () const
Acl::Rights rights (const QByteArray &identifier) const

Protected Member Functions

virtual void doStart ()
virtual void handleResponse (const Message &response)

Detailed Description

Gets the ACL for a mailbox.

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.

Definition at line 63 of file getacljob.h.


Member Function Documentation

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.

Definition at line 108 of file getacljob.cpp.

bool GetAclJob::hasRightEnabled ( const QByteArray &  identifier,
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.

Parameters:
identifierthe identifier to check the rights for
rightthe right to check for

Definition at line 85 of file getacljob.cpp.

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.

Definition at line 79 of file getacljob.cpp.

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.

Parameters:
identifierthe identifier to check the rights for

Definition at line 97 of file getacljob.cpp.


The documentation for this class was generated from the following files:
  • getacljob.h
  • getacljob.cpp

KIMAP Library

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

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.7.3
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal