KIMAP::Acl Namespace Reference

Typedefs
typedef QFlags< Right >	Rights

Enumerations
enum	Right {   None = 0x000000 , Lookup = 0x000001 , Read = 0x000002 , KeepSeen = 0x000004 ,   Write = 0x000008 , Insert = 0x000010 , Post = 0x000020 , Create = 0x000040 ,   CreateMailbox = 0x000080 , DeleteMailbox = 0x000100 , DeleteMessage = 0x000200 , Delete = 0x000400 ,   Admin = 0x000800 , Expunge = 0x001000 , WriteShared = 0x002000 , Custom0 = 0x004000 ,   Custom1 = 0x008000 , Custom2 = 0x010000 , Custom3 = 0x020000 , Custom4 = 0x040000 ,   Custom5 = 0x080000 , Custom6 = 0x100000 , Custom7 = 0x200000 , Custom8 = 0x400000 ,   Custom9 = 0x800000 }

Functions
KIMAP_EXPORT Rights	denormalizedRights (Rights rights)
KIMAP_EXPORT Rights	normalizedRights (Rights rights)
KIMAP_EXPORT Rights	rightsFromString (const QByteArray &string)
KIMAP_EXPORT QByteArray	rightsToString (Rights rights)

Detailed Description

Operations for dealing with mailbox permissions.

Typedef Documentation

Rights

typedef QFlags< Right > KIMAP::Acl::Rights

Definition at line 80 of file acl.h.

Enumeration Type Documentation

Right

enum KIMAP::Acl::Right

Possible rights that can be held on a mailbox.

Enumerator
Lookup	Mailbox is visible to LIST/LSUB commands, SUBSCRIBE mailbox.
Read	SELECT the mailbox, perform STATUS.
KeepSeen	Set or clear the \Seen flag on messages in the mailbox, and keep it across sessions.
Write	Set or clear flags other than \Seen and \Deleted on messages in the mailbox.
Insert	Perform APPEND and COPY with the mailbox as the target.
Post	Send mail to the submission address for the mailbox. Note: this is not enforced by IMAP4, but is purely advisory.
Create	Obsolete as of RFC 4314, replaced by CreateMailbox and DeleteMailbox.
CreateMailbox	Create new child mailboxes, or move a mailbox with this mailbox as the new parent. Note that what constitutes a "child" mailbox is implementation-defined, but . or / are usually used as separaters.
DeleteMailbox	Delete or move the mailbox.
DeleteMessage	Set or clear the \Deleted flag on messages in the mailbox.
Delete	Obsolete as of RFC 4314, replaced by DeleteMessage and Expunge.
Admin	View and modify the access control list for the mailbox.
Expunge	Expunge the messages in this mailbox. Note that if this right is not held on a mailbox, closing the mailbox (see CloseJob) will succeed, but will not expunge the messages.
WriteShared	Write shared annotations. See RFC 5257. Only supported by servers that implement the ANNOTATE extension.
Custom0	Server-specific right 0.
Custom1	Server-specific right 1.
Custom2	Server-specific right 2.
Custom3	Server-specific right 3.
Custom4	Server-specific right 4.
Custom5	Server-specific right 5.
Custom6	Server-specific right 6.
Custom7	Server-specific right 7.
Custom8	Server-specific right 8.
Custom9	Server-specific right 9.

Definition at line 23 of file acl.h.

Function Documentation

denormalizedRights()

KIMAP::Acl::Rights KIMAP::Acl::denormalizedRights ( Rights rights )

nodiscard

Returns a rights mask that contains both obsolete and new flags if one of them is set.

Parameters

rights

set of Rights flags to augment

Since

4.6

Definition at line 104 of file acl.cpp.

normalizedRights()

KIMAP::Acl::Rights KIMAP::Acl::normalizedRights ( Rights rights )

nodiscard

Returns a rights mask that has no obsolete members anymore, i.e.

obsolete flags are removed and replaced by their successors.

Parameters

rights

set of Rights flags to normalize

Since

4.6

Definition at line 90 of file acl.cpp.

rightsFromString()

KIMAP::Acl::Rights KIMAP::Acl::rightsFromString ( const QByteArray & string )

nodiscard

Convert the text form of a set of rights into a Rights bitflag.

Modifier flags ('+' and '-') are ignored, as are any unknown characters. This method will not complain if you give it something that is not a list of rights.

Definition at line 55 of file acl.cpp.

rightsToString()

QByteArray KIMAP::Acl::rightsToString ( Rights rights )

nodiscard

Convert a set of rights into text format.

No modifier flag ('+' or '-') will be included.

Definition at line 77 of file acl.cpp.