File indexing completed on 2024-05-12 05:17:25

 /*
     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 KIMAP2_SETQUOTAJOB_H
 #define KIMAP2_SETQUOTAJOB_H
 
 #include "quotajobbase.h"
 
 namespace KIMAP2
 {
 
 class Session;
 struct Message;
 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 KIMAP2_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() Q_DECL_OVERRIDE;
     void handleResponse(const Message &response) Q_DECL_OVERRIDE;
 
 };
 
 }
 
 #endif