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

KIMAP Library

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

#include <listrightsjob.h>

Inheritance diagram for KIMAP::ListRightsJob:
KIMAP::AclJobBase

Public Member Functions

 ListRightsJob (Session *session)
 
Acl::Rights defaultRights ()
 
QByteArray identifier ()
 
QList< Acl::Rights > possibleRights ()
 
void setIdentifier (const QByteArray &identifier)
 
- Public Member Functions inherited from KIMAP::AclJobBase
 AclJobBase (Session *session)
 
QString mailBox () const
 
void setMailBox (const QString &mailBox)
 
- Public Member Functions inherited from KIMAP::Job
Session * session () const
 
virtual void start ()
 

Protected Member Functions

virtual void doStart ()
 
virtual void handleResponse (const Message &response)
 
- Protected Member Functions inherited from KIMAP::AclJobBase
 AclJobBase (JobPrivate &dd)
 
- Protected Member Functions inherited from KIMAP::Job
 Job (Session *session)
 
 Job (JobPrivate &dd)
 
HandlerResponse handleErrorReplies (const Message &response)
 

Additional Inherited Members

- Public Types inherited from KIMAP::AclJobBase
enum  AclModifier { Add = 0, Remove, Change }
 
- Protected Types inherited from KIMAP::Job
enum  HandlerResponse { Handled = 0, NotHandled }
 
- Protected Attributes inherited from KIMAP::Job
JobPrivate *const d_ptr
 

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
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Sat Jul 13 2013 01:25:18 by doxygen 1.8.3.1 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.10.5 API Reference

Skip menu "kdepimlibs-4.10.5 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