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_CAPABILITIESJOB_H
21#define KIMAP_CAPABILITIESJOB_H
22
23#include "kimap_export.h"
24
25#include "job.h"
26
27namespace KIMAP {
28
29class Session;
30struct Message;
31class CapabilitiesJobPrivate;
32
33/**
34 * Checks server capabilities.
35 *
36 * This job can be run in any open session.
37 *
38 * This simply asks the server what capabilities it supports
39 * (using the CAPABILITY command) and returns the list
40 * provided by the server. The list may, therefore, be
41 * inaccurate: the server may claim to support something
42 * it does not implement properly, or it may omit a feature
43 * that it does, in reality, support.
44 */
45class KIMAP_EXPORT CapabilitiesJob : public Job
46{
47 Q_OBJECT
48 Q_DECLARE_PRIVATE( CapabilitiesJob )
49
50 friend class SessionPrivate;
51
52 public:
53 CapabilitiesJob( Session *session );
54 virtual ~CapabilitiesJob();
55
56 /**
57 * The capabilities the server claims to support.
58 *
59 * This will return an empty list until the job has completed.
60 */
61 QStringList capabilities() const;
62
63 Q_SIGNALS:
64 /**
65 * Notifies listeners that the capabilities have been fetched.
66 *
67 * @param capabilities The capabilities the server claims to support.
68 */
69 void capabilitiesReceived( const QStringList &capabilities );
70
71 protected:
72 virtual void doStart();
73 virtual void handleResponse( const Message &response );
74};
75
76}
77
78#endif
79