• Skip to content
  • Skip to link menu
KDE 4.8 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • KDE Home
  • Contact Us
 

KIMAP Library

  • KIMAP
  • GetQuotaRootJob
Public Member Functions | Protected Member Functions
KIMAP::GetQuotaRootJob Class Reference

#include <getquotarootjob.h>

Inheritance diagram for KIMAP::GetQuotaRootJob:
Inheritance graph
[legend]

List of all members.

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< QByteArray > roots () const
void setMailBox (const QString &mailBox)
qint64 usage (const QByteArray &root, const QByteArray &resource) const

Protected Member Functions

virtual void doStart ()
virtual void handleResponse (const Message &response)

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 50 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 168 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 150 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 137 of file getquotarootjob.cpp.

QString GetQuotaRootJob::mailBox ( ) const

The mailbox that the quota roots will be fetched for.

Definition at line 110 of file getquotarootjob.cpp.

QList< QByteArray > GetQuotaRootJob::roots ( ) const

The quota roots for the mailbox.

Definition at line 117 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 103 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 124 of file getquotarootjob.cpp.


The documentation for this class was generated from the following files:
  • getquotarootjob.h
  • getquotarootjob.cpp

KIMAP Library

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

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.7.6.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal