File indexing completed on 2024-05-12 05:17:21

0001 /*
0002     Copyright (c) 2009 Andras Mantia <amantia@kde.org>
0003 
0004     This library is free software; you can redistribute it and/or modify it
0005     under the terms of the GNU Library General Public License as published by
0006     the Free Software Foundation; either version 2 of the License, or (at your
0007     option) any later version.
0008 
0009     This library is distributed in the hope that it will be useful, but WITHOUT
0010     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0011     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
0012     License for more details.
0013 
0014     You should have received a copy of the GNU Library General Public License
0015     along with this library; see the file COPYING.LIB.  If not, write to the
0016     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
0017     02110-1301, USA.
0018 */
0019 
0020 #ifndef KIMAP2_EXPUNGEJOB_H
0021 #define KIMAP2_EXPUNGEJOB_H
0022 
0023 #include "kimap2_export.h"
0024 
0025 #include "job.h"
0026 
0027 namespace KIMAP2
0028 {
0029 
0030 class Session;
0031 struct Message;
0032 class ExpungeJobPrivate;
0033 
0034 /**
0035  * Expunges the deleted messages in the selected mailbox.
0036  *
0037  * This permanently removes any messages that have the
0038  * \Deleted flag set in the selected mailbox.
0039  *
0040  * This job can only be run when the session is in the
0041  * selected state.
0042  *
0043  * If the server supports ACLs, the user will need the
0044  * Acl::Expunge right on the mailbox.
0045  */
0046 class KIMAP2_EXPORT ExpungeJob : public Job
0047 {
0048     Q_OBJECT
0049     Q_DECLARE_PRIVATE(ExpungeJob)
0050 
0051     friend class SessionPrivate;
0052 
0053 public:
0054     explicit ExpungeJob(Session *session);
0055     virtual ~ExpungeJob();
0056 
0057 protected:
0058     void doStart() Q_DECL_OVERRIDE;
0059     void handleResponse(const Message &response) Q_DECL_OVERRIDE;
0060 };
0061 
0062 }
0063 
0064 #endif