KIMAP::SetQuotaJob Class
Sets resource limits on a quota root. More...
| Header: | #include <KIMAP/SetQuotaJob> |
| CMake: | find_package(KPim6IMAP REQUIRED)target_link_libraries(mytarget PRIVATE KPim6::IMAP) |
| Inherits: | KIMAP::QuotaJobBase |
Public Functions
| SetQuotaJob(KIMAP::Session *session) | |
| QString | root() const |
| void | setQuota(const QByteArray &resource, qint64 limit) |
| 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] SetQuotaJob::SetQuotaJob(KIMAP::Session *session)
QString SetQuotaJob::root() const
The quota root that will be modified, in decoded Unicode form.
See also setRoot().
void SetQuotaJob::setQuota(const QByteArray &resource, qint64 limit)
Set a limit for a quota resource.
For example, you might set the limit for "STORAGE" to 512 to limit the sum of the messages' RFC822.SIZE to 512*1024 octets (ie: 512 kb), or the limit for "MESSAGE" to 100 to limit the number of messages to 100.
Note that although RFC 2087 allows a resource name to be any string, this API actually limits resource names to upper-case atoms. In practice, resource names will almost certainly be composed entirely of upper-case latin letters (A-Z).
resource the resource name
limit the maximum value the resource may take
void SetQuotaJob::setRoot(const QString &root)
Set the quota root the resource limits should be set for.
Note if the quota root does not already exist, the server may create it and change the quota roots for any number of existing mailboxes in an implementation-defined manner.
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.