summaryrefslogtreecommitdiff
path: root/kimap/getquotarootjob.h
diff options
context:
space:
mode:
Diffstat (limited to 'kimap/getquotarootjob.h')
-rw-r--r--kimap/getquotarootjob.h124
1 files changed, 124 insertions, 0 deletions
diff --git a/kimap/getquotarootjob.h b/kimap/getquotarootjob.h
new file mode 100644
index 0000000..b1fa49e
--- /dev/null
+++ b/kimap/getquotarootjob.h
@@ -0,0 +1,124 @@
+/*
+ Copyright (c) 2009 Andras Mantia <amantia@kde.org>
+
+ This library is free software; you can redistribute it and/or modify it
+ under the terms of the GNU Library General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or (at your
+ option) any later version.
+
+ This library is distributed in the hope that it will be useful, but WITHOUT
+ ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
+ License for more details.
+
+ You should have received a copy of the GNU Library General Public License
+ along with this library; see the file COPYING.LIB. If not, write to the
+ Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ 02110-1301, USA.
+*/
+
+#ifndef KIMAP_GETQUOTAROOTJOB_H
+#define KIMAP_GETQUOTAROOTJOB_H
+
+#include "quotajobbase.h"
+
+namespace KIMAP {
+
+class Session;
+struct Message;
+class GetQuotaRootJobPrivate;
+
+/**
+ * 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
+ * <a href="http://www.apps.ietf.org/rfc/rfc2087.html">RFC 2087</a>.
+ */
+class KIMAP_EXPORT GetQuotaRootJob : public QuotaJobBase
+{
+ Q_OBJECT
+ Q_DECLARE_PRIVATE(GetQuotaRootJob)
+
+ friend class SessionPrivate;
+
+ public:
+ explicit GetQuotaRootJob( Session *session );
+ virtual ~GetQuotaRootJob();
+
+ /**
+ * Set the mailbox to get the quota roots for.
+ *
+ * @param mailBox the name of an existing mailbox
+ */
+ void setMailBox(const QString &mailBox);
+ /**
+ * The mailbox that the quota roots will be fetched for.
+ */
+ QString mailBox() const;
+
+ /**
+ * The quota roots for the mailbox.
+ */
+ QList<QByteArray> roots() 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.
+ *
+ * @param root the quota root to get the resource usage for
+ * @param resource the resource to get the usage for
+ * @return the resource usage in appropriate units, or -1
+ * if the usage is unknown or there is no
+ * limit on the resource
+ */
+ qint64 usage(const QByteArray &root, const QByteArray &resource) const;
+ /**
+ * Get the current limit for a resource.
+ *
+ * @param root the quota root to get the resource limit for
+ * @param resource the resource to get the limit for
+ * @return the resource limit in appropriate units, or -1
+ * if the limit is unknown or there is no
+ * limit on the resource
+ */
+ qint64 limit(const QByteArray &root, const QByteArray &resource) const;
+
+ /**
+ * Get a map containing all resource usage figures for a quota root.
+ *
+ * @param root the quota root to get resource usage figures for
+ * @return a map from resource names to usage figures
+ */
+ QMap<QByteArray, qint64> allUsages(const QByteArray &root) const;
+ /**
+ * Get a map containing all resource limits for a quota root.
+ *
+ * @param root the quota root to get resource limits for
+ * @return a map from resource names to limits
+ */
+ QMap<QByteArray, qint64> allLimits(const QByteArray &root) const;
+
+ protected:
+ virtual void doStart();
+ virtual void handleResponse(const Message &response);
+
+};
+
+}
+
+#endif