KIMAP::ListJob Class

The ListJob class. More...

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

Public Types

(since 6.8) MailboxStatus
enum Option { NoOption, IncludeUnsubscribed, IncludeFolderRoleFlags }

Public Functions

ListJob(KIMAP::Session *session)
virtual ~ListJob() override
(since 6.8) void clearReturnOptions()
bool listExtendedEnabled() const
KIMAP::ListJob::Option option() const
QList<KIMAP::MailBoxDescriptor> queriedNamespaces() const
void setListExtendedEnabled(bool enabled)
void setOption(KIMAP::ListJob::Option option)
void setQueriedNamespaces(const QList<KIMAP::MailBoxDescriptor> &namespaces)
(since 6.8) void setReturnOptions(Ts &&... vals)

Signals

void mailBoxesReceived(const QList<KIMAP::MailBoxDescriptor> &descriptors, const QList<QList<QByteArray>> &flags)
void mailBoxesStatusReceived(const QList<KIMAP::MailBoxDescriptor> &descriptors, const QList<QList<QByteArray>> &flags, const QList<std::optional<KIMAP::ListJob::MailboxStatus>> &status)

Detailed Description

Member Type Documentation

[alias, since 6.8] ListJob::MailboxStatus

This typedef was introduced in 6.8.

enum ListJob::Option

ConstantValueDescription
KIMAP::ListJob::NoOption0x0only subscribed mailboxes. (Uses the LSUB IMAP command.)
KIMAP::ListJob::IncludeUnsubscribed0x1subscribed and unsubscribed mailboxes. (Uses the LIST IMAP command.)
KIMAP::ListJob::IncludeFolderRoleFlags0x2List subscribed and unsubscribed mailboxes with flags to identify standard mailboxes whose name may be localized. The server must support the XLIST extension.

Member Function Documentation

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

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

[since 6.8] void ListJob::clearReturnOptions()

Removes all return options

This function was introduced in 6.8.

bool ListJob::listExtendedEnabled() const

See also setListExtendedEnabled().

[signal] void ListJob::mailBoxesReceived(const QList<KIMAP::MailBoxDescriptor> &descriptors, const QList<QList<QByteArray>> &flags)

[signal] void ListJob::mailBoxesStatusReceived(const QList<KIMAP::MailBoxDescriptor> &descriptors, const QList<QList<QByteArray>> &flags, const QList<std::optional<KIMAP::ListJob::MailboxStatus>> &status)

KIMAP::ListJob::Option ListJob::option() const

See also setOption().

QList<KIMAP::MailBoxDescriptor> ListJob::queriedNamespaces() const

See also setQueriedNamespaces().

void ListJob::setListExtendedEnabled(bool enabled)

See also listExtendedEnabled().

void ListJob::setOption(KIMAP::ListJob::Option option)

See also option().

void ListJob::setQueriedNamespaces(const QList<KIMAP::MailBoxDescriptor> &namespaces)

See also queriedNamespaces().

[since 6.8] template <typename... Ts> void ListJob::setReturnOptions(Ts &&... vals)

Sets a new return options list

This function was introduced in 6.8.