• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.10.4 API Reference
  • KDE Home
  • Contact Us
 

mailtransport

  • MailTransport
  • Transport
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
MailTransport::Transport Class Reference

#include <transport.h>

Inherits TransportBase.

List of all members.

Public Types

typedef QList< Transport * > List

Public Member Functions

virtual ~Transport ()
QString authenticationTypeString () const
Transport * clone () const
void forceUniqueName ()
bool isComplete () const
bool isValid () const
QString password ()
void setPassword (const QString &passwd)
void setTransportType (const TransportType &type)
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
virtual void usrReadConfig ()
virtual void usrWriteConfig ()

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. Note that some transports use the "host" setting to store the following values:

  • Sendmail transport: path to the sendmail executable
  • Akonadi transports: resource ID.

Definition at line 50 of file transport.h.


Constructor & Destructor Documentation

Transport::~Transport ( )
virtual

Destructor.

Definition at line 54 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 42 of file transport.cpp.


Member Function Documentation

QString Transport::authenticationTypeString ( ) const

Returns a string representation of the authentication type.

Definition at line 122 of file transport.cpp.

QString Transport::authenticationTypeString ( int  type)
static

Returns a string representation of the authentication type.

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

Since:
4.5

Definition at line 127 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 335 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 83 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 117 of file transport.cpp.

bool Transport::isValid ( ) const

Returns true if this transport is valid, ie.

has all necessary data set.

Definition at line 59 of file transport.cpp.

void Transport::migrateToWallet ( )
protected

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

Definition at line 322 of file transport.cpp.

bool Transport::needsWalletMigration ( ) const
protected

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

Definition at line 317 of file transport.cpp.

QString Transport::password ( )

Returns the password of this transport.

Definition at line 64 of file transport.cpp.

void Transport::setPassword ( const QString &  passwd)

Sets the password of this transport.

Parameters:
passwdThe new password.

Definition at line 73 of file transport.cpp.

void Transport::setTransportType ( const TransportType &  type)

Sets the type of this transport.

See also:
TransportType.
Since:
4.4

Definition at line 349 of file transport.cpp.

TransportType Transport::transportType ( ) const

Returns the type of this transport.

See also:
TransportType.
Since:
4.4

Definition at line 341 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 101 of file transport.cpp.


The documentation for this class was generated from the following files:
  • transport.h
  • transport.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Mon Jun 24 2013 20:30:32 by doxygen 1.8.1.1 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

mailtransport

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

kdepimlibs-4.10.4 API Reference

Skip menu "kdepimlibs-4.10.4 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal