/usr/include/KF5/KIMAP/kimap/setquotajob.h is in libkf5imap-dev 17.12.3-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 | /*
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_SETQUOTAJOB_H
#define KIMAP_SETQUOTAJOB_H
#include "quotajobbase.h"
namespace KIMAP
{
class Session;
struct Response;
class SetQuotaJobPrivate;
/**
* 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
* <a href="http://www.apps.ietf.org/rfc/rfc2087.html">RFC 2087</a>.
*/
class KIMAP_EXPORT SetQuotaJob : public QuotaJobBase
{
Q_OBJECT
Q_DECLARE_PRIVATE(SetQuotaJob)
friend class SessionPrivate;
public:
explicit SetQuotaJob(Session *session);
virtual ~SetQuotaJob();
/**
* 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).
*
* @param resource the resource name
* @param limit the maximum value the resource may take
*/
void setQuota(const QByteArray &resource, qint64 limit);
/**
* 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.
*
* @param root the quota root to set, in bytes
* @see GetQuotaRootJob
*/
void setRoot(const QByteArray &root);
/**
* The quota root that will be modified.
*/
QByteArray root() const;
protected:
void doStart() override;
void handleResponse(const Response &response) override;
};
}
#endif
|