KSieveCore::VacationCheckJob Class

The VacationCheckJob class Author: Laurent Montel <montel@kde.org>. More...

Header: #include <KSieveCore/VacationCheckJob>
CMake: find_package(KPim6KSieveCore REQUIRED)
target_link_libraries(mytarget PRIVATE KPim6::KSieveCore)
Inherits: QObject

Public Functions

VacationCheckJob(const QUrl &url, const QString &serverName, QObject *parent = nullptr)
virtual ~VacationCheckJob() override
void kill()
bool noScriptFound() const
QString script() const
QString serverName() const
void setKep14Support(bool kep14Support)
QStringList sieveCapabilities() const
void start()

Signals

void error(const QString &errorStr)
void vacationScriptActive(KSieveCore::VacationCheckJob *job, const QString &sscriptName, bool active)

Private Slots

void emitError(const QString &errorMessage)
void getNextScript()
void searchVacationScript()
void slotGetResult(KManageSieve::SieveJob *job, bool success, const QString &script, bool active)
void slotGotActiveScripts(KSieveCore::ParseUserScriptJob *job)
void slotGotList(KManageSieve::SieveJob *job, bool success, const QStringList &availableScripts, const QString &activeScript)

Detailed Description

Member Function Documentation

[explicit] VacationCheckJob::VacationCheckJob(const QUrl &url, const QString &serverName, QObject *parent = nullptr)

Constructs a VacationCheckJob with the given URL, server name, and parent object. url The Sieve server URL. serverName The name of the server. parent The parent object.

[override virtual noexcept] VacationCheckJob::~VacationCheckJob()

Destroys the VacationCheckJob.

[private slot] void VacationCheckJob::emitError(const QString &errorMessage)

[signal] void VacationCheckJob::error(const QString &errorStr)

Emitted when an error occurs during the check. errorStr The error message.

[private slot] void VacationCheckJob::getNextScript()

void VacationCheckJob::kill()

Cancels the running job.

bool VacationCheckJob::noScriptFound() const

Checks if no vacation script was found. Returns true if no script was found.

QString VacationCheckJob::script() const

Returns the vacation script found. Returns The script content.

[private slot] void VacationCheckJob::searchVacationScript()

QString VacationCheckJob::serverName() const

Returns the server name. Returns The server name.

void VacationCheckJob::setKep14Support(bool kep14Support)

Sets whether the server supports KEP:14 (Kolab vacation extension). kep14Support true if KEP:14 is supported.

QStringList VacationCheckJob::sieveCapabilities() const

Returns the Sieve capabilities of the server. Returns A list of capability strings.

[private slot] void VacationCheckJob::slotGetResult(KManageSieve::SieveJob *job, bool success, const QString &script, bool active)

[private slot] void VacationCheckJob::slotGotActiveScripts(KSieveCore::ParseUserScriptJob *job)

[private slot] void VacationCheckJob::slotGotList(KManageSieve::SieveJob *job, bool success, const QStringList &availableScripts, const QString &activeScript)

void VacationCheckJob::start()

Starts the vacation check job.

[signal] void VacationCheckJob::vacationScriptActive(KSieveCore::VacationCheckJob *job, const QString &sscriptName, bool active)

Emitted when the vacation script status has been checked. job This job instance. sscriptName The name of the vacation script. active true if the vacation script is active.