KIMAP::CapabilitiesJob Class

Checks server capabilities. More...

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

Public Functions

CapabilitiesJob(KIMAP::Session *session)
virtual ~CapabilitiesJob() override
QStringList capabilities() const

Signals

void capabilitiesReceived(const QStringList &capabilities)

Reimplemented Protected Functions

virtual void doStart() override
virtual void handleResponse(const KIMAP::Response &response) override

Detailed Description

This job can be run in any open session.

This simply asks the server what capabilities it supports (using the CAPABILITY command) and returns the list provided by the server. The list may, therefore, be inaccurate: the server may claim to support something it does not implement properly, or it may omit a feature that it does, in reality, support.

Member Function Documentation

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

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

QStringList CapabilitiesJob::capabilities() const

The capabilities the server claims to support.

This will return an empty list until the job has completed.

[signal] void CapabilitiesJob::capabilitiesReceived(const QStringList &capabilities)

Notifies listeners that the capabilities have been fetched.

capabilities The capabilities the server claims to support.

[override virtual protected] void CapabilitiesJob::doStart()

[override virtual protected] void CapabilitiesJob::handleResponse(const KIMAP::Response &response)