KIMAP2

quotajobbase.h
1 /*
2  Copyright (c) 2009 Andras Mantia <[email protected]>
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_QUOTAJOBBASE_H
21 #define KIMAP2_QUOTAJOBBASE_H
22 
23 #include "kimap2_export.h"
24 
25 #include "job.h"
26 
27 namespace KIMAP2
28 {
29 
30 class Session;
31 struct Message;
32 class QuotaJobBasePrivate;
33 
34 /**
35  * Base class for jobs that operate on mailbox quotas
36  *
37  * Provides support for the IMAP QUOTA extension, as defined by
38  * <a href="http://www.apps.ietf.org/rfc/rfc2087.html" title="IMAP QUOTA extension">RFC 2087</a>.
39  *
40  * This class cannot be used directly, you must subclass it and reimplement
41  * at least the doStart() method.
42 */
43 class KIMAP2_EXPORT QuotaJobBase : public Job
44 {
45  Q_OBJECT
46  Q_DECLARE_PRIVATE(QuotaJobBase)
47 
48  friend class SessionPrivate;
49 
50 public:
51  explicit QuotaJobBase(Session *session);
52  virtual ~QuotaJobBase();
53 
54  /**
55  * Get the current usage for a resource.
56  *
57  * All quota jobs will normally cause the server to return
58  * details of resource usage for all resources that were
59  * queried or modified by the job.
60  *
61  * Note that RFC 2087 is slightly ambiguous about whether
62  * SETQUOTA will cause this information to be sent by the
63  * server.
64  *
65  * Note that if there is no limit for a resource, the
66  * server will not provide information about resource
67  * usage.
68  *
69  * @param resource the resource to get the usage for
70  * @return the resource usage in appropriate units, or -1
71  * if the usage is unknown or there is no
72  * limit on the resource
73  */
74  qint64 usage(const QByteArray &resource);
75  /**
76  * Get the current limit for a resource.
77  *
78  * All quota jobs will normally cause the server to return
79  * details of resource limits for all resources that were
80  * queried or modified by the job.
81  *
82  * Note that RFC 2087 is slightly ambiguous about whether
83  * SETQUOTA will cause this information to be sent by the
84  * server.
85  *
86  * @param resource the resource to get the limit for
87  * @return the resource limit in appropriate units, or -1
88  * if the limit is unknown or there is no limit
89  * on the resource
90  */
91  qint64 limit(const QByteArray &resource);
92 
93 protected:
94  QuotaJobBase(JobPrivate &dd);
95 
96 };
97 
98 }
99 
100 #endif
Base class for jobs that operate on mailbox quotas.
Definition: quotajobbase.h:43
Definition: acl.cpp:25
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Mon Nov 29 2021 23:00:39 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.