kmail Library API Documentation

KMail::ScheduledExpireTask Class Reference

A scheduled "expire mails in this folder" task. More...

#include <expirejob.h>

Inheritance diagram for KMail::ScheduledExpireTask:

Inheritance graph
[legend]
Collaboration diagram for KMail::ScheduledExpireTask:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ScheduledExpireTask (KMFolder *folder, bool immediate)
virtual ScheduledJobrun ()
virtual int taskTypeId () const

Detailed Description

A scheduled "expire mails in this folder" task.

Definition at line 64 of file expirejob.h.


Constructor & Destructor Documentation

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


Member Function Documentation

virtual ScheduledJob* KMail::ScheduledExpireTask::run  )  [inline, virtual]
 

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

References KMail::ScheduledTask::folder().

virtual int KMail::ScheduledExpireTask::taskTypeId  )  const [inline, virtual]
 

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 KMail::ScheduledTask.

Definition at line 75 of file expirejob.h.


The documentation for this class was generated from the following file:
KDE Logo
This file is part of the documentation for kmail Library Version 3.3.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Aug 23 18:21:52 2007 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003