KSieveCore::ParseUserScriptJob Class

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

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

Public Functions

ParseUserScriptJob(const QUrl &url, QObject *parent = nullptr)
virtual ~ParseUserScriptJob() override
QStringList activeScriptList() const
QString error() const
void kill()
QStringList parsescript(const QString &script, bool &result)
QUrl scriptUrl() const
void setAutoDelete(bool deleteMe)
void start()

Signals

void finished(KSieveCore::ParseUserScriptJob *job)

Detailed Description

Member Function Documentation

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

Constructs a ParseUserScriptJob with the given server URL and parent object. url The Sieve server URL. parent The parent object.

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

Destroys the ParseUserScriptJob.

QStringList ParseUserScriptJob::activeScriptList() const

Returns the list of active scripts found in the user script. Returns A list of active script names.

QString ParseUserScriptJob::error() const

Returns the error message if parsing failed. Returns The error message.

[signal] void ParseUserScriptJob::finished(KSieveCore::ParseUserScriptJob *job)

Emitted when the script parsing is finished. job This job instance.

void ParseUserScriptJob::kill()

Cancels the running job.

QStringList ParseUserScriptJob::parsescript(const QString &script, bool &result)

Parses a Sieve script and extracts active scripts. script The script to parse. result Reference to a boolean set to true if parsing succeeded. Returns A list of active scripts found.

QUrl ParseUserScriptJob::scriptUrl() const

Returns the URL of the parsed script. Returns The script URL.

void ParseUserScriptJob::setAutoDelete(bool deleteMe)

Sets whether the job should delete itself after completion. deleteMe true to auto-delete the job.

void ParseUserScriptJob::start()

Starts the job to parse the user script.