KIMAP2

myrightsjob.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_MYRIGHTSJOB_H
21 #define KIMAP2_MYRIGHTSJOB_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 MyRightsJobPrivate;
33 
34 /**
35  * Determine the rights the currently-logged-in user
36  * has on the current mailbox.
37  *
38  * This should take into account the full access control
39  * list.
40  *
41  * This job can only be run when the session is in the
42  * authenticated (or selected) state.
43  *
44  * The current user must have one of the following rights
45  * on the mailbox for this job to succeed:
46  * - Acl::Lookup
47  * - Acl::Read
48  * - Acl::Insert
49  * - Acl::CreateMailbox
50  * - Acl::DeleteMailbox
51  * - Acl::Admin
52  *
53  * This job requires that the server supports the ACL
54  * capability, defined in
55  * <a href="http://www.apps.ietf.org/rfc/rfc4314.html">RFC 4314</a>.
56  */
57 class KIMAP2_EXPORT MyRightsJob : public AclJobBase
58 {
59  Q_OBJECT
60  Q_DECLARE_PRIVATE(MyRightsJob)
61 
62  friend class SessionPrivate;
63 
64 public:
65  explicit MyRightsJob(Session *session);
66  virtual ~MyRightsJob();
67 
68  /**
69  * Check whether the current user has the a particular right
70  * on the mailbox.
71  *
72  * The result of this method is undefined if the job has
73  * not yet completed.
74  *
75  * @param right the right to check for
76  */
77  bool hasRightEnabled(Acl::Right right);
78  /**
79  * Get the rights for the current user on the mailbox.
80  *
81  * The result of this method is undefined if the job has
82  * not yet completed.
83  */
84  Acl::Rights rights();
85 
86 protected:
87  void doStart() Q_DECL_OVERRIDE;
88  void handleResponse(const Message &response) Q_DECL_OVERRIDE;
89 
90 };
91 
92 }
93 
94 #endif
Base class for jobs that operate on mailbox ACLs.
Definition: acljobbase.h:44
Determine the rights the currently-logged-in user has on the current mailbox.
Definition: myrightsjob.h:57
Right
Possible rights that can be held on a mailbox.
Definition: acl.h:39
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Fri Jul 1 2022 05:04:01 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.