KIMAP::GetQuotaJob Class

Gets resource limits for a quota root. More...

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

Public Functions

GetQuotaJob(KIMAP::Session *session)
QString root() const
void setRoot(const QString &root)

Detailed Description

Quotas are defined with respect to "resources" and "quota roots". A resource is a numerical property that can be limited, such as the octet size of all the messages in a mailbox, or the number of messages in a mailbox. Each mailbox has one or more quota roots, which are where the resource limits are defined. A quota root may or may not be a mailbox name, and an empty string is a valid quota root. All mailboxes with the same quota root share the resource limits of the quota root.

This job can only be run when the session is in the authenticated (or selected) state.

This job requires that the server supports the QUOTA capability, defined in RFC 2087.

Member Function Documentation

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

QString GetQuotaJob::root() const

The quota root that resource limit information will be fetched for, in decoded Unicode form.

See also setRoot().

void GetQuotaJob::setRoot(const QString &root)

Set the quota root to get the resource limits for.

A quota root may be a mailbox name (RFC 9208/2087); pass it in decoded Unicode form. The job encodes for the wire as needed, using mUTF-7 (RFC 3501) for plain IMAP4rev1 sessions and raw UTF-8 for IMAP4rev2 (RFC 9051) or sessions with UTF8=ACCEPT enabled (RFC 9755).

root the quota root to set

See also root() and GetQuotaRootJob.