KIMAP::GetQuotaJob

Search for usage in LXR

#include <getquotajob.h>

Inheritance diagram for KIMAP::GetQuotaJob:

Public Member Functions

 GetQuotaJob (Session *session)
 
QByteArray root () const
 
void setRoot (const QByteArray &root)
 
- 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 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 36 of file getquotajob.h.

Constructor & Destructor Documentation

◆ GetQuotaJob()

GetQuotaJob::GetQuotaJob ( Session * session)
explicit

Definition at line 34 of file getquotajob.cpp.

◆ ~GetQuotaJob()

GetQuotaJob::~GetQuotaJob ( )
override

Definition at line 39 of file getquotajob.cpp.

Member Function Documentation

◆ doStart()

void GetQuotaJob::doStart ( )
overrideprotected

Definition at line 43 of file getquotajob.cpp.

◆ handleResponse()

void GetQuotaJob::handleResponse ( const Response & response)
overrideprotected

Definition at line 50 of file getquotajob.cpp.

◆ root()

QByteArray GetQuotaJob::root ( ) const

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

Definition at line 66 of file getquotajob.cpp.

◆ setRoot()

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 60 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-2024 The KDE developers.
Generated on Sun Feb 25 2024 18:40:19 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.