MailTransport::ServerTest

Search for usage in LXR

MailTransport::ServerTest Class Reference

#include <servertest.h>

Inheritance diagram for MailTransport::ServerTest:

Public Types

enum  Capability { Pipelining , Top , UIDL }
 
- Public Types inherited from QObject
typedef  QObjectList
 

Properties

QProgressBarprogressBar
 
QString protocol
 
QString server
 
- Properties inherited from QObject
 objectName
 

Signals

void finished (const QList< int > &)
 

Public Member Functions

 ServerTest (QObject *parent=nullptr)
 
 ~ServerTest () override
 
QList< Capabilitycapabilities () const
 
QString fakeHostname () const
 
bool isNormalPossible () const
 
bool isSecurePossible () const
 
QList< int > normalProtocols () const
 
int port (Transport::EnumEncryption encryptionMode) const
 
QProgressBarprogressBar () const
 
QString protocol () const
 
QList< 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 ()
 
QList< int > tlsProtocols () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
QBindable< QStringbindableObjectName ()
 
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 () const const
 
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 QRegularExpression &re, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isQuickItemType () const const
 
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_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_GADGET_EXPORT (EXPORT_MACRO)
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_MOC_INCLUDE Q_MOC_INCLUDE
 
 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
 
qobject_cast (const QObject *object)
 
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 setObjectName (QAnyStringView name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool setProperty (const char *name, QVariant &&value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds interval, 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 *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)
 
- 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.nosp@m.bers.nosp@m.@kde..nosp@m.nl

Definition at line 29 of file servertest.h.

Member Enumeration Documentation

◆ 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.

Property Documentation

◆ progressBar

QProgressBar * MailTransport::ServerTest::progressBar
readwrite

Definition at line 34 of file servertest.h.

◆ protocol

QString MailTransport::ServerTest::protocol
readwrite

Definition at line 33 of file servertest.h.

◆ server

QString MailTransport::ServerTest::server
readwrite

Definition at line 32 of file servertest.h.

Constructor & Destructor Documentation

◆ ServerTest()

ServerTest::ServerTest ( QObject * parent = nullptr)
explicit

Creates a new server test.

Parameters
parentThe parent widget.

Definition at line 517 of file servertest.cpp.

◆ ~ServerTest()

ServerTest::~ServerTest ( )
overridedefault

Destroys the server test.

Member Function Documentation

◆ capabilities()

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

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

◆ fakeHostname()

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

Definition at line 611 of file servertest.cpp.

◆ finished

void MailTransport::ServerTest::finished ( const QList< 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
nodiscard

tells you if the normal server is available

Since
4.5

Definition at line 668 of file servertest.cpp.

◆ isSecurePossible()

bool ServerTest::isSecurePossible ( ) const
nodiscard

tells you if the ssl server is available

Since
4.5

Definition at line 683 of file servertest.cpp.

◆ normalProtocols()

QList< int > ServerTest::normalProtocols ( ) const
nodiscard

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

◆ port()

int ServerTest::port ( Transport::EnumEncryption encryptionMode) const
nodiscard
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 648 of file servertest.cpp.

◆ progressBar()

QProgressBar * ServerTest::progressBar ( ) const

Returns the used progress bar.

Definition at line 658 of file servertest.cpp.

◆ protocol()

QString ServerTest::protocol ( ) const
nodiscard

Returns the protocol.

Definition at line 638 of file servertest.cpp.

◆ secureProtocols()

QList< int > ServerTest::secureProtocols ( ) const
nodiscard

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

◆ server()

QString ServerTest::server ( ) const
nodiscard

Returns the server to test.

Definition at line 643 of file servertest.cpp.

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

Definition at line 606 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
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 621 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 627 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 632 of file servertest.cpp.

◆ setServer()

void ServerTest::setServer ( const QString & server)

Sets the server to test.

Definition at line 616 of file servertest.cpp.

◆ start()

void ServerTest::start ( )

Starts the test.

Will emit finished() when done.

Definition at line 535 of file servertest.cpp.

◆ tlsProtocols()

QList< int > ServerTest::tlsProtocols ( ) const
nodiscard

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 673 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-2024 The KDE developers.
Generated on Fri Nov 22 2024 12:07:33 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.