KIMAP2

setquotajob.h
1/*
2 Copyright (c) 2009 Andras Mantia <amantia@kde.org>
3
4 This library is free software; you can redistribute it and/or modify it
5 under the terms of the GNU Library General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or (at your
7 option) any later version.
8
9 This library is distributed in the hope that it will be useful, but WITHOUT
10 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
12 License for more details.
13
14 You should have received a copy of the GNU Library General Public License
15 along with this library; see the file COPYING.LIB. If not, write to the
16 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17 02110-1301, USA.
18*/
19
20#ifndef KIMAP2_SETQUOTAJOB_H
21#define KIMAP2_SETQUOTAJOB_H
22
23#include "quotajobbase.h"
24
25namespace KIMAP2
26{
27
28class Session;
29struct Message;
30class SetQuotaJobPrivate;
31
32/**
33 * Sets resource limits on a quota root.
34 *
35 * Quotas are defined with respect to "resources" and "quota roots".
36 * A resource is a numerical property that can be limited, such
37 * as the octet size of all the messages in a mailbox, or the
38 * number of messages in a mailbox. Each mailbox has one or more
39 * quota roots, which are where the resource limits are defined.
40 * A quota root may or may not be a mailbox name, and an empty
41 * string is a valid quota root. All mailboxes with the same quota
42 * root share the resource limits of the quota root.
43 *
44 * This job can only be run when the session is in the
45 * authenticated (or selected) state.
46 *
47 * This job requires that the server supports the QUOTA
48 * capability, defined in
49 * <a href="http://www.apps.ietf.org/rfc/rfc2087.html">RFC 2087</a>.
50 */
51class KIMAP2_EXPORT SetQuotaJob : public QuotaJobBase
52{
53 Q_OBJECT
54 Q_DECLARE_PRIVATE(SetQuotaJob)
55
56 friend class SessionPrivate;
57
58public:
59 explicit SetQuotaJob(Session *session);
60 virtual ~SetQuotaJob();
61
62 /**
63 * Set a limit for a quota resource.
64 *
65 * For example, you might set the limit for "STORAGE" to
66 * 512 to limit the sum of the messages' RFC822.SIZE to
67 * 512*1024 octets (ie: 512 kb), or the limit for "MESSAGE"
68 * to 100 to limit the number of messages to 100.
69 *
70 * Note that although RFC 2087 allows a resource name to
71 * be any string, this API actually limits resource names
72 * to upper-case atoms. In practice, resource names will
73 * almost certainly be composed entirely of upper-case latin
74 * letters (A-Z).
75 *
76 * @param resource the resource name
77 * @param limit the maximum value the resource may take
78 */
79 void setQuota(const QByteArray &resource, qint64 limit);
80
81 /**
82 * Set the quota root the resource limits should be set for.
83 *
84 * Note: if the quota root does not already exist, the server
85 * may create it and change the quota roots for any number of
86 * existing mailboxes in an implementation-defined manner.
87 *
88 * @param root the quota root to set, in bytes
89 * @see GetQuotaRootJob
90 */
91 void setRoot(const QByteArray &root);
92 /**
93 * The quota root that will be modified.
94 */
95 QByteArray root() const;
96
97protected:
98 void doStart() Q_DECL_OVERRIDE;
99 void handleResponse(const Message &response) Q_DECL_OVERRIDE;
100
101};
102
103}
104
105#endif
Base class for jobs that operate on mailbox quotas.
Sets resource limits on a quota root.
Definition setquotajob.h:52
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Jul 19 2024 11:59:52 by doxygen 1.11.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.