• 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
  • QuotaJobBase
Public Member Functions | Protected Member Functions
KIMAP::QuotaJobBase Class Reference

#include <quotajobbase.h>

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

List of all members.

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 42 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 77 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 64 of file quotajobbase.cpp.


The documentation for this class was generated from the following files:
  • quotajobbase.h
  • quotajobbase.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