KSieveCore::VacationCreateScriptJob Class
The VacationCreateScriptJob class Author: Laurent Montel <montel@kde.org>. More...
| Header: | #include <KSieveCore/VacationCreateScriptJob> |
| CMake: | find_package(KPim6KSieveCore REQUIRED)target_link_libraries(mytarget PRIVATE KPim6::KSieveCore) |
| Inherits: | QObject |
Public Functions
| VacationCreateScriptJob(QObject *parent = nullptr) | |
| virtual | ~VacationCreateScriptJob() override |
| void | kill() |
| const QString & | serverName() const |
| void | setKep14Support(bool kep14Support) |
| void | setScript(const QString &script) |
| void | setServerName(const QString &servername) |
| void | setServerUrl(const QUrl &url) |
| void | setStatus(bool activate, bool wasActive) |
| void | start() |
Signals
| void | result(bool) |
| void | scriptActive(bool activated, const QString &serverName) |
Private Slots
| void | slotGenerateDone(const QString &error = QString()) |
| void | slotGetScript(KManageSieve::SieveJob *job, bool success, const QString &oldScript, bool active) |
| void | slotGotActiveScripts(KSieveCore::ParseUserScriptJob *job) |
| void | slotPutResult(KManageSieve::SieveJob *job, bool success) |
Detailed Description
Member Function Documentation
[explicit] VacationCreateScriptJob::VacationCreateScriptJob(QObject *parent = nullptr)
Constructs a VacationCreateScriptJob with the given parent object. parent The parent object.
[override virtual noexcept] VacationCreateScriptJob::~VacationCreateScriptJob()
Destroys the VacationCreateScriptJob.
void VacationCreateScriptJob::kill()
Cancels the running job.
[signal] void VacationCreateScriptJob::result(bool)
Emitted when the job completes. true if the job succeeded.
[signal] void VacationCreateScriptJob::scriptActive(bool activated, const QString &serverName)
Emitted when the script's activation status changes. activated true if the script was activated. serverName The name of the server.
const QString &VacationCreateScriptJob::serverName() const
Returns the server name. Returns The server name.
See also setServerName().
void VacationCreateScriptJob::setKep14Support(bool kep14Support)
Sets whether the server supports KEP:14 (Kolab vacation extension). kep14Support true if KEP:14 is supported.
void VacationCreateScriptJob::setScript(const QString &script)
Sets the vacation script content. script The script to upload.
void VacationCreateScriptJob::setServerName(const QString &servername)
Sets the server name. servername The name of the server.
See also serverName().
void VacationCreateScriptJob::setServerUrl(const QUrl &url)
Sets the Sieve server URL. url The server URL.
void VacationCreateScriptJob::setStatus(bool activate, bool wasActive)
Sets the desired activation status for the vacation script. activate true to activate the script, false to deactivate. wasActive true if the script was already active.
[private slot] void VacationCreateScriptJob::slotGenerateDone(const QString &error = QString())
[private slot] void VacationCreateScriptJob::slotGetScript(KManageSieve::SieveJob *job, bool success, const QString &oldScript, bool active)
[private slot] void VacationCreateScriptJob::slotGotActiveScripts(KSieveCore::ParseUserScriptJob *job)
[private slot] void VacationCreateScriptJob::slotPutResult(KManageSieve::SieveJob *job, bool success)
void VacationCreateScriptJob::start()
Starts the job to create and upload the vacation script.