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_DELETEJOB_H |
21 | #define KIMAP_DELETEJOB_H |
22 | |
23 | #include "kimap_export.h" |
24 | |
25 | #include "job.h" |
26 | |
27 | namespace KIMAP { |
28 | |
29 | class Session; |
30 | class DeleteJobPrivate; |
31 | |
32 | /** |
33 | * Delete a mailbox |
34 | * |
35 | * Note that some servers will refuse to delete a |
36 | * mailbox unless it is empty (ie: all mails have |
37 | * had their \Deleted flag set, and then the |
38 | * mailbox has been expunged). |
39 | * |
40 | * This job can only be run when the session is in the |
41 | * authenticated (or selected) state. |
42 | * |
43 | * If the server supports ACLs, you will need the |
44 | * Acl::DeleteMailbox right on the mailbox. |
45 | */ |
46 | class KIMAP_EXPORT DeleteJob : public Job |
47 | { |
48 | Q_OBJECT |
49 | Q_DECLARE_PRIVATE( DeleteJob ) |
50 | |
51 | friend class SessionPrivate; |
52 | |
53 | public: |
54 | explicit DeleteJob( Session *session ); |
55 | virtual ~DeleteJob(); |
56 | |
57 | /** |
58 | * Set the mailbox to delete. |
59 | */ |
60 | void setMailBox( const QString &mailBox ); |
61 | /** |
62 | * The mailbox that will be deleted. |
63 | */ |
64 | QString mailBox() const; |
65 | |
66 | protected: |
67 | virtual void doStart(); |
68 | }; |
69 | |
70 | } |
71 | |
72 | #endif |
73 | |