kmail

KMail::SieveJob

KMail::SieveJob Class Reference

List of all members.

Detailed Description

Definition at line 34 of file sievejob.h.


Public Types

enum  Existence { DontKnow, Yes, No }

Signals

void gotScript (KMail::SieveJob *job, bool success, const QString &script, bool active)
void gotList (KMail::SieveJob *job, bool success, const QStringList &scriptList, const QString &activeScript)
void result (KMail::SieveJob *job, bool success, const QString &script, bool active)
void item (KMail::SieveJob *job, const QString &filename, bool active)

Public Member Functions

void kill (bool quiet=true)
const QStringList & sieveCapabilities () const
bool fileExists () const

Static Public Member Functions

static SieveJob * put (const KURL &dest, const QString &script, bool makeActive, bool wasActive)
static SieveJob * get (const KURL &src, bool showProgressInfo=true)
static SieveJob * list (const KURL &url)
static SieveJob * del (const KURL &url)
static SieveJob * activate (const KURL &url)

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

 SieveJob (const KURL &url, const QString &script, const QValueStack< Command > &commands, QObject *parent=0, const char *name=0)
 SieveJob (const KURL &url, const QString &script, const QValueStack< Command > &commands, bool showProgressInfo, QObject *parent=0, const char *name=0)
virtual ~SieveJob ()
void schedule (Command command, bool showProgressInfo)

Protected Attributes

KURL mUrl
KIO::Job * mJob
QTextDecoder * mDec
QString mScript
QString mActiveScriptName
Existence mFileExists
QStringList mSieveCapabilities
QValueStack< Command > mCommands
bool mShowProgressInfo
QStringList mAvailableScripts

Member Function Documentation

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.

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.

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

kmail

API Dox
KDE Home | KDE Accessibility Home | Description of Access Keys