KIMAP::MetaDataJobBase Class

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

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

KIMAP::GetMetaDataJob and KIMAP::SetMetaDataJob

Public Types

enum ServerCapability { Metadata, Annotatemore }

Public Functions

MetaDataJobBase(KIMAP::Session *session)
virtual ~MetaDataJobBase() override
QString mailBox() const
KIMAP::MetaDataJobBase::ServerCapability serverCapability() const
void setMailBox(const QString &mailBox)
void setServerCapability(KIMAP::MetaDataJobBase::ServerCapability capability)

Detailed Description

Provides support for the IMAP METADATA extension; both the final RFC version (RFC 5464) and the older, incompatible draft version (known as ANNOTATEMORE) (draft-daboo-imap-annotatemore-07).

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

Member Type Documentation

enum MetaDataJobBase::ServerCapability

Represents the capability level of the server.

ConstantValueDescription
KIMAP::MetaDataJobBase::Metadata0Used to indicate that the server supports the RFC 5464 version of the extension. This corresponds to the METADATA server capability.
KIMAP::MetaDataJobBase::Annotatemore1Used to indicate that the server supports the draft-daboo-imap-annotatemore-07 version of the extension. This corresponds to the ANNOTATEMORE server capability.

Member Function Documentation

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

[override virtual noexcept] MetaDataJobBase::~MetaDataJobBase()

QString MetaDataJobBase::mailBox() const

The mailbox that will be acted upon.

If this is an empty string, server metadata will be retrieved.

Returns a mailbox name, or an empty string

See also setMailBox().

KIMAP::MetaDataJobBase::ServerCapability MetaDataJobBase::serverCapability() const

The version of the metadata extension that will be used.

See also setServerCapability().

void MetaDataJobBase::setMailBox(const QString &mailBox)

Set the mailbox to act on

This may be an empty string, in which case metadata for the server (rather than a specific mailbox) will be retrieved.

mailBox the name of an existing mailbox, or an empty string

See also mailBox().

void MetaDataJobBase::setServerCapability(KIMAP::MetaDataJobBase::ServerCapability capability)

Set what version of the metadata extension to be compatible with.

This will determine the commands that will be sent to the server.

The draft for the metadata extension changed in an incompatible way between versions 7 and 8, and some servers support version 7. It should be possible to check which version the server supports using CapabilityJob: servers implementing draft-daboo-imap-annotatemore-07 should advertise the ANNOTATEMORE capability, whereas servers implementing the final RFC 5464 should advertise the METADATA capability.

The default mode is Metadata.

capability the version of the extension implemented by the server

See also serverCapability().