KSieveCore::SieveImapInstance Class

The SieveImapInstance class Author: Laurent Montel <montel@kde.org>. More...

Header: #include <KSieveCore/SieveImapInstance>
CMake: find_package(KPim6KSieveCore REQUIRED)
target_link_libraries(mytarget PRIVATE KPim6::KSieveCore)

Public Functions

SieveImapInstance()
~SieveImapInstance()
const QStringList &capabilities() const
QString identifier() const
const QStringList &mimeTypes() const
QString name() const
void setCapabilities(const QStringList &capabilities)
void setIdentifier(const QString &identifier)
void setMimeTypes(const QStringList &mimeTypes)
void setName(const QString &name)
void setStatus(KSieveCore::SieveImapInstance::Status status)
KSieveCore::SieveImapInstance::Status status() const
bool operator==(const KSieveCore::SieveImapInstance &other) const

Detailed Description

Member Function Documentation

SieveImapInstance::SieveImapInstance()

Constructs a default SieveImapInstance.

[constexpr noexcept default] SieveImapInstance::~SieveImapInstance()

Destroys the SieveImapInstance.

const QStringList &SieveImapInstance::capabilities() const

Returns the capabilities of this instance. Returns A list of capability strings.

See also setCapabilities().

QString SieveImapInstance::identifier() const

Returns the identifier of this instance. Returns The unique identifier.

See also setIdentifier().

const QStringList &SieveImapInstance::mimeTypes() const

Returns the MIME types supported by this instance. Returns A list of MIME type strings.

See also setMimeTypes().

QString SieveImapInstance::name() const

Returns the name of this Sieve IMAP instance. Returns The instance name.

See also setName().

void SieveImapInstance::setCapabilities(const QStringList &capabilities)

Sets the capabilities of this instance. capabilities A list of capability strings.

See also capabilities().

void SieveImapInstance::setIdentifier(const QString &identifier)

Sets the identifier of this instance. identifier The unique identifier to set.

See also identifier().

void SieveImapInstance::setMimeTypes(const QStringList &mimeTypes)

Sets the MIME types supported by this instance. mimeTypes A list of MIME type strings.

See also mimeTypes().

void SieveImapInstance::setName(const QString &name)

Sets the name of this Sieve IMAP instance. name The instance name to set.

See also name().

void SieveImapInstance::setStatus(KSieveCore::SieveImapInstance::Status status)

Sets the status of this instance. status The Status value to set.

See also status().

KSieveCore::SieveImapInstance::Status SieveImapInstance::status() const

Returns the current status of this instance. Returns The Status enumeration value.

See also setStatus().

bool SieveImapInstance::operator==(const KSieveCore::SieveImapInstance &other) const

Compares this instance with another. other The other SieveImapInstance. Returns true if the instances are identical.