QxtSmtp Class Reference

The QxtSmtp class implements the SMTP protocol for sending email. More...

#include <qxtsmtp.h>

Inheritance diagram for QxtSmtp:

Collaboration diagram for QxtSmtp:

Public Types
enum	SmtpError {   NoError , NoRecipients , CommandUnrecognized = 500 , SyntaxError ,   CommandNotImplemented , BadSequence , ParameterNotImplemented , MailboxUnavailable = 550 ,   UserNotLocal , MessageTooLarge , InvalidMailboxName , TransactionFailed }

Signals
void	connected ()
void	connectionFailed ()
void	connectionFailed (const QByteArray &msg)
void	encrypted ()
void	encryptionFailed ()
void	encryptionFailed (const QByteArray &msg)
void	authenticated ()
void	authenticationFailed ()
void	authenticationFailed (const QByteArray &msg)
void	senderRejected (int mailID, const QString &address)
void	senderRejected (int mailID, const QString &address, const QByteArray &msg)
void	recipientRejected (int mailID, const QString &address)
void	recipientRejected (int mailID, const QString &address, const QByteArray &msg)
void	mailFailed (int mailID, int errorCode)
void	mailFailed (int mailID, int errorCode, const QByteArray &msg)
void	mailSent (int mailID)
void	finished ()
void	disconnected ()

Public Member Functions
	QxtSmtp (QObject *parent=0)
QByteArray	username () const
void	setUsername (const QByteArray &name)
QByteArray	password () const
void	setPassword (const QByteArray &password)
int	send (const QxtMailMessage &message)
int	pendingMessages () const
void	clearPending ()
	Drops all queued (not yet transmitted) messages without sending them.
void	reset ()
	Clears the outgoing queue and resets the SMTP state machine.
QTcpSocket *	socket () const
void	connectToHost (const QString &hostName, quint16 port=25)
void	connectToHost (const QHostAddress &address, quint16 port=25)
void	disconnectFromHost ()
bool	startTlsDisabled () const
void	setStartTlsDisabled (bool disable)
QSslSocket *	sslSocket () const
void	connectToSecureHost (const QString &hostName, quint16 port=465)
void	connectToSecureHost (const QHostAddress &address, quint16 port=465)
bool	hasExtension (const QString &extension)
QString	extensionData (const QString &extension)

Detailed Description

The QxtSmtp class implements the SMTP protocol for sending email.

\inmodule QxtNetwork

Member Enumeration Documentation

SmtpError

enum QxtSmtp::SmtpError

Enumerator
NoError
NoRecipients
CommandUnrecognized
SyntaxError
CommandNotImplemented
BadSequence
ParameterNotImplemented
MailboxUnavailable
UserNotLocal
MessageTooLarge
InvalidMailboxName
TransactionFailed

Constructor & Destructor Documentation

QxtSmtp()

QxtSmtp::QxtSmtp

(

QObject *

parent = 0

)

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

authenticated

void QxtSmtp::authenticated ( )

signal

Here is the caller graph for this function:

authenticationFailed [1/2]

void QxtSmtp::authenticationFailed ( )

signal

Here is the caller graph for this function:

authenticationFailed [2/2]

void QxtSmtp::authenticationFailed ( const QByteArray & msg )

signal

clearPending()

void QxtSmtp::clearPending

(

)

Drops all queued (not yet transmitted) messages without sending them.

Any message still awaiting delivery is discarded. This is used by callers that keep their own authoritative queue and wish to rebuild the SMTP buffer from scratch (e.g. after a reconnect) without risking duplicates.

connected

void QxtSmtp::connected ( )

signal

Here is the caller graph for this function:

connectionFailed [1/2]

void QxtSmtp::connectionFailed ( )

signal

Here is the caller graph for this function:

connectionFailed [2/2]

void QxtSmtp::connectionFailed ( const QByteArray & msg )

signal

connectToHost() [1/2]

void QxtSmtp::connectToHost	(	const QHostAddress &	address,
		quint16	port = 25 )

