• 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
  • ListRightsJob
Public Member Functions | Protected Member Functions
KIMAP::ListRightsJob Class Reference

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

#include <listrightsjob.h>

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

List of all members.

Public Member Functions

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

Protected Member Functions

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

Detailed Description

Lists the possible and automatic rights for an identifier on 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.

Definition at line 49 of file listrightsjob.h.


Member Function Documentation

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.

Definition at line 95 of file listrightsjob.cpp.

QByteArray ListRightsJob::identifier ( )

The identifier that will be looked up.

Definition at line 89 of file listrightsjob.cpp.

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:

  • Acl::KeepSeen
  • Acl::Write
  • Acl::Insert
  • Acl::DeleteMessage
  • Acl::Expunge

Definition at line 101 of file listrightsjob.cpp.

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.

Parameters:
identifierthe identifier to list the rights for

Definition at line 83 of file listrightsjob.cpp.


The documentation for this class was generated from the following files:
  • listrightsjob.h
  • listrightsjob.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.4
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