KIMAP2

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

KDE's Doxygen guidelines are available online.