KManageSieve::SieveJob

#include <sievejob.h>

Inheritance diagram for KManageSieve::SieveJob:

Signals

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

Public Member Functions

QString errorString () const
 
bool fileExists () const
 
void kill (KJob::KillVerbosity verbosity=KJob::Quietly)
 
QStringList sieveCapabilities () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Static Public Member Functions

static SieveJobactivate (const QUrl &url)
 
static SieveJobcheck (const QUrl &url, const QString &script)
 
static SieveJobdeactivate (const QUrl &url)
 
static SieveJobdel (const QUrl &url)
 
static SieveJobget (const QUrl &source)
 
static SieveJoblist (const QUrl &url)
 
static SieveJobput (const QUrl &destination, const QString &script, bool makeActive, bool wasActive)
 
static SieveJobrename (const QUrl &url, const QString &newName)
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

A job to manage sieve scripts.

This class provides functionality to manage sieve scripts on an IMAP server.

Definition at line 36 of file sievejob.h.

Member Function Documentation

SieveJob * SieveJob::activate ( const QUrl url)
static

Activates the script with the given sieve url.

Definition at line 384 of file sievejob.cpp.

SieveJob * SieveJob::check ( const QUrl url,
const QString script 
)
static

Check the script with the given sieve url.

Not supported by all sieve server

Definition at line 370 of file sievejob.cpp.

SieveJob * SieveJob::deactivate ( const QUrl url)
static

Deactivates the script with the given sieve url.

Definition at line 344 of file sievejob.cpp.

SieveJob * SieveJob::del ( const QUrl url)
static

Deletes the script with the given sieve url.

Definition at line 331 of file sievejob.cpp.

QString SieveJob::errorString ( ) const

A human-readable error message.

Definition at line 272 of file sievejob.cpp.

bool SieveJob::fileExists ( ) const

Returns whether the requested sieve script exists on the IMAP server.

Definition at line 267 of file sievejob.cpp.

SieveJob * SieveJob::get ( const QUrl source)
static

Gets a sieve script from an IMAP server.

Parameters
sourceThe sieve URL that describes the source.

Definition at line 304 of file sievejob.cpp.

void KManageSieve::SieveJob::gotList ( KManageSieve::SieveJob job,
bool  success,
const QStringList scriptList,
const QString activeScript 
)
signal

This signal is emitted when a list job has finished.

Parameters
jobThe job that has finished.
successWhether the job was successfully.
scriptListThe list of script filenames on the server.
activeScriptThe filename of the active script, or an empty string if no script is active.
void KManageSieve::SieveJob::gotScript ( KManageSieve::SieveJob job,
bool  success,
const QString script,
bool  active 
)
signal

This signal is emitted when a get job has finished.

Parameters
jobThe job that has finished
successWhether the job was successfully.
scriptThe downloaded sieve script.
activeWhether the script is active on the server.
void KManageSieve::SieveJob::item ( KManageSieve::SieveJob job,
const QString filename,
bool  active 
)
signal

This signal is emitted for each result entry of a list job.

Parameters
jobThe job the result belongs to.
filenameThe filename of the sieve script on the server.
activeWhether the script is active on the server.
void SieveJob::kill ( KJob::KillVerbosity  verbosity = KJob::Quietly)

Kills the sieve job.

Definition at line 250 of file sievejob.cpp.

SieveJob * SieveJob::list ( const QUrl url)
static

Lists all available scripts at the given sieve url.

Definition at line 318 of file sievejob.cpp.

SieveJob * SieveJob::put ( const QUrl destination,
const QString script,
bool  makeActive,
bool  wasActive 
)
static

Stores a sieve script on an IMAP server.

Parameters
destinationThe sieve URL that describes the destination.
scriptThe raw sieve script.
makeActiveIf true, the script will be marked as active.
wasActiveIf true, the script will be marked as inactive.

Definition at line 282 of file sievejob.cpp.

SieveJob * SieveJob::rename ( const QUrl url,
const QString newName 
)
static

Rename the script with the given sieve url and new name newName.

Not supported by all sieve server

Definition at line 356 of file sievejob.cpp.

void KManageSieve::SieveJob::result ( KManageSieve::SieveJob job,
bool  success,
const QString script,
bool  active 
)
signal

This signal is emitted for all kind of jobs when they have finished.

Parameters
jobThe job that has finished.
successWhether the job was successfully.
scriptThe script the action was about.
activeThe filename of the active script, or an
activeWhether the script is active on the server.
QStringList SieveJob::sieveCapabilities ( ) const

Returns the sieve capabilities of the IMAP server.

Definition at line 258 of file sievejob.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Thu Oct 22 2020 23:13:07 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.