1/*
2 Copyright (c) 2009 Kevin Ottens <ervin@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_SELECTJOB_H
21#define KIMAP_SELECTJOB_H
22
23#include "kimap_export.h"
24
25#include "job.h"
26
27namespace KIMAP {
28
29class Session;
30struct Message;
31class SelectJobPrivate;
32
33class KIMAP_EXPORT SelectJob : public Job
34{
35 Q_OBJECT
36 Q_DECLARE_PRIVATE( SelectJob )
37
38 friend class SessionPrivate;
39
40 public:
41 explicit SelectJob( Session *session );
42 virtual ~SelectJob();
43
44 void setMailBox( const QString &mailBox );
45 QString mailBox() const;
46
47 void setOpenReadOnly( bool readOnly );
48 bool isOpenReadOnly() const;
49
50 QList<QByteArray> flags() const;
51 QList<QByteArray> permanentFlags() const;
52
53 int messageCount() const;
54 int recentCount() const;
55 int firstUnseenIndex() const;
56
57 qint64 uidValidity() const;
58 qint64 nextUid() const;
59
60 /**
61 * @return Highest mod-sequence value of all messages in the mailbox or 0
62 * if the server does not have CONDSTORE capability (RFC4551) or does not
63 * support persistent storage of mod-sequences.
64 *
65 * @since 4.12
66 */
67 quint64 highestModSequence() const;
68
69 /**
70 * Whether to append CONDSTORE parameter to the SELECT command.
71 *
72 * This option is false by default and can be enabled only when server
73 * has CONDSTORE capability (RFC4551), otherwise the SELECT command will
74 * fail.
75 *
76 * @since 4.12
77 */
78 void setCondstoreEnabled( bool enable );
79
80 /**
81 * Returns whether the CONDSTORE parameter will be appended to SELECT command
82 *
83 * @since 4.12
84 */
85 bool condstoreEnabled() const;
86
87 protected:
88 virtual void doStart();
89 virtual void handleResponse( const Message &response );
90};
91
92}
93
94#endif
95