MailTransport::TransportJob

MailTransport::TransportJob Class Referenceabstract

#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 setSender (const QString &sender)
 
void setTo (const QStringList &to)
 
void start () override
 
Transporttransport () const
 
- Public Member Functions inherited from KCompositeJob
 KCompositeJob (QObject *parent=nullptr)
 
- Public Member Functions inherited from KJob
 KJob (QObject *parent=nullptr)
 
Capabilities capabilities () const
 
int error () const
 
virtual QString errorString () const
 
QString errorText () const
 
bool exec ()
 
bool isAutoDelete () const
 
bool isSuspended () const
 
unsigned long percent () const
 
Q_SCRIPTABLE qulonglong processedAmount (Unit unit) const
 
void setAutoDelete (bool autodelete)
 
void setUiDelegate (KJobUiDelegate *delegate)
 
Q_SCRIPTABLE qulonglong totalAmount (Unit unit) const
 
KJobUiDelegateuiDelegate () 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
 

Protected Member Functions

 TransportJob (Transport *transport, QObject *parent=nullptr)
 
QStringList bcc () const
 
QBufferbuffer ()
 
QStringList cc () const
 
QByteArray data () 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)
 
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 setTotalAmount (Unit unit, qulonglong amount)
 
- 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)
 

Additional Inherited Members

- Public Types inherited from KJob
typedef QFlags< CapabilityCapabilities
 
enum  Capability
 
enum  Unit
 
- 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 &plain, const QString &rich=QString())
 
void percent (KJob *job, unsigned long percent)
 
void processedAmount (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 totalAmount (KJob *job, KJob::Unit unit, qulonglong amount)
 
void totalSize (KJob *job, qulonglong size)
 
void warning (KJob *job, const QString &plain, const QString &rich=QString())
 
- Public Slots inherited from KJob
bool kill (KillVerbosity verbosity=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 *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)
 
- Public Attributes inherited from KJob
 Bytes
 
 Directories
 
 Files
 
 Items
 
 Killable
 
 NoCapabilities
 
 Suspendable
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Slots inherited from KCompositeJob
virtual void slotInfoMessage (KJob *job, const QString &plain, const QString &rich)
 
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 27 of file transportjob.h.

Constructor & Destructor Documentation

TransportJob::~TransportJob ( )
override

Deletes this transport job.

Definition at line 42 of file transportjob.cpp.

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

Creates a new mail transport job.

Parameters
transportThe transport configuration. This must be a deep copy of a Transport object, the job takes the ownership of this object.
parentThe parent object.
See also
TransportManager::createTransportJob()

Definition at line 34 of file transportjob.cpp.

Member Function Documentation

QStringList TransportJob::bcc ( ) const
protected

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

Definition at line 93 of file transportjob.cpp.

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 103 of file transportjob.cpp.

QStringList TransportJob::cc ( ) const
protected

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

Definition at line 88 of file transportjob.cpp.

QByteArray TransportJob::data ( ) const
protected

Returns the data of the mail.

Definition at line 98 of file transportjob.cpp.

virtual void MailTransport::TransportJob::doStart ( )
protectedpure virtual

Do the actual work, implement in your subclass.

Implemented in MailTransport::SmtpJob.

QString TransportJob::sender ( ) const
protected

Returns the sender of the mail.

Definition at line 78 of file transportjob.cpp.

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 63 of file transportjob.cpp.

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 58 of file transportjob.cpp.

void TransportJob::setData ( const QByteArray data)

Sets the content of the mail.

Definition at line 68 of file transportjob.cpp.

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 48 of file transportjob.cpp.

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 53 of file transportjob.cpp.

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 114 of file transportjob.cpp.

QStringList TransportJob::to ( ) const
protected

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

Definition at line 83 of file transportjob.cpp.

Transport * TransportJob::transport ( ) const

Returns the Transport object containing the mail transport settings.

Definition at line 73 of file transportjob.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 Sat Jul 11 2020 23:17:57 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.