MailTransport::TransportJob Class Reference

#include <transportjob.h>

Inheritance diagram for MailTransport::TransportJob:

Public Member Functions
	~TransportJob () override
void	setBcc (const QStringList &bcc)
void	setCc (const QStringList &cc)
void	setData (const QByteArray &data)
void	setDeliveryStatusNotification (bool enabled)
void	setSender (const QString &sender)
void	setTo (const QStringList &to)
void	start () override
Transport *	transport () const
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 Member Functions
	TransportJob (Transport *transport, QObject *parent=nullptr)
QStringList	bcc () const
QBuffer *	buffer ()
QStringList	cc () const
QByteArray	data () const
bool	deliveryStatusNotification () const
virtual void	doStart ()=0
QString	sender () const
QStringList	to () const
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)

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 Slots inherited from KCompositeJob
virtual void	slotInfoMessage (KJob *job, const QString &message)
virtual void	slotResult (KJob *job)

Detailed Description

Abstract base class for all mail transport jobs.

This is a job that is supposed to send exactly one mail.

Deprecated

Use MessageQueueJob for sending e-mail.

Definition at line 30 of file transportjob.h.

Constructor & Destructor Documentation

~TransportJob()

TransportJob::~TransportJob ( )

override

Deletes this transport job.

Definition at line 37 of file transportjob.cpp.

TransportJob()

TransportJob::TransportJob ( Transport * transport, QObject * parent = nullptr )

explicitprotected

Creates a new mail transport job.

Parameters

transport	The transport configuration. This must be a deep copy of a Transport object, the job takes the ownership of this object.
parent	The parent object.

See also

TransportManager::createTransportJob()

Definition at line 29 of file transportjob.cpp.

Member Function Documentation

bcc()

QStringList TransportJob::bcc ( ) const

nodiscardprotected

Returns the "Bcc" receiver(s) of the mail.

Definition at line 92 of file transportjob.cpp.

buffer()

QBuffer * TransportJob::buffer ( )

protected

Returns a QBuffer opened on the message data.

This is useful for processing the data in smaller chunks.

Definition at line 102 of file transportjob.cpp.

cc()

QStringList TransportJob::cc ( ) const

nodiscardprotected

Returns the "Cc" receiver(s) of the mail.

Definition at line 87 of file transportjob.cpp.

data()

QByteArray TransportJob::data ( ) const

nodiscardprotected

Returns the data of the mail.

Definition at line 97 of file transportjob.cpp.

deliveryStatusNotification()

bool TransportJob::deliveryStatusNotification ( ) const

nodiscardprotected

Returns true if DSN is enabled.

Definition at line 113 of file transportjob.cpp.

doStart()

virtual void MailTransport::TransportJob::doStart ( )

protectedpure virtual

Do the actual work, implement in your subclass.

Implemented in MailTransport::SmtpJob.

sender()

QString TransportJob::sender ( ) const

nodiscardprotected

Returns the sender of the mail.

Definition at line 77 of file transportjob.cpp.

setBcc()

void TransportJob::setBcc

(

const QStringList &

bcc

)

Sets the "Bcc" receiver(s) of the mail.

bcc must be the plain email address(es), not including display name.

Definition at line 57 of file transportjob.cpp.

setCc()

void TransportJob::setCc

(

const QStringList &

cc

)

Sets the "Cc" receiver(s) of the mail.

cc must be the plain email address(es), not including display name.

Definition at line 52 of file transportjob.cpp.

setData()

void TransportJob::setData

(

const QByteArray &

data

)

Sets the content of the mail.

Definition at line 62 of file transportjob.cpp.

setDeliveryStatusNotification()

void TransportJob::setDeliveryStatusNotification

(

bool

enabled

)

Sets the content of the mail.

Definition at line 72 of file transportjob.cpp.

setSender()

void TransportJob::setSender

(

const QString &

sender

)

Sets the sender of the mail.

sender must be the plain email address, not including display name.

Definition at line 42 of file transportjob.cpp.

setTo()

void TransportJob::setTo

(

const QStringList &

to

)

Sets the "To" receiver(s) of the mail.

to must be the plain email address(es), not including display name.

Definition at line 47 of file transportjob.cpp.

start()

void TransportJob::start ( )

overridevirtual

Starts this job.

It is recommended to not call this method directly but use TransportManager::schedule() to execute the job instead.

See also

TransportManager::schedule()

Implements KJob.

Definition at line 118 of file transportjob.cpp.

to()

QStringList TransportJob::to ( ) const

nodiscardprotected

Returns the "To" receiver(s) of the mail.

Definition at line 82 of file transportjob.cpp.

transport()

Transport * TransportJob::transport

(

)

const

Returns the Transport object containing the mail transport settings.

Definition at line 67 of file transportjob.cpp.

---

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

• transportjob.h
• transportjob.cpp