• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.14.10 API Reference
  • KDE Home
  • Contact Us
 

KIMAP Library

  • KIMAP
  • GetQuotaJob
Public Member Functions | Protected Member Functions | List of all members
KIMAP::GetQuotaJob Class Reference

#include <getquotajob.h>

Inheritance diagram for KIMAP::GetQuotaJob:
KIMAP::QuotaJobBase

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

virtual void doStart ()
 
virtual void handleResponse (const Message &response)
 
- 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 50 of file getquotajob.h.

Constructor & Destructor Documentation

◆ GetQuotaJob()

GetQuotaJob::GetQuotaJob ( Session *  session)
explicit

Definition at line 43 of file getquotajob.cpp.

◆ ~GetQuotaJob()

GetQuotaJob::~GetQuotaJob ( )
virtual

Definition at line 48 of file getquotajob.cpp.

Member Function Documentation

◆ doStart()

void GetQuotaJob::doStart ( )
protectedvirtual

Definition at line 52 of file getquotajob.cpp.

◆ handleResponse()

void GetQuotaJob::handleResponse ( const Message &  response)
protectedvirtual

Definition at line 59 of file getquotajob.cpp.

◆ root()

QByteArray GetQuotaJob::root ( ) const

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

Definition at line 76 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 70 of file getquotajob.cpp.


The documentation for this class was generated from the following files:
  • getquotajob.h
  • getquotajob.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Jul 21 2022 00:00:00 by doxygen 1.9.5 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KIMAP Library

Skip menu "KIMAP Library"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Related Pages

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal