KIMAP::QuotaJobBase Class

Base class for jobs that operate on mailbox quotas. More...

Header: #include <KIMAP/QuotaJobBase>
CMake: find_package(KPim6IMAP REQUIRED)
target_link_libraries(mytarget PRIVATE KPim6::IMAP)
Inherits: KIMAP::Job
Inherited By:

KIMAP::GetQuotaJob, KIMAP::GetQuotaRootJob, and KIMAP::SetQuotaJob

Public Functions

QuotaJobBase(KIMAP::Session *session)
virtual ~QuotaJobBase() override
qint64 limit(const QByteArray &resource)
qint64 usage(const QByteArray &resource)

Detailed Description

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.

Member Function Documentation

[explicit] QuotaJobBase::QuotaJobBase(KIMAP::Session *session)

[override virtual noexcept] QuotaJobBase::~QuotaJobBase()

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.

resource the 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

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.

resource the 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