MailTransport::Transport

Search for usage in LXR

#include <transport.h>

Inherits TransportBase.

Public Types

using List = QList< Transport * >
 

Public Member Functions

 ~Transport () override
 
QString authenticationTypeString () const
 
Transportclone () const
 
void forceUniqueName ()
 
bool isComplete () const
 
bool isValid () const
 
QString password ()
 
void setPassword (const QString &passwd)
 
TransportType transportType () const
 
void updatePasswordState ()
 

Static Public Member Functions

static QString authenticationTypeString (int type)
 

Protected Member Functions

 Transport (const QString &cfgGroup)
 
void migrateToWallet ()
 
bool needsWalletMigration () const
 
void usrRead () override
 
bool usrSave () override
 

Detailed Description

Represents the settings of a specific mail transport.

To create a new empty Transport object, use TransportManager::createTransport().

Initialize an empty Transport object by calling the set...() methods defined in kcfg-generated TransportBase, and in this class.

Definition at line 30 of file transport.h.

Constructor & Destructor Documentation

Transport::~Transport ( )
override

Destructor.

Definition at line 37 of file transport.cpp.

Transport::Transport ( const QString cfgGroup)
protected

Creates a Transport object.

Should only be used by TransportManager.

Parameters
cfgGroupThe KConfig group to read its data from.

Definition at line 24 of file transport.cpp.

Member Function Documentation

QString Transport::authenticationTypeString ( ) const

Returns a string representation of the authentication type.

Definition at line 112 of file transport.cpp.

QString Transport::authenticationTypeString ( int  type)
static

Returns a string representation of the authentication type.

Convenience function when there isn't a Transport object instantiated.

Since
4.5

Definition at line 117 of file transport.cpp.

Transport * Transport::clone ( ) const

Returns a deep copy of this Transport object which will no longer be automatically updated.

Use this if you need to store a Transport object over a longer time. However it is recommended to store transport identifiers instead if possible.

See also
updatePasswordState()

Definition at line 283 of file transport.cpp.

void Transport::forceUniqueName ( )

Makes sure the transport has a unique name.

Adds #1, #2, #3 etc. if necessary.

Since
4.4

Definition at line 69 of file transport.cpp.

bool Transport::isComplete ( ) const

Returns true if all settings have been loaded.

This is the way to find out if the password has already been loaded from the wallet.

Definition at line 107 of file transport.cpp.

bool Transport::isValid ( ) const

Returns true if this transport is valid, ie.

has all necessary data set.

Definition at line 42 of file transport.cpp.

void Transport::migrateToWallet ( )
protected

Try to migrate the password from the config file to the wallet.

Definition at line 272 of file transport.cpp.

bool Transport::needsWalletMigration ( ) const
protected

Returns true if the password was not stored in the wallet.

Definition at line 267 of file transport.cpp.

QString Transport::password ( )

Returns the password of this transport.

Definition at line 54 of file transport.cpp.

void Transport::setPassword ( const QString passwd)

Sets the password of this transport.

Parameters
passwdThe new password.

Definition at line 59 of file transport.cpp.

TransportType Transport::transportType ( ) const

Returns the type of this transport.

See also
TransportType.
Since
4.4

Definition at line 289 of file transport.cpp.

void Transport::updatePasswordState ( )

This function synchronizes the password of this transport with the password of the transport with the same ID that is managed by the transport manager.

This is only useful for cloned transports, since their passwords don't automatically get updated when calling TransportManager::loadPasswordsAsync() or TransportManager::loadPasswords().

See also
clone()
Since
4.2

Definition at line 91 of file transport.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Mon Aug 2 2021 23:19:40 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.