MailCommon::ScheduledExpireTask
#include <expirejob.h>
Public Member Functions | |
ScheduledExpireTask (const Akonadi::Collection &folder, bool immediate) | |
ScheduledJob * | run () override |
int | taskTypeId () const override |
Public Member Functions inherited from MailCommon::ScheduledTask | |
ScheduledTask (const Akonadi::Collection &folder, bool immediate) | |
Akonadi::Collection | folder () const |
bool | isImmediate () const |
Detailed Description
A scheduled "expire mails in this folder" task.
Definition at line 45 of file expirejob.h.
Constructor & Destructor Documentation
◆ ScheduledExpireTask()
|
inline |
If immediate is set, the job will execute synchronously.
This is used when the user requests explicitly that the operation should happen immediately.
Definition at line 50 of file expirejob.h.
Member Function Documentation
◆ run()
|
inlineoverridevirtual |
Run this task, i.e.
create a job for it. Important: the job's execute() method must either call open() on the folder or storage immediately, or abort (deleting itself). Usually, that job should also be cancellable. Otherwise (if the open() is delayed) an unrelated open() could happen first and mess things up. If for some reason (e.g. a folder is deleted) nothing should be done, return 0.
Implements MailCommon::ScheduledTask.
Definition at line 57 of file expirejob.h.
◆ taskTypeId()
|
inlineoverridevirtual |
An identifier for the type of task (a bit like QListViewItem::rtti).
This allows to automatically prevent two identical tasks from being scheduled for the same folder. To circumvent this feature and make every task unique, return 0 here.
Implements MailCommon::ScheduledTask.
Definition at line 62 of file expirejob.h.
The documentation for this class was generated from the following file:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Tue Mar 26 2024 11:14:01 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.