KMail::ScheduledExpireTask Class Reference

#include <expirejob.h>

Inheritance diagram for KMail::ScheduledExpireTask:

Public Member Functions
	ScheduledExpireTask (KMFolder *folder, bool immediate)
virtual ScheduledJob *	run ()
virtual int	taskTypeId () const
Public Member Functions inherited from KMail::ScheduledTask
	ScheduledTask (KMFolder *folder, bool immediate)
KMFolder *	folder () const
bool	isImmediate () const

Detailed Description

A scheduled "expire mails in this folder" task.

Definition at line 65 of file expirejob.h.

Constructor & Destructor Documentation

ScheduledExpireTask()

KMail::ScheduledExpireTask::ScheduledExpireTask ( KMFolder *  folder, bool  immediate  )

inline

If immediate is set, the job will execute synchronously.

This is used when the user requests explicitely that the operation should happen immediately.

Definition at line 70 of file expirejob.h.

Member Function Documentation

run()

virtual ScheduledJob* KMail::ScheduledExpireTask::run ( )

inlinevirtual

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. folder deleted) nothing should be done, return 0.

Implements KMail::ScheduledTask.

Definition at line 73 of file expirejob.h.

taskTypeId()

virtual int KMail::ScheduledExpireTask::taskTypeId ( ) const

inlinevirtual

An identifier for the type of task (a bit like TQListViewItem::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 KMail::ScheduledTask.

Definition at line 76 of file expirejob.h.

---

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

• expirejob.h