KIMAP::GetQuotaRootJob

KIMAP::GetQuotaRootJob Class Reference

#include <getquotarootjob.h>

Inheritance diagram for KIMAP::GetQuotaRootJob:

Public Member Functions

 GetQuotaRootJob (Session *session)
 
QMap< QByteArray, qint64 > allLimits (const QByteArray &root) const
 
QMap< QByteArray, qint64 > allUsages (const QByteArray &root) const
 
qint64 limit (const QByteArray &root, const QByteArray &resource) const
 
QString mailBox () const
 
QList< QByteArrayroots () const
 
void setMailBox (const QString &mailBox)
 
qint64 usage (const QByteArray &root, const QByteArray &resource) const
 
- Public Member Functions inherited from KIMAP::QuotaJobBase
 QuotaJobBase (Session *session)
 
qint64 limit (const QByteArray &resource)
 
qint64 usage (const QByteArray &resource)
 

Protected Member Functions

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

Detailed Description

Gets the quota root and resource limits for a mailbox.

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 38 of file getquotarootjob.h.

Member Function Documentation

QMap< QByteArray, qint64 > GetQuotaRootJob::allLimits ( const QByteArray root) const

Get a map containing all resource limits for a quota root.

Parameters
rootthe quota root to get resource limits for
Returns
a map from resource names to limits

Definition at line 144 of file getquotarootjob.cpp.

QMap< QByteArray, qint64 > GetQuotaRootJob::allUsages ( const QByteArray root) const

Get a map containing all resource usage figures for a quota root.

Parameters
rootthe quota root to get resource usage figures for
Returns
a map from resource names to usage figures

Definition at line 127 of file getquotarootjob.cpp.

qint64 GetQuotaRootJob::limit ( const QByteArray root,
const QByteArray resource 
) const

Get the current limit for a resource.

Parameters
rootthe quota root to get the resource limit for
resourcethe resource to get the limit for
Returns
the resource limit in appropriate units, or -1 if the limit is unknown or there is no limit on the resource

Definition at line 115 of file getquotarootjob.cpp.

QString GetQuotaRootJob::mailBox ( ) const

The mailbox that the quota roots will be fetched for.

Definition at line 92 of file getquotarootjob.cpp.

QList< QByteArray > GetQuotaRootJob::roots ( ) const

The quota roots for the mailbox.

Definition at line 98 of file getquotarootjob.cpp.

void GetQuotaRootJob::setMailBox ( const QString mailBox)

Set the mailbox to get the quota roots for.

Parameters
mailBoxthe name of an existing mailbox

Definition at line 86 of file getquotarootjob.cpp.

qint64 GetQuotaRootJob::usage ( const QByteArray root,
const QByteArray resource 
) const

Get the current usage for a resource.

Note that if there is no limit for a resource, the server will not provide information about resource usage.

Parameters
rootthe quota root to get the resource usage for
resourcethe resource to get the usage for
Returns
the resource usage in appropriate units, or -1 if the usage is unknown or there is no limit on the resource

Definition at line 104 of file getquotarootjob.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:13:14 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.