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

0001 /*
0002     Copyright (c) 2009 Andras Mantia <amantia@kde.org>
0003 
0004     This library is free software; you can redistribute it and/or modify it
0005     under the terms of the GNU Library General Public License as published by
0006     the Free Software Foundation; either version 2 of the License, or (at your
0007     option) any later version.
0008 
0009     This library is distributed in the hope that it will be useful, but WITHOUT
0010     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0011     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
0012     License for more details.
0013 
0014     You should have received a copy of the GNU Library General Public License
0015     along with this library; see the file COPYING.LIB.  If not, write to the
0016     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
0017     02110-1301, USA.
0018 */
0019 
0020 #ifndef KIMAP2_DELETEACLJOB_H
0021 #define KIMAP2_DELETEACLJOB_H
0022 
0023 #include "kimap2_export.h"
0024 
0025 #include "acljobbase.h"
0026 
0027 namespace KIMAP2
0028 {
0029 
0030 class Session;
0031 struct Message;
0032 class DeleteAclJobPrivate;
0033 
0034 /**
0035  * Removes an identifier from the ACL of a mailbox.
0036  *
0037  * This job can only be run when the session is in the
0038  * authenticated (or selected) state.
0039  *
0040  * The user must have the Acl::Admin permission
0041  * on the mailbox for this job to succeed (see
0042  * MyRightsJob).
0043  *
0044  * This job requires that the server supports the ACL
0045  * capability, defined in
0046  * <a href="http://www.apps.ietf.org/rfc/rfc4314.html">RFC 4314</a>.
0047  */
0048 class KIMAP2_EXPORT DeleteAclJob : public AclJobBase
0049 {
0050     Q_OBJECT
0051     Q_DECLARE_PRIVATE(DeleteAclJob)
0052 
0053     friend class SessionPrivate;
0054 
0055 public:
0056     explicit DeleteAclJob(Session *session);
0057     virtual ~DeleteAclJob();
0058 
0059     /**
0060      * Sets the identifier to remove
0061      */
0062     void setIdentifier(const QByteArray &identifier);
0063     /**
0064      * The identifier that will be removed
0065      */
0066     QByteArray identifier();
0067 
0068 protected:
0069     void doStart() Q_DECL_OVERRIDE;
0070 
0071 };
0072 
0073 }
0074 
0075 #endif