MailTransport::TransportAbstractPlugin Class

class MailTransport::TransportAbstractPlugin

The TransportAbstractPlugin class. More...

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

Public Functions

TransportAbstractPlugin(QObject *parent = nullptr)
virtual ~TransportAbstractPlugin() override
virtual void cleanUp(MailTransport::Transport *t)
virtual bool configureTransport(const QString &identifier, MailTransport::Transport *transport, QWidget *parent) = 0
virtual MailTransport::TransportJob *createTransportJob(MailTransport::Transport *t, const QString &identifier) = 0
virtual void initializeTransport(MailTransport::Transport *t, const QString &identifier)
virtual QList<MailTransport::TransportAbstractPluginInfo> names() const = 0

Signals

Detailed Description

Author: Laurent Montel <montel@kde.org>

Member Function Documentation

[explicit] TransportAbstractPlugin::TransportAbstractPlugin(QObject *parent = nullptr)

Creates a new TransportAbstractPlugin with the specified parent object.

[override virtual noexcept] TransportAbstractPlugin::~TransportAbstractPlugin()

Destroys the plugin.

[virtual] void TransportAbstractPlugin::cleanUp(MailTransport::Transport *t)

Cleans up the resources of the transport t.

[pure virtual] bool TransportAbstractPlugin::configureTransport(const QString &identifier, MailTransport::Transport *transport, QWidget *parent)

Configures the transport with the given identifier, using parent as parent widget. Returns true if the transport was configured.

[pure virtual] MailTransport::TransportJob *TransportAbstractPlugin::createTransportJob(MailTransport::Transport *t, const QString &identifier)

Creates a transport job for the given transport t and identifier.

[virtual] void TransportAbstractPlugin::initializeTransport(MailTransport::Transport *t, const QString &identifier)

Initializes the transport t with the given identifier.

[pure virtual] QList<MailTransport::TransportAbstractPluginInfo> TransportAbstractPlugin::names() const

Returns the list of transport names provided by this plugin.

[signal] void TransportAbstractPlugin::updatePluginList()

Emitted when the plugin list should be updated.