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

KIMAP Library

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

#include <setquotajob.h>

Inheritance diagram for KIMAP::SetQuotaJob:
KIMAP::QuotaJobBase

Public Member Functions

 SetQuotaJob (Session *session)
 
QByteArray root () const
 
void setQuota (const QByteArray &resource, qint64 limit)
 
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)
 
- Public Member Functions inherited from KIMAP::Job
Session * session () const
 
virtual void start ()
 

Protected Member Functions

virtual void doStart ()
 
virtual void handleResponse (const Message &response)
 
- Protected Member Functions inherited from KIMAP::QuotaJobBase
 QuotaJobBase (JobPrivate &dd)
 
- Protected Member Functions inherited from KIMAP::Job
 Job (Session *session)
 
 Job (JobPrivate &dd)
 
HandlerResponse handleErrorReplies (const Message &response)
 

Additional Inherited Members

- Protected Types inherited from KIMAP::Job
enum  HandlerResponse { Handled = 0, NotHandled }
 
- Protected Attributes inherited from KIMAP::Job
JobPrivate *const d_ptr
 

Detailed Description

Sets resource limits on 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 setquotajob.h.

Member Function Documentation

QByteArray SetQuotaJob::root ( ) const

The quota root that will be modified.

Definition at line 97 of file setquotajob.cpp.

void SetQuotaJob::setQuota ( const QByteArray &  resource,
qint64  limit 
)

Set a limit for a quota resource.

For example, you might set the limit for "STORAGE" to 512 to limit the sum of the messages' RFC822.SIZE to 512*1024 octets (ie: 512 kb), or the limit for "MESSAGE" to 100 to limit the number of messages to 100.

Note that although RFC 2087 allows a resource name to be any string, this API actually limits resource names to upper-case atoms. In practice, resource names will almost certainly be composed entirely of upper-case latin letters (A-Z).

Parameters
resourcethe resource name
limitthe maximum value the resource may take

Definition at line 83 of file setquotajob.cpp.

void SetQuotaJob::setRoot ( const QByteArray &  root)

Set the quota root the resource limits should be set for.

Note: if the quota root does not already exist, the server may create it and change the quota roots for any number of existing mailboxes in an implementation-defined manner.

Parameters
rootthe quota root to set, in bytes
See Also
GetQuotaRootJob

Definition at line 90 of file setquotajob.cpp.


The documentation for this class was generated from the following files:
  • setquotajob.h
  • setquotajob.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Tue Nov 26 2013 09:02:14 by doxygen 1.8.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.11.3 API Reference

Skip menu "kdepimlibs-4.11.3 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