Here is the call graph for this function:

connectToHost() [2/2]

void QxtSmtp::connectToHost	(	const QString &	hostName,
		quint16	port = 25 )

Here is the call graph for this function:

Here is the caller graph for this function:

connectToSecureHost() [1/2]

void QxtSmtp::connectToSecureHost	(	const QHostAddress &	address,
		quint16	port = 465 )

Here is the call graph for this function:

connectToSecureHost() [2/2]

void QxtSmtp::connectToSecureHost	(	const QString &	hostName,
		quint16	port = 465 )

Here is the call graph for this function:

Here is the caller graph for this function:

disconnected

void QxtSmtp::disconnected ( )

signal

Here is the call graph for this function:

Here is the caller graph for this function:

disconnectFromHost()

void QxtSmtp::disconnectFromHost

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

encrypted

void QxtSmtp::encrypted ( )

signal

Here is the caller graph for this function:

encryptionFailed [1/2]

void QxtSmtp::encryptionFailed ( )

signal

Here is the caller graph for this function:

encryptionFailed [2/2]

void QxtSmtp::encryptionFailed ( const QByteArray & msg )

signal

extensionData()

QString QxtSmtp::extensionData

(

const QString &

extension

)

finished

void QxtSmtp::finished ( )

signal

Here is the caller graph for this function:

hasExtension()

bool QxtSmtp::hasExtension

(

const QString &

extension

)

mailFailed [1/2]

void QxtSmtp::mailFailed ( int mailID, int errorCode )

signal

Here is the caller graph for this function:

mailFailed [2/2]

void QxtSmtp::mailFailed ( int mailID, int errorCode, const QByteArray & msg )

signal

mailSent

void QxtSmtp::mailSent ( int mailID )

signal

Here is the caller graph for this function:

password()

QByteArray QxtSmtp::password

(

)

const

Here is the caller graph for this function:

pendingMessages()

int QxtSmtp::pendingMessages

(

)

const

recipientRejected [1/2]

void QxtSmtp::recipientRejected ( int mailID, const QString & address )

signal

Here is the caller graph for this function:

recipientRejected [2/2]

void QxtSmtp::recipientRejected ( int mailID, const QString & address, const QByteArray & msg )

signal

reset()

void QxtSmtp::reset

(

)

Clears the outgoing queue and resets the SMTP state machine.

Unlike clearPending(), this also resets the internal state to Disconnected so that subsequent send() calls will not fire sendNext() prematurely on a not-yet-connected socket. Use this when rebuilding the queue from scratch before a fresh connectToHost() / connectToSecureHost() cycle.

Here is the caller graph for this function:

send()

int QxtSmtp::send

(

const QxtMailMessage &

message

)

Here is the caller graph for this function:

senderRejected [1/2]

void QxtSmtp::senderRejected ( int mailID, const QString & address )

signal

Here is the caller graph for this function:

senderRejected [2/2]

void QxtSmtp::senderRejected ( int mailID, const QString & address, const QByteArray & msg )

signal

setPassword()

void QxtSmtp::setPassword

(

const QByteArray &

password

)

Here is the call graph for this function:

Here is the caller graph for this function:

setStartTlsDisabled()

void QxtSmtp::setStartTlsDisabled

(

bool

disable

)

setUsername()

void QxtSmtp::setUsername

(

const QByteArray &

name

)

Here is the call graph for this function:

Here is the caller graph for this function:

socket()

QTcpSocket * QxtSmtp::socket

(

)

const

Here is the caller graph for this function:

sslSocket()

QSslSocket * QxtSmtp::sslSocket

(

)

const

Here is the caller graph for this function:

startTlsDisabled()

bool QxtSmtp::startTlsDisabled

(

)

const

username()

QByteArray QxtSmtp::username

(

)

const

Here is the caller graph for this function:

---

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

• servatrice/src/smtp/qxtsmtp.h
• servatrice/src/smtp/qxtsmtp.cpp