KIMAP::AclJobBase Class

Base class for jobs that operate on mailbox ACLs. More...

Header: #include <KIMAP/AclJobBase>
CMake: find_package(KPim6IMAP REQUIRED)
target_link_libraries(mytarget PRIVATE KPim6::IMAP)
Inherits: KIMAP::Job
Inherited By:

KIMAP::DeleteAclJob, KIMAP::GetAclJob, KIMAP::ListRightsJob, KIMAP::MyRightsJob, and KIMAP::SetAclJob

Public Types

enum AclModifier { Add, Remove, Change }

Public Functions

AclJobBase(KIMAP::Session *session)
QString mailBox() const
void setMailBox(const QString &mailBox)

Detailed Description

Provides support for the IMAP ACL extension, as defined by RFC 4314.

This class cannot be used directly, you must subclass it and reimplement at least the doStart() method.

Member Type Documentation

enum AclJobBase::AclModifier

Used when subclassing to specify how the ACL will be modified.

ConstantValue
KIMAP::AclJobBase::Add0
KIMAP::AclJobBase::Remove1
KIMAP::AclJobBase::Change2

Member Function Documentation

[explicit] AclJobBase::AclJobBase(KIMAP::Session *session)

QString AclJobBase::mailBox() const

The mailbox that will be acted upon.

See also setMailBox().

void AclJobBase::setMailBox(const QString &mailBox)

Set the mailbox to act on

mailBox the name of an existing mailbox

See also mailBox().