KIMAP2

expungejob.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_EXPUNGEJOB_H
21 #define KIMAP2_EXPUNGEJOB_H
22 
23 #include "kimap2_export.h"
24 
25 #include "job.h"
26 
27 namespace KIMAP2
28 {
29 
30 class Session;
31 struct Message;
32 class ExpungeJobPrivate;
33 
34 /**
35  * Expunges the deleted messages in the selected mailbox.
36  *
37  * This permanently removes any messages that have the
38  * \Deleted flag set in the selected mailbox.
39  *
40  * This job can only be run when the session is in the
41  * selected state.
42  *
43  * If the server supports ACLs, the user will need the
44  * Acl::Expunge right on the mailbox.
45  */
46 class KIMAP2_EXPORT ExpungeJob : public Job
47 {
48  Q_OBJECT
49  Q_DECLARE_PRIVATE(ExpungeJob)
50 
51  friend class SessionPrivate;
52 
53 public:
54  explicit ExpungeJob(Session *session);
55  virtual ~ExpungeJob();
56 
57 protected:
58  void doStart() Q_DECL_OVERRIDE;
59  void handleResponse(const Message &response) Q_DECL_OVERRIDE;
60 };
61 
62 }
63 
64 #endif
Expunges the deleted messages in the selected mailbox.
Definition: expungejob.h:46
Definition: acl.cpp:25
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.