KIMAP2

deletejob.h
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 KIMAP2_DELETEJOB_H
21#define KIMAP2_DELETEJOB_H
22
23#include "kimap2_export.h"
24
25#include "job.h"
26
27namespace KIMAP2
28{
29
30class Session;
31class DeleteJobPrivate;
32
33/**
34 * Delete a mailbox
35 *
36 * Note that some servers will refuse to delete a
37 * mailbox unless it is empty (ie: all mails have
38 * had their \Deleted flag set, and then the
39 * mailbox has been expunged).
40 *
41 * This job can only be run when the session is in the
42 * authenticated (or selected) state.
43 *
44 * If the server supports ACLs, you will need the
45 * Acl::DeleteMailbox right on the mailbox.
46 */
47class KIMAP2_EXPORT DeleteJob : public Job
48{
49 Q_OBJECT
50 Q_DECLARE_PRIVATE(DeleteJob)
51
52 friend class SessionPrivate;
53
54public:
55 explicit DeleteJob(Session *session);
56 virtual ~DeleteJob();
57
58 /**
59 * Set the mailbox to delete.
60 */
61 void setMailBox(const QString &mailBox);
62 /**
63 * The mailbox that will be deleted.
64 */
65 QString mailBox() const;
66
67protected:
68 void doStart() override;
69 void handleResponse(const Message &response) override;
70};
71
72}
73
74#endif
Delete a mailbox.
Definition deletejob.h:48
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Jun 7 2024 12:04:08 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.