Akonadi::MessageQueueJob Class Reference

#include <messagequeuejob.h>

Inheritance diagram for Akonadi::MessageQueueJob:

Public Member Functions
	MessageQueueJob (QObject *parent=nullptr)
	~MessageQueueJob () override
Akonadi::AddressAttribute &	addressAttribute ()
DispatchModeAttribute &	dispatchModeAttribute ()
KMime::Message::Ptr	message () const
SentActionAttribute &	sentActionAttribute ()
SentBehaviourAttribute &	sentBehaviourAttribute ()
void	setMessage (const KMime::Message::Ptr &message)
void	start () override
TransportAttribute &	transportAttribute ()
Public Member Functions inherited from KCompositeJob
	KCompositeJob (QObject *parent=nullptr)
Public Member Functions inherited from KJob
	KJob (QObject *parent=nullptr)
Capabilities	capabilities () const
qint64	elapsedTime () const
int	error () const
virtual QString	errorString () const
QString	errorText () const
bool	exec ()
bool	isAutoDelete () const
bool	isFinishedNotificationHidden () const
bool	isStartedWithExec () const
bool	isSuspended () const
unsigned long	percent () const
Q_SCRIPTABLE qulonglong	processedAmount (Unit unit) const
void	setAutoDelete (bool autodelete)
void	setFinishedNotificationHidden (bool hide=true)
void	setUiDelegate (KJobUiDelegate *delegate)
Q_SCRIPTABLE qulonglong	totalAmount (Unit unit) const
KJobUiDelegate *	uiDelegate () 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

Protected Slots
void	slotResult (KJob *) override
Protected Slots inherited from KCompositeJob
virtual void	slotInfoMessage (KJob *job, const QString &message)
virtual void	slotResult (KJob *job)

Additional Inherited Members
Public Types inherited from KJob
typedef QFlags< Capability >	Capabilities
enum	Capability
enum	Unit
Public Types inherited from QObject
typedef	QObjectList
Properties inherited from QObject
	objectName
Signals inherited from KJob
void	description (KJob *job, const QString &title, const QPair< QString, QString > &field1=QPair< QString, QString >(), const QPair< QString, QString > &field2=QPair< QString, QString >())
void	finished (KJob *job)
void	infoMessage (KJob *job, const QString &message)
void	percentChanged (KJob *job, unsigned long percent)
void	processedAmountChanged (KJob *job, KJob::Unit unit, qulonglong amount)
void	processedSize (KJob *job, qulonglong size)
void	result (KJob *job)
void	resumed (KJob *job)
void	speed (KJob *job, unsigned long speed)
void	suspended (KJob *job)
void	totalAmountChanged (KJob *job, KJob::Unit unit, qulonglong amount)
void	totalSize (KJob *job, qulonglong size)
void	warning (KJob *job, const QString &message)
Public Slots inherited from KJob
bool	kill (KJob::KillVerbosity verbosity=KJob::Quietly)
bool	resume ()
bool	suspend ()
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)
Public Attributes inherited from KJob
	Bytes
	Directories
	Files
	Items
	Killable
	NoCapabilities
	Suspendable
	UnitsCount
Protected Member Functions inherited from KCompositeJob
virtual bool	addSubjob (KJob *job)
void	clearSubjobs ()
bool	hasSubjobs () const
virtual bool	removeSubjob (KJob *job)
const QList< KJob * > &	subjobs () const
Protected Member Functions inherited from KJob
virtual bool	doKill ()
virtual bool	doResume ()
virtual bool	doSuspend ()
void	emitPercent (qulonglong processedAmount, qulonglong totalAmount)
void	emitResult ()
void	emitSpeed (unsigned long speed)
bool	isFinished () const
void	setCapabilities (Capabilities capabilities)
void	setError (int errorCode)
void	setErrorText (const QString &errorText)
void	setPercent (unsigned long percentage)
void	setProcessedAmount (Unit unit, qulonglong amount)
void	setProgressUnit (Unit unit)
void	setTotalAmount (Unit unit, qulonglong amount)
void	startElapsedTimer ()
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

