KMail::SieveJob Class Reference

#include <sievejob.h>

Inheritance diagram for KMail::SieveJob:


Public Types
enum	Existence { DontKnow, Yes, No }
Signals
void	gotList (KMail::SieveJob *job, bool success, const QStringList &scriptList, const QString &activeScript)
void	gotScript (KMail::SieveJob *job, bool success, const QString &script, bool active)
void	item (KMail::SieveJob *job, const QString &filename, bool active)
void	result (KMail::SieveJob *job, bool success, const QString &script, bool active)
Public Member Functions
bool	fileExists () const
void	kill (bool quiet=true)
const QStringList &	sieveCapabilities () const
Static Public Member Functions
static SieveJob *	activate (const KURL &url)
static SieveJob *	del (const KURL &url)
static SieveJob *	get (const KURL &src, bool showProgressInfo=true)
static SieveJob *	list (const KURL &url)
static SieveJob *	put (const KURL &dest, const QString &script, bool makeActive, bool wasActive)
Protected Types
enum	Command { Get, Put, Activate, Deactivate, SearchActive, List, Delete }
Protected Slots
void	slotData (KIO::Job *, const QByteArray &)
void	slotDataReq (KIO::Job *, QByteArray &)
void	slotEntries (KIO::Job *, const KIO::UDSEntryList &)
void	slotResult (KIO::Job *)
Protected Member Functions
void	schedule (Command command, bool showProgressInfo)
	SieveJob (const KURL &url, const QString &script, const QValueStack< Command > &commands, bool showProgressInfo, QObject parent=0, const char name=0)
	SieveJob (const KURL &url, const QString &script, const QValueStack< Command > &commands, QObject parent=0, const char name=0)
virtual	~SieveJob ()
Protected Attributes
QString	mActiveScriptName
QStringList	mAvailableScripts
QValueStack< Command >	mCommands
QTextDecoder *	mDec
Existence	mFileExists
KIO::Job *	mJob
QString	mScript
bool	mShowProgressInfo
QStringList	mSieveCapabilities
KURL	mUrl

Detailed Description

Definition at line 34 of file sievejob.h.

Member Enumeration Documentation

enum KMail::SieveJob::Command [protected]

Enumerator:

Get
Put
Activate
Deactivate
SearchActive
List
Delete

Definition at line 37 of file sievejob.h.

enum KMail::SieveJob::Existence

Enumerator:

DontKnow
Yes
No

Definition at line 48 of file sievejob.h.

Constructor & Destructor Documentation

KMail::SieveJob::SieveJob	(	const KURL &	url,
		const QString &	script,
		const QValueStack< Command > &	commands,
		QObject *	parent = `0`,
		const char *	name = `0`
	)			`[protected]`

Definition at line 35 of file sievejob.cpp.

KMail::SieveJob::SieveJob	(	const KURL &	url,
		const QString &	script,
		const QValueStack< Command > &	commands,
		bool	showProgressInfo,
		QObject *	parent = `0`,
		const char *	name = `0`
	)			`[protected]`

Definition at line 47 of file sievejob.cpp.

KMail::SieveJob::~SieveJob ( ) [protected, virtual]

Definition at line 60 of file sievejob.cpp.

Member Function Documentation

SieveJob * KMail::SieveJob::activate ( const KURL & url ) [static]

Definition at line 278 of file sievejob.cpp.

SieveJob * KMail::SieveJob::del ( const KURL & url ) [static]

Definition at line 272 of file sievejob.cpp.

bool KMail::SieveJob::fileExists ( ) const [inline]

Definition at line 77 of file sievejob.h.

SieveJob * KMail::SieveJob::get	(	const KURL &	src,
		bool	showProgressInfo = `true`
	)			`[static]`

Get a specific Sieve script.

Definition at line 260 of file sievejob.cpp.

void KMail::SieveJob::gotList	(	KMail::SieveJob *	job,
		bool	success,
		const QStringList &	scriptList,
		const QString &	activeScript
	)			`[signal]`

We got the list of available scripts.

Parameters:

	scriptList	is the list of script filenames
	activeScript	lists the filename of the active script, or an empty string if no script is active.

void KMail::SieveJob::gotScript	(	KMail::SieveJob *	job,
		bool	success,
		const QString &	script,
		bool	active
	)			`[signal]`

void KMail::SieveJob::item	(	KMail::SieveJob *	job,
		const QString &	filename,
		bool	active
	)			`[signal]`

void KMail::SieveJob::kill ( bool quiet = true )

Definition at line 66 of file sievejob.cpp.

SieveJob * KMail::SieveJob::list ( const KURL & url ) [static]

List all available scripts.

Definition at line 267 of file sievejob.cpp.

SieveJob * KMail::SieveJob::put	(	const KURL &	dest,
		const QString &	script,
		bool	makeActive,
		bool	wasActive
	)			`[static]`

Store a Sieve script.

If

Parameters:

makeActive

is set, also mark the script active

Definition at line 249 of file sievejob.cpp.

void KMail::SieveJob::result	(	KMail::SieveJob *	job,
		bool	success,
		const QString &	script,
		bool	active
	)			`[signal]`

void KMail::SieveJob::schedule	(	Command	command,
		bool	showProgressInfo
	)			`[protected]`

Definition at line 70 of file sievejob.cpp.

const QStringList& KMail::SieveJob::sieveCapabilities ( ) const [inline]

Definition at line 73 of file sievejob.h.

void KMail::SieveJob::slotData	(	KIO::Job *	,
		const QByteArray &
	)			`[protected, slot]`

void KMail::SieveJob::slotDataReq	(	KIO::Job *	,
		QByteArray &
	)			`[protected, slot]`

void KMail::SieveJob::slotEntries	(	KIO::Job *	,
		const KIO::UDSEntryList &
	)			`[protected, slot]`

void KMail::SieveJob::slotResult ( KIO::Job * ) [protected, slot]

Member Data Documentation

QString KMail::SieveJob::mActiveScriptName [protected]

Definition at line 114 of file sievejob.h.

QStringList KMail::SieveJob::mAvailableScripts [protected]

Definition at line 121 of file sievejob.h.

QValueStack<Command> KMail::SieveJob::mCommands [protected]

Definition at line 117 of file sievejob.h.

QTextDecoder* KMail::SieveJob::mDec [protected]

Definition at line 112 of file sievejob.h.

Existence KMail::SieveJob::mFileExists [protected]

Definition at line 115 of file sievejob.h.

KIO::Job* KMail::SieveJob::mJob [protected]

Definition at line 111 of file sievejob.h.

QString KMail::SieveJob::mScript [protected]

Definition at line 113 of file sievejob.h.

bool KMail::SieveJob::mShowProgressInfo [protected]

Definition at line 118 of file sievejob.h.

QStringList KMail::SieveJob::mSieveCapabilities [protected]

Definition at line 116 of file sievejob.h.

KURL KMail::SieveJob::mUrl [protected]

Definition at line 110 of file sievejob.h.

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

kmail

KMail::SieveJob Class Reference

Public Types

Signals

Public Member Functions

Static Public Member Functions

Protected Types

Protected Slots

Protected Member Functions