• Skip to content
  • Skip to link menu
KDE 4.6 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • KDE Home
  • Contact Us
 

mailtransport

  • MailTransport
  • ServerTest
Public Types | Signals | Public Member Functions | Properties

MailTransport::ServerTest Class Reference

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

#include <servertest.h>

Inherits QWidget.

List of all members.

Public Types

enum  Capability { Pipelining, Top, UIDL }

Signals

void finished (QList< int >)

Public Member Functions

 ServerTest (QWidget *parent=0)
 ~ServerTest ()
QList< Capability > capabilities () const
QString fakeHostname ()
bool isNormalPossible ()
bool isSecurePossible ()
QList< int > normalProtocols ()
int port (Transport::EnumEncryption::type encryptionMode)
QProgressBar * progressBar ()
QString protocol ()
QList< int > secureProtocols ()
QString server ()
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 ()
QList< int > tlsProtocols ()

Properties

QProgressBar progressBar
QString protocol
QString server

Detailed Description

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

Author:
Tom Albers <tomalbers@kde.nl>

Definition at line 42 of file servertest.h.


Member Enumeration Documentation

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


Constructor & Destructor Documentation

ServerTest::ServerTest ( QWidget *  parent = 0)

Creates a new server test.

Parameters:
parentThe parent widget.

Definition at line 450 of file servertest.cpp.

ServerTest::~ServerTest ( )

Destroys the server test.

Definition at line 465 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 618 of file servertest.cpp.

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

Definition at line 540 of file servertest.cpp.

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

tells you if the normal server is available

Since:
4.5

Definition at line 598 of file servertest.cpp.

bool ServerTest::isSecurePossible ( )

tells you if the ssl server is available

Since:
4.5

Definition at line 613 of file servertest.cpp.

QList< int > ServerTest::normalProtocols ( )

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

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

QProgressBar* MailTransport::ServerTest::progressBar ( )

Returns the used progress bar.

QString MailTransport::ServerTest::protocol ( )

Returns the protocol.

QList< int > ServerTest::secureProtocols ( )

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

QString MailTransport::ServerTest::server ( )

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 535 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: 25, 465 POP: 110, 995 IMAP: 143, 993

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

void ServerTest::setProtocol ( const QString &  protocol)

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

Definition at line 562 of file servertest.cpp.

void ServerTest::setServer ( const QString &  server)

Sets the server to test.

Definition at line 545 of file servertest.cpp.

void ServerTest::start ( )

Starts the test.

Will emit finished() when done.

Definition at line 470 of file servertest.cpp.

QList< int > ServerTest::tlsProtocols ( )

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


The documentation for this class was generated from the following files:
  • servertest.h
  • servertest.cpp

mailtransport

Skip menu "mailtransport"
  • Main Page
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Class Members
  • Related Pages

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.7.3
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal