1 | /* |
2 | Copyright (c) 2009 Andras Mantia <amantia@kde.org> |
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 KIMAP_ACLJOBBASE_H |
21 | #define KIMAP_ACLJOBBASE_H |
22 | |
23 | #include "kimap_export.h" |
24 | |
25 | #include "acl.h" |
26 | #include "job.h" |
27 | |
28 | namespace KIMAP { |
29 | |
30 | class Session; |
31 | struct Message; |
32 | class AclJobBasePrivate; |
33 | |
34 | /** |
35 | * Base class for jobs that operate on mailbox ACLs |
36 | * |
37 | * Provides support for the IMAP ACL extension, as defined by |
38 | * <a href="http://www.apps.ietf.org/rfc/rfc4314.html" title="IMAP ACL extension">RFC 4314</a>. |
39 | * |
40 | * This class cannot be used directly, you must subclass it and reimplement |
41 | * at least the doStart() method. |
42 | */ |
43 | class KIMAP_EXPORT AclJobBase : public Job |
44 | { |
45 | Q_OBJECT |
46 | Q_DECLARE_PRIVATE( AclJobBase ) |
47 | |
48 | friend class SessionPrivate; |
49 | |
50 | public: |
51 | AclJobBase( Session *session ); |
52 | virtual ~AclJobBase(); |
53 | |
54 | /** |
55 | * Used when subclassing to specify how the ACL will be modified. |
56 | */ |
57 | enum AclModifier { |
58 | Add = 0, |
59 | Remove, |
60 | Change |
61 | }; |
62 | |
63 | /** |
64 | * Set the mailbox to act on |
65 | * |
66 | * @param mailBox the name of an existing mailbox |
67 | */ |
68 | void setMailBox( const QString &mailBox ); |
69 | /** |
70 | * The mailbox that will be acted upon. |
71 | */ |
72 | QString mailBox() const; |
73 | |
74 | protected: |
75 | explicit AclJobBase( JobPrivate &dd ); |
76 | |
77 | }; |
78 | |
79 | } |
80 | |
81 | #endif |
82 | |