KSieveCore::GenerateGlobalScriptJob Class

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

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

Public Functions

GenerateGlobalScriptJob(const QUrl &url, QObject *parent = nullptr)
virtual ~GenerateGlobalScriptJob() override
void addUserActiveScripts(const QStringList &lstScript)
void kill()
void setForceActivateUserScript(bool f)
void start()

Signals

void error(const QString &msgError)
void success()

Detailed Description

Member Function Documentation

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

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

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

Destroys the GenerateGlobalScriptJob.

void GenerateGlobalScriptJob::addUserActiveScripts(const QStringList &lstScript)

Adds the list of user active scripts to include in the global script. lstScript A list of active script names.

[signal] void GenerateGlobalScriptJob::error(const QString &msgError)

Emitted when an error occurs during global script generation. msgError The error message.

void GenerateGlobalScriptJob::kill()

Cancels the running job.

void GenerateGlobalScriptJob::setForceActivateUserScript(bool f)

Forces the activation of the user script in the global script. f true to force activation.

void GenerateGlobalScriptJob::start()

Starts the job to generate and upload the global script.

[signal] void GenerateGlobalScriptJob::success()

Emitted when the global script is successfully generated and uploaded.