KIMAP::CapabilitiesJob

Search for usage in LXR

KIMAP::CapabilitiesJob Class Reference

#include <capabilitiesjob.h>

Signals

void capabilitiesReceived (const QStringList &capabilities)
 

Public Member Functions

 CapabilitiesJob (Session *session)
 
QStringList capabilities () const
 

Protected Member Functions

void doStart () override
 
void handleResponse (const Response &response) override
 

Detailed Description

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.

Definition at line 31 of file capabilitiesjob.h.

Constructor & Destructor Documentation

◆ CapabilitiesJob()

CapabilitiesJob::CapabilitiesJob ( Session * session)

Definition at line 34 of file capabilitiesjob.cpp.

◆ ~CapabilitiesJob()

CapabilitiesJob::~CapabilitiesJob ( )
override

Definition at line 39 of file capabilitiesjob.cpp.

Member Function Documentation

◆ capabilities()

QStringList CapabilitiesJob::capabilities ( ) const
nodiscard

The capabilities the server claims to support.

This will return an empty list until the job has completed.

Definition at line 43 of file capabilitiesjob.cpp.

◆ capabilitiesReceived

void KIMAP::CapabilitiesJob::capabilitiesReceived ( const QStringList & capabilities)
signal

Notifies listeners that the capabilities have been fetched.

Parameters
capabilitiesThe capabilities the server claims to support.

◆ doStart()

void CapabilitiesJob::doStart ( )
overrideprotected

Definition at line 49 of file capabilitiesjob.cpp.

◆ handleResponse()

void CapabilitiesJob::handleResponse ( const Response & response)
overrideprotected

Definition at line 55 of file capabilitiesjob.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Sat Dec 21 2024 17:01:17 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.