kde-playground/kdepimlibs/kimap/capabilitiesjob.h
2015-04-14 21:49:29 +00:00

78 lines
2.2 KiB
C++

/*
Copyright (c) 2009 Kevin Ottens <ervin@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_CAPABILITIESJOB_H
#define KIMAP_CAPABILITIESJOB_H
#include "kimap_export.h"
#include "job.h"
namespace KIMAP {
class Session;
struct Message;
class CapabilitiesJobPrivate;
/**
* Checks server capabilities.
*
* This job can be run in any open session.
*
* This simply asks the server what capabilities it supports
* (using the CAPABILITY command) and returns the list
* provided by the server. The list may, therefore, be
* inaccurate: the server may claim to support something
* it does not implement properly, or it may omit a feature
* that it does, in reality, support.
*/
class KIMAP_EXPORT CapabilitiesJob : public Job
{
Q_OBJECT
Q_DECLARE_PRIVATE( CapabilitiesJob )
friend class SessionPrivate;
public:
CapabilitiesJob( Session *session );
virtual ~CapabilitiesJob();
/**
* The capabilities the server claims to support.
*
* This will return an empty list until the job has completed.
*/
QStringList capabilities() const;
Q_SIGNALS:
/**
* Notifies listeners that the capabilities have been fetched.
*
* @param capabilities The capabilities the server claims to support.
*/
void capabilitiesReceived( const QStringList &capabilities );
protected:
virtual void doStart();
virtual void handleResponse( const Message &response );
};
}
#endif