MailCommon::ScheduledExpireTask Class Reference

#include <expirejob.h>

Inheritance diagram for MailCommon::ScheduledExpireTask:

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 43 of file expirejob.h.

Constructor & Destructor Documentation

ScheduledExpireTask()

MailCommon::ScheduledExpireTask::ScheduledExpireTask ( const Akonadi::Collection & folder, bool immediate )

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 48 of file expirejob.h.

Member Function Documentation

run()

ScheduledJob * MailCommon::ScheduledExpireTask::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 55 of file expirejob.h.

taskTypeId()

int MailCommon::ScheduledExpireTask::taskTypeId ( ) const

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 60 of file expirejob.h.

---

The documentation for this class was generated from the following file:

• expirejob.h