MailTransport::TransportJob Class Reference

Abstract base class for all mail transport jobs. More...

#include <transportjob.h>

Inheritance diagram for MailTransport::TransportJob:

[legend]

List of all members.

Public Member Functions
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)
virtual void	start ()
Transport *	transport () const
virtual	~TransportJob ()
Protected Member Functions
QStringList	bcc () const
QBuffer *	buffer ()
QStringList	cc () const
QByteArray	data () const
virtual void	doStart ()=0
QString	sender () const
QStringList	to () const
	TransportJob (Transport *transport, QObject *parent=0)

---

Detailed Description

Abstract base class for all mail transport jobs.

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

Definition at line 37 of file transportjob.h.

---

Constructor & Destructor Documentation

TransportJob::~TransportJob

(

)

[virtual]

Deletes this transport job.

Definition at line 48 of file transportjob.cpp.

TransportJob::TransportJob	(	Transport *	transport,
		QObject *	parent = 0
	)			[explicit, protected]

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

---

Member Function Documentation

QStringList TransportJob::bcc

(

)

const [protected]

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

Definition at line 99 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 109 of file transportjob.cpp.

QStringList TransportJob::cc

(

)

const [protected]

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

Definition at line 94 of file transportjob.cpp.

QByteArray TransportJob::data

(

)

const [protected]

Returns the data of the mail.

Definition at line 104 of file transportjob.cpp.

virtual void MailTransport::TransportJob::doStart

(

)

[protected, pure virtual]

Do the actual work, implement in your subclass.

Implemented in MailTransport::SendmailJob, and MailTransport::SmtpJob.

QString TransportJob::sender

(

)

const [protected]

Returns the sender of the mail.

Definition at line 84 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 69 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 64 of file transportjob.cpp.

void TransportJob::setData

(

const QByteArray &

data

)

Sets the content of the mail.

Definition at line 74 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 54 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 59 of file transportjob.cpp.

void TransportJob::start

(

)

[virtual]

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()

Definition at line 120 of file transportjob.cpp.

QStringList TransportJob::to

(

)

const [protected]

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

Definition at line 89 of file transportjob.cpp.

Transport * TransportJob::transport

(

)

const

Returns the Transport object containing the mail transport settings.

Definition at line 79 of file transportjob.cpp.

---

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

• transportjob.h
• transportjob.cpp