KIMAP2::GetQuotaJob

#include <getquotajob.h>

Inheritance diagram for KIMAP2::GetQuotaJob:

Public Member Functions

 GetQuotaJob (Session *session)
 
QByteArray root () const
 
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)
 

Protected Member Functions

void doStart () override
 
void handleResponse (const Message &response) override
 
- Protected Member Functions inherited from KIMAP2::QuotaJobBase
 QuotaJobBase (JobPrivate &dd)
 

Detailed Description

Gets resource limits for 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.

Definition at line 51 of file getquotajob.h.

Member Function Documentation

QByteArray GetQuotaJob::root ( ) const

The quota root that resource limit information will be fetched for.

Definition at line 73 of file getquotajob.cpp.

void GetQuotaJob::setRoot ( const QByteArray root)

Set the quota root to get the resource limits for.

Parameters
rootthe quota root to set
See also
GetQuotaRootJob

Definition at line 67 of file getquotajob.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Thu Dec 3 2020 23:09:48 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.