MailTransport::ServerTest

MailTransport
ServerTest

#include <servertest.h>

Inheritance diagram for MailTransport::ServerTest:

Public Types
enum	Capability { Pipelining, Top, UIDL }

Properties
QProgressBar	progressBar

QString	protocol

QString	server

Properties inherited from QObject
	objectName

Signals
void	finished (const QVector< int > &)

Public Member Functions
	ServerTest (QObject *parent=nullptr)

	~ServerTest () override

QList< Capability >	capabilities () const

QString	fakeHostname () const

bool	isNormalPossible () const

bool	isSecurePossible () const

QVector< int >	normalProtocols () const

int	port (Transport::EnumEncryption encryptionMode) const

QProgressBar *	progressBar () const

QString	protocol () const

QVector< int >	secureProtocols () const

QString	server () const

void	setFakeHostname (const QString &fakeHostname)

void	setPort (Transport::EnumEncryption encryptionMode, uint port)

void	setProgressBar (QProgressBar *pb)

void	setProtocol (const QString &protocol)

void	setServer (const QString &server)

void	start ()

QVector< int >	tlsProtocols () const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

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

void	dumpObjectInfo () const const

void	dumpObjectTree ()

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 QRegExp &regExp, 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

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 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_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

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

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

QThread *	thread () const const

Additional Inherited Members
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)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Public Attributes inherited from QObject
typedef	QObjectList

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

This class can be used to test certain server to see if they support stuff.

Author: Tom Albers tomal[email protected]bers[email protected]@kde.[email protected]nl

Definition at line 29 of file servertest.h.

Member Enumeration Documentation

◆ Capability

enum MailTransport::ServerTest::Capability

This enumeration has the special capabilities a server might support.

This covers only capabilities not related to authentication.

Since: 4.1

Enumerator
Pipelining	POP3 only. The server supports pipeplining of commands.
Top	POP3 only. The server supports fetching only the headers.
UIDL	POP3 only. The server has support for unique identifiers.

Definition at line 42 of file servertest.h.

Constructor & Destructor Documentation

◆ ServerTest()

ServerTest::ServerTest ( QObject * parent = nullptr )

explicit

Creates a new server test.

Parameters

parent The parent widget.

Definition at line 527 of file servertest.cpp.

◆ ~ServerTest()

ServerTest::~ServerTest ( )

overridedefault

Destroys the server test.

Member Function Documentation

◆ capabilities()

QList< ServerTest::Capability > ServerTest::capabilities ( ) const

Get the special capabilities of the server.

Call this only after the finished() signals has been sent.

Returns: the list of special capabilities of the server.

Since: 4.1

Definition at line 697 of file servertest.cpp.

◆ fakeHostname()

QString ServerTest::fakeHostname ( ) const

Returns: the fake hostname, as set before with setFakeHostname

Definition at line 620 of file servertest.cpp.

◆ finished

void MailTransport::ServerTest::finished ( const QVector< int > & )

signal

This will be emitted when the test is done.

It will contain the values from the enum EnumEncryption which are possible.

◆ isNormalPossible()

bool ServerTest::isNormalPossible ( ) const

tells you if the normal server is available

Since: 4.5

Definition at line 677 of file servertest.cpp.

◆ isSecurePossible()

bool ServerTest::isSecurePossible ( ) const

tells you if the ssl server is available

Since: 4.5

Definition at line 692 of file servertest.cpp.

◆ normalProtocols()

QVector< int > ServerTest::normalProtocols ( ) const

Get the protocols for the normal connections.

. Call this only after the finished() signals has been sent.

Returns: an enum of the type Transport::EnumAuthenticationType

Definition at line 672 of file servertest.cpp.

◆ port()

int ServerTest::port ( Transport::EnumEncryption encryptionMode ) const

Parameters

encryptionMode the port of this encryption mode is returned. Can only be 'None' and 'SSL'

Returns: the port set by setPort or -1 if setPort() was never called for this encryption mode.

Since: 4.1

Definition at line 657 of file servertest.cpp.

◆ progressBar()

QProgressBar* MailTransport::ServerTest::progressBar ( ) const

Returns the used progress bar.

◆ protocol()

QString MailTransport::ServerTest::protocol ( ) const

Returns the protocol.

◆ secureProtocols()

QVector< int > ServerTest::secureProtocols ( ) const

Get the protocols for the SSL connections.

Call this only after the finished() signals has been sent.

Returns: an enum of the type Transport::EnumAuthenticationType

Definition at line 687 of file servertest.cpp.

◆ server()

QString MailTransport::ServerTest::server ( ) const

Returns the server to test.

◆ setFakeHostname()

void ServerTest::setFakeHostname ( const QString & fakeHostname )

Sets a fake hostname for the test.

This is currently only used when testing a SMTP server; there, the command for testing the capabilities (called EHLO) needs to have the hostname of the client included. The user can however choose to send a fake hostname instead of the local hostname to work around various problems. This fake hostname needs to be set here.

Parameters

fakeHostname the fake hostname to send

Definition at line 615 of file servertest.cpp.

◆ setPort()

void ServerTest::setPort	(	Transport::EnumEncryption	encryptionMode,
		uint	port
	)

Set a custom port to use.

Each encryption mode (no encryption or SSL) has a different port. TLS uses the same port as no encryption, because TLS is invoked during a normal session.

If this function is never called, the default port is used, which is: (normal first, then SSL) SMTP: 587 (falls back to 25), 465 POP: 110, 995 IMAP: 143, 993 NNTP: 119, 563

Parameters

encryptionMode	the port will only be used in this encryption mode. Valid values for this are only 'None' and 'SSL'.
port	the port to use

Since: 4.1

Definition at line 630 of file servertest.cpp.

◆ setProgressBar()

void ServerTest::setProgressBar ( QProgressBar * pb )

Makes pb the progressbar to use.

This class will call show() and hide() and will count down. It does not take ownership of the progressbar.

Definition at line 636 of file servertest.cpp.

◆ setProtocol()

void ServerTest::setProtocol ( const QString & protocol )

Sets protocol the protocol to test, currently supported are "smtp", "pop", "imap", and "nntp".

Definition at line 641 of file servertest.cpp.

◆ setServer()

void ServerTest::setServer ( const QString & server )

Sets the server to test.

Definition at line 625 of file servertest.cpp.

◆ start()

void ServerTest::start ( )

Starts the test.

Will emit finished() when done.

Definition at line 545 of file servertest.cpp.

◆ tlsProtocols()

QVector< int > ServerTest::tlsProtocols ( ) const

Get the protocols for the TLS connections.

Call this only after the finished() signals has been sent.

Returns: an enum of the type Transport::EnumAuthenticationType

Since: 4.1

Definition at line 682 of file servertest.cpp.

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About MailTransport

MailTransport::ServerTest

Public Types

Properties

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Capability

Constructor & Destructor Documentation

◆ ServerTest()

◆ ~ServerTest()

Member Function Documentation

◆ capabilities()

◆ fakeHostname()

◆ finished

◆ isNormalPossible()

◆ isSecurePossible()

◆ normalProtocols()

◆ port()

◆ progressBar()

◆ protocol()

◆ secureProtocols()

◆ server()

◆ setFakeHostname()

◆ setPort()

◆ setProgressBar()

◆ setProtocol()

◆ setServer()

◆ start()

◆ tlsProtocols()