|SetQuotaJob (Session *session)|
|QByteArray||root () const|
|void||setQuota (const QByteArray &resource, qint64 limit)|
|void||setRoot (const QByteArray &root)|
|Public Member Functions inherited from KIMAP2::QuotaJobBase|
|QuotaJobBase (Session *session)|
|qint64||limit (const QByteArray &resource)|
|qint64||usage (const QByteArray &resource)|
|void||doStart () override|
|void||handleResponse (const Message &response) override|
|Protected Member Functions inherited from KIMAP2::QuotaJobBase|
|QuotaJobBase (JobPrivate &dd)|
Sets resource limits on a quota root.
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
|void SetQuotaJob::setQuota||(||const QByteArray &||resource,|
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 QByteArray &||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.
root the quota root to set, in bytes
- See also
The documentation for this class was generated from the following files: