MailTransport::TransportType Class

class MailTransport::TransportType

A representation of a transport type. More...

Header: #include <MailTransport/TransportType>
CMake: find_package(KPim6MailTransport REQUIRED)
target_link_libraries(mytarget PRIVATE KPim6::MailTransport)

Public Types

Properties

Public Functions

TransportType()
TransportType(const MailTransport::TransportType &other)
TransportType(MailTransport::TransportType &&other)
~TransportType()
QString description() const
QString identifier() const
bool isAkonadiResource() const
bool isValid() const
QString name() const
MailTransport::TransportType &operator=(MailTransport::TransportType &&other)
MailTransport::TransportType &operator=(const MailTransport::TransportType &other)
bool operator==(const MailTransport::TransportType &other) const

Detailed Description

Represents an available transport type. SMTP is available

All available transport types can be retrieved via TransportManager::types().

Author: Constantin Berzan <exit3219@gmail.com>

Member Type Documentation

[alias] TransportType::List

Describes a list of transport types.

Property Documentation

[read-only] description : const QString

This property holds the description of the transport type.

Access functions:

QString description() const

[read-only] identifier : const QString

This property holds the plugin identifier.

Access functions:

QString identifier() const

[read-only] isAkonadiResource : const bool

This property holds whether this transport is an akonadi resource.

Access functions:

bool isAkonadiResource() const

[read-only] isValid : const bool

This property holds whether the transport type is valid.

Access functions:

bool isValid() const

[read-only] name : const QString

This property holds the i18n'ed name of the transport type.

Access functions:

QString name() const

Member Function Documentation

TransportType::TransportType()

Constructs a new TransportType.

TransportType::TransportType(const MailTransport::TransportType &other)

Creates a copy of the other TransportType.

[noexcept] TransportType::TransportType(MailTransport::TransportType &&other)

Moves the other TransportType into this one.

[noexcept] TransportType::~TransportType()

Destroys the TransportType.

QString TransportType::description() const

Returns a description of the transport type.

Note: Getter function for property description.

QString TransportType::identifier() const

Returns a plugin identifier

Note: Getter function for property identifier.

bool TransportType::isValid() const

Returns whether the transport type is valid.

Note: Getter function for property isValid.

QString TransportType::name() const

Returns the i18n'ed name of the transport type.

Note: Getter function for property name.

[noexcept] MailTransport::TransportType &TransportType::operator=(MailTransport::TransportType &&other)

Moves the other transport type into this one.

MailTransport::TransportType &TransportType::operator=(const MailTransport::TransportType &other)

Replaces the transport type by the other.

bool TransportType::operator==(const MailTransport::TransportType &other) const

Returns true if the transport type is equal to other.