Provides an interface for sending email.

This class takes a KMime::Message and some related info such as sender and recipient addresses, and places the message in the outbox. The mail dispatcher agent will then take it from there and send it.

This is the preferred way for applications to send email.

This job requires some options to be set before being started. Modify the attributes of this job to change these options.

You need to set the transport of the transport attribute, the from address of the address attribute and one of the to, cc or bcc addresses of the address attribute. Also, you need to call setMessage(). Optionally, you can change the dispatch mode attribute or the sent behaviour attribute.

Example:

MessageQueueJob *job = new MessageQueueJob( this );
job->setMessage( msg ); // msg is a Message::Ptr
job->transportAttribute().setTransportId( TransportManager::self()->defaultTransportId() );
// Use the default dispatch mode.
// Use the default sent-behaviour.
job->addressAttribute().setFrom( from ); // from is a QString
job->addressAttribute().setTo( to ); // to is a QStringList
connect( job, SIGNAL(result(KJob*)), this, SLOT(jobResult(KJob*)) );
job->start();

See also

DispatchModeAttribute

SentActionAttribute

SentBehaviourAttribute

TransportAttribute

AddressAttribute

Author

Constantin Berzan exit3.nosp@m.219@.nosp@m.gmail.nosp@m..com

Since

4.4

Definition at line 74 of file messagequeuejob.h.

Constructor & Destructor Documentation

MessageQueueJob()

MessageQueueJob::MessageQueueJob ( QObject * parent = nullptr )

explicit

Creates a new MessageQueueJob.

Parameters

parent

the QObject parent This is not an autostarting job; you need to call start() yourself.

Definition at line 127 of file messagequeuejob.cpp.

~MessageQueueJob()

MessageQueueJob::~MessageQueueJob ( )

overridedefault

Destroys the MessageQueueJob.

This job deletes itself after finishing.

Member Function Documentation

addressAttribute()

AddressAttribute & MessageQueueJob::addressAttribute

(

)

Returns a reference to the address attribute for this message.

Modify the returned attribute to change the receivers or the from address.

Definition at line 145 of file messagequeuejob.cpp.

dispatchModeAttribute()

DispatchModeAttribute & MessageQueueJob::dispatchModeAttribute

(

)

Returns a reference to the dispatch mode attribute for this message.

Modify the returned attribute to change the dispatch mode.

Definition at line 140 of file messagequeuejob.cpp.

message()

Message::Ptr MessageQueueJob::message ( ) const

nodiscard

Returns the message to be sent.

Definition at line 135 of file messagequeuejob.cpp.

sentActionAttribute()

SentActionAttribute & MessageQueueJob::sentActionAttribute

(

)

Returns a reference to the sent action attribute for this message.

Modify the returned attribute to change the sent actions.

Definition at line 160 of file messagequeuejob.cpp.

sentBehaviourAttribute()

SentBehaviourAttribute & MessageQueueJob::sentBehaviourAttribute

(

)

Returns a reference to the sent behaviour attribute for this message.

Modify the returned attribute to change the sent behaviour.

Definition at line 155 of file messagequeuejob.cpp.

setMessage()

void MessageQueueJob::setMessage

(

const KMime::Message::Ptr &

message

)

Sets the message to be sent.

Definition at line 165 of file messagequeuejob.cpp.

slotResult

void MessageQueueJob::slotResult ( KJob * job )

overrideprotectedslot

Called when the ItemCreateJob subjob finishes.

(reimplemented from KCompositeJob)

Definition at line 180 of file messagequeuejob.cpp.

start()

void MessageQueueJob::start ( )

overridevirtual

Creates the item and places it in the outbox.

It is now queued for sending by the mail dispatcher agent.

Implements KJob.

Definition at line 170 of file messagequeuejob.cpp.

transportAttribute()

TransportAttribute & MessageQueueJob::transportAttribute

(

)

Returns a reference to the transport attribute for this message.

Modify the returned attribute to change the transport used for sending the mail.

Definition at line 150 of file messagequeuejob.cpp.

---

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

• messagequeuejob.h
• messagequeuejob.cpp