MailTransport::ServerTest

MailTransport::ServerTest Class Reference

#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 ()
 
QList< Capabilitycapabilities () const
 
QString fakeHostname () const
 
bool isNormalPossible () const
 
bool isSecurePossible () const
 
QVector< int > normalProtocols () const
 
int port (Transport::EnumEncryption::type encryptionMode) const
 
QProgressBarprogressBar () const
 
QString protocol () const
 
QVector< int > secureProtocols () const
 
QString server () const
 
void setFakeHostname (const QString &fakeHostname)
 
void setPort (Transport::EnumEncryption::type 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 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
 

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 *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 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
 
QObjectsender () 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 27 of file servertest.h.

Member Enumeration Documentation

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 41 of file servertest.h.

Constructor & Destructor Documentation

ServerTest::ServerTest ( QObject parent = nullptr)

Creates a new server test.

Parameters
parentThe parent widget.

Definition at line 544 of file servertest.cpp.

ServerTest::~ServerTest ( )

Destroys the server test.

Definition at line 560 of file servertest.cpp.

Member Function Documentation

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 721 of file servertest.cpp.

QString ServerTest::fakeHostname ( ) const
Returns
the fake hostname, as set before with setFakeHostname

Definition at line 642 of file servertest.cpp.

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.

bool ServerTest::isNormalPossible ( ) const

tells you if the normal server is available

Since
4.5

Definition at line 701 of file servertest.cpp.

bool ServerTest::isSecurePossible ( ) const

tells you if the ssl server is available

Since
4.5

Definition at line 716 of file servertest.cpp.

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 696 of file servertest.cpp.

int ServerTest::port ( Transport::EnumEncryption::type  encryptionMode) const
Parameters
encryptionModethe 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 680 of file servertest.cpp.

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

Returns the used progress bar.

QString MailTransport::ServerTest::protocol ( ) const

Returns the protocol.

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 711 of file servertest.cpp.

QString MailTransport::ServerTest::server ( ) const

Returns the server to test.

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
fakeHostnamethe fake hostname to send

Definition at line 637 of file servertest.cpp.

void ServerTest::setPort ( Transport::EnumEncryption::type  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
encryptionModethe port will only be used in this encryption mode. Valid values for this are only 'None' and 'SSL'.
portthe port to use
Since
4.1

Definition at line 652 of file servertest.cpp.

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 659 of file servertest.cpp.

void ServerTest::setProtocol ( const QString protocol)

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

Definition at line 664 of file servertest.cpp.

void ServerTest::setServer ( const QString server)

Sets the server to test.

Definition at line 647 of file servertest.cpp.

void ServerTest::start ( )

Starts the test.

Will emit finished() when done.

Definition at line 565 of file servertest.cpp.

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 706 of file servertest.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 Wed Jul 8 2020 23:16:52 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.