KIMAP::Acl Namespace
Operations for dealing with mailbox permissions. More...
| Header: | #include <KIMAP/Acl> |
| CMake: | find_package(KPim6IMAP REQUIRED)target_link_libraries(mytarget PRIVATE KPim6::IMAP) |
Types
Functions
| KIMAP::Acl::Rights | denormalizedRights(KIMAP::Acl::Rights rights) |
| KIMAP::Acl::Rights | normalizedRights(KIMAP::Acl::Rights rights) |
| KIMAP::Acl::Rights | rightsFromString(QByteArrayView string) |
| QByteArray | rightsToString(KIMAP::Acl::Rights rights) |
Detailed Description
Type Documentation
enum Acl::Right
flags Acl::Rights
Possible rights that can be held on a mailbox
| Constant | Value | Description |
|---|---|---|
KIMAP::Acl::None | 0x000000 | |
KIMAP::Acl::Lookup | 0x000001 | Mailbox is visible to LIST/LSUB commands, SUBSCRIBE mailbox |
KIMAP::Acl::Read | 0x000002 | SELECT the mailbox, perform STATUS |
KIMAP::Acl::KeepSeen | 0x000004 | Set or clear the Seen flag on messages in the mailbox, and keep it across sessions |
KIMAP::Acl::Write | 0x000008 | Set or clear flags other than Seen and Deleted on messages in the mailbox |
KIMAP::Acl::Insert | 0x000010 | Perform APPEND and COPY with the mailbox as the target |
KIMAP::Acl::Post | 0x000020 | Send mail to the submission address for the mailbox. Note this is not enforced by IMAP4, but is purely advisory. |
KIMAP::Acl::Create | 0x000040 | Obsolete as of RFC 4314, replaced by CreateMailbox and DeleteMailbox |
KIMAP::Acl::CreateMailbox | 0x000080 | 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. |
KIMAP::Acl::DeleteMailbox | 0x000100 | Delete or move the mailbox |
KIMAP::Acl::DeleteMessage | 0x000200 | Set or clear the Deleted flag on messages in the mailbox |
KIMAP::Acl::Delete | 0x000400 | Obsolete as of RFC 4314, replaced by DeleteMessage and Expunge |
KIMAP::Acl::Admin | 0x000800 | View and modify the access control list for the mailbox |
KIMAP::Acl::Expunge | 0x001000 | 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. |
KIMAP::Acl::WriteShared | 0x002000 | Write shared annotations. See RFC 5257. Only supported by servers that implement the ANNOTATE extension. |
KIMAP::Acl::Custom0 | 0x004000 | Server-specific right 0 |
KIMAP::Acl::Custom1 | 0x008000 | Server-specific right 1 |
KIMAP::Acl::Custom2 | 0x010000 | Server-specific right 2 |
KIMAP::Acl::Custom3 | 0x020000 | Server-specific right 3 |
KIMAP::Acl::Custom4 | 0x040000 | Server-specific right 4 |
KIMAP::Acl::Custom5 | 0x080000 | Server-specific right 5 |
KIMAP::Acl::Custom6 | 0x100000 | Server-specific right 6 |
KIMAP::Acl::Custom7 | 0x200000 | Server-specific right 7 |
KIMAP::Acl::Custom8 | 0x400000 | Server-specific right 8 |
KIMAP::Acl::Custom9 | 0x800000 | Server-specific right 9 |
The Rights type is a typedef for QFlags<Right>. It stores an OR combination of Right values.
Function Documentation
KIMAP::Acl::Rights Acl::denormalizedRights(KIMAP::Acl::Rights rights)
Returns a rights mask that contains both obsolete and new flags if one of them is set.
rights set of Rights flags to augment
KIMAP::Acl::Rights Acl::normalizedRights(KIMAP::Acl::Rights rights)
Returns a rights mask that has no obsolete members anymore, i.e. obsolete flags are removed and replaced by their successors.
rights set of Rights flags to normalize
KIMAP::Acl::Rights Acl::rightsFromString(QByteArrayView string)
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.
QByteArray Acl::rightsToString(KIMAP::Acl::Rights rights)
Convert a set of rights into text format
No modifier flag ('+' or '-') will be included.