KManageSieve::SieveJob

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)

QBindable< QString >	bindableObjectName ()

bool	blockSignals (bool block)

const QObjectList &	children () 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 () const const

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isQuickItemType () const const

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	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

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setObjectName (QAnyStringView name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	setProperty (const char *name, QVariant &&value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)

QThread *	thread () const const

Static Public Member Functions
static SieveJob *	activate (const QUrl &url)

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

static SieveJob *	deactivate (const QUrl &url)

static SieveJob *	del (const QUrl &url)

static SieveJob *	get (const QUrl &source)

static SieveJob *	list (const QUrl &url)

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

static SieveJob *	rename (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 context, Functor functor, 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)

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, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

Additional Inherited Members
Public Types inherited from QObject
typedef	QObjectList

Properties inherited from QObject
	objectName

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

QObject *	sender () 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 30 of file sievejob.h.

Member Function Documentation

◆ activate()

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

static

Activates the script with the given sieve url.

Definition at line 380 of file sievejob.cpp.

◆ check()

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 366 of file sievejob.cpp.

◆ deactivate()

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

static

Deactivates the script with the given sieve url.

Definition at line 340 of file sievejob.cpp.

◆ del()

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

static

Deletes the script with the given sieve url.

Definition at line 327 of file sievejob.cpp.

◆ errorString()

QString SieveJob::errorString ( ) const

nodiscard

A human-readable error message.

Definition at line 268 of file sievejob.cpp.

◆ fileExists()

bool SieveJob::fileExists ( ) const

nodiscard

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

Definition at line 263 of file sievejob.cpp.

◆ get()

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

static

Gets a sieve script from an IMAP server.

Parameters

source The sieve URL that describes the source.

Definition at line 300 of file sievejob.cpp.

◆ gotList

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

job	The job that has finished.
success	Whether the job was successfully.
scriptList	The list of script filenames on the server.
activeScript	The filename of the active script, or an empty string if no script is active.

◆ gotScript

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

job	The job that has finished
success	Whether the job was successfully.
script	The downloaded sieve script.
active	Whether the script is active on the server.

◆ item

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

job	The job the result belongs to.
filename	The filename of the sieve script on the server.
active	Whether the script is active on the server.

◆ kill()

void SieveJob::kill ( KJob::KillVerbosity verbosity = KJob::Quietly )

Kills the sieve job.

Definition at line 246 of file sievejob.cpp.

◆ list()

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

static

Lists all available scripts at the given sieve url.

Definition at line 314 of file sievejob.cpp.

◆ put()

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

static

Stores a sieve script on an IMAP server.

Parameters

destination	The sieve URL that describes the destination.
script	The raw sieve script.
makeActive	If `true`, the script will be marked as active.
wasActive	If `true`, the script will be marked as inactive.

Definition at line 278 of file sievejob.cpp.

◆ rename()

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 352 of file sievejob.cpp.

◆ result

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

job	The job that has finished.
success	Whether the job was successfully.
script	The script the action was about.
active	The filename of the active script, or an
active	Whether the script is active on the server.

◆ sieveCapabilities()

QStringList SieveJob::sieveCapabilities ( ) const

nodiscard

Returns the sieve capabilities of the IMAP server.

Definition at line 254 of file sievejob.cpp.

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About Libksieve

KManageSieve::SieveJob

Signals

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ activate()

◆ check()

◆ deactivate()

◆ del()

◆ errorString()

◆ fileExists()

◆ get()

◆ gotList

◆ gotScript

◆ item

◆ kill()

◆ list()

◆ put()

◆ rename()

◆ result

◆ sieveCapabilities()