KIMAP2

deleteacljob.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_DELETEACLJOB_H
21 #define KIMAP2_DELETEACLJOB_H
22 
23 #include "kimap2_export.h"
24 
25 #include "acljobbase.h"
26 
27 namespace KIMAP2
28 {
29 
30 class Session;
31 struct Message;
32 class DeleteAclJobPrivate;
33 
34 /**
35  * Removes an identifier from the ACL of a mailbox.
36  *
37  * This job can only be run when the session is in the
38  * authenticated (or selected) state.
39  *
40  * The user must have the Acl::Admin permission
41  * on the mailbox for this job to succeed (see
42  * MyRightsJob).
43  *
44  * This job requires that the server supports the ACL
45  * capability, defined in
46  * <a href="http://www.apps.ietf.org/rfc/rfc4314.html">RFC 4314</a>.
47  */
48 class KIMAP2_EXPORT DeleteAclJob : public AclJobBase
49 {
50  Q_OBJECT
51  Q_DECLARE_PRIVATE(DeleteAclJob)
52 
53  friend class SessionPrivate;
54 
55 public:
56  explicit DeleteAclJob(Session *session);
57  virtual ~DeleteAclJob();
58 
59  /**
60  * Sets the identifier to remove
61  */
62  void setIdentifier(const QByteArray &identifier);
63  /**
64  * The identifier that will be removed
65  */
66  QByteArray identifier();
67 
68 protected:
69  void doStart() Q_DECL_OVERRIDE;
70 
71 };
72 
73 }
74 
75 #endif
Base class for jobs that operate on mailbox ACLs.
Definition: acljobbase.h:44
Definition: acl.cpp:25
Removes an identifier from the ACL of a mailbox.
Definition: deleteacljob.h:48
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.