KIMAP::QuotaJobBase

#include <quotajobbase.h>

Inheritance diagram for KIMAP::QuotaJobBase:

Public Member Functions

 QuotaJobBase (Session *session)
 
qint64 limit (const QByteArray &resource)
 
qint64 usage (const QByteArray &resource)
 

Protected Member Functions

 QuotaJobBase (JobPrivate &dd)
 

Detailed Description

Base class for jobs that operate on mailbox quotas.

Provides support for the IMAP QUOTA extension, as defined by RFC 2087.

This class cannot be used directly, you must subclass it and reimplement at least the doStart() method.

Definition at line 30 of file quotajobbase.h.

Member Function Documentation

qint64 QuotaJobBase::limit ( const QByteArray resource)

Get the current limit for a resource.

All quota jobs will normally cause the server to return details of resource limits for all resources that were queried or modified by the job.

Note that RFC 2087 is slightly ambiguous about whether SETQUOTA will cause this information to be sent by the server.

Parameters
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 59 of file quotajobbase.cpp.

qint64 QuotaJobBase::usage ( const QByteArray resource)

Get the current usage for a resource.

All quota jobs will normally cause the server to return details of resource usage for all resources that were queried or modified by the job.

Note that RFC 2087 is slightly ambiguous about whether SETQUOTA will cause this information to be sent by the server.

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

Parameters
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 47 of file quotajobbase.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 Fri Nov 27 2020 23:14:01 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.