summaryrefslogtreecommitdiff
path: root/kimap/closejob.h
diff options
context:
space:
mode:
authorChristian Mollekopf <chrigi_1@fastmail.fm>2012-06-25 23:43:13 (GMT)
committerChristian Mollekopf <chrigi_1@fastmail.fm>2012-06-25 23:43:13 (GMT)
commite21e62c14f5aae99d46643065fcb86e2e3abe230 (patch)
tree71d79d2de0b0f82f8b0a6ca3b8b09308d198ed33 /kimap/closejob.h
parent172803b38237e38a494aca62fffda918e5799d20 (diff)
downloadlibcalendaring-e21e62c14f5aae99d46643065fcb86e2e3abe230.tar.gz
initial import of kimap from
commit b54a325116b194da090f900c9a538710759eb303 Author: Stephen Kelly <steveire@gmail.com> Date: Sun May 6 20:44:53 2012 +0200 Revert "Port to const QRegExp API." This reverts commit 0ca0dfc7e0ca8095efd0b060d1d5e26ac9ceb379. The qtbase commit requiring this was reverted.
Diffstat (limited to 'kimap/closejob.h')
-rw-r--r--kimap/closejob.h69
1 files changed, 69 insertions, 0 deletions
diff --git a/kimap/closejob.h b/kimap/closejob.h
new file mode 100644
index 0000000..3cadc72
--- /dev/null
+++ b/kimap/closejob.h
@@ -0,0 +1,69 @@
+/*
+ Copyright (c) 2009 Andras Mantia <amantia@kde.org>
+
+ This library is free software; you can redistribute it and/or modify it
+ under the terms of the GNU Library General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or (at your
+ option) any later version.
+
+ This library is distributed in the hope that it will be useful, but WITHOUT
+ ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
+ License for more details.
+
+ You should have received a copy of the GNU Library General Public License
+ along with this library; see the file COPYING.LIB. If not, write to the
+ Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ 02110-1301, USA.
+*/
+
+#ifndef KIMAP_CLOSEJOB_H
+#define KIMAP_CLOSEJOB_H
+
+#include "kimap_export.h"
+
+#include "job.h"
+
+namespace KIMAP {
+
+class Session;
+struct Message;
+class CloseJobPrivate;
+
+/**
+ * Closes the current mailbox.
+ *
+ * This job can only be run when the session is in the selected state.
+ *
+ * Permanently removes all messages that have the \\Deleted
+ * flag set from the currently selected mailbox, and returns
+ * to the authenticated state from the selected state.
+ *
+ * The server will not provide any notifications of which
+ * messages were expunged, so this is quicker than doing
+ * an expunge and then implicitly closing the mailbox
+ * (by selecting or examining another mailbox or logging
+ * out).
+ *
+ * No messages are removed if the mailbox is open in a read-only
+ * state, or if the server supports ACLs and the user does not
+ * have the Acl::Expunge right on the mailbox.
+ */
+class KIMAP_EXPORT CloseJob : public Job
+{
+ Q_OBJECT
+ Q_DECLARE_PRIVATE(CloseJob)
+
+ friend class SessionPrivate;
+
+ public:
+ explicit CloseJob( Session *session );
+ virtual ~CloseJob();
+
+ protected:
+ virtual void doStart();
+};
+
+}
+
+#endif