• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • Sitemap
  • Contact Us
 

mailtransport

MailTransport::Transport

MailTransport::Transport Class Reference

Represents the settings of a specific mail transport. More...

#include <transport.h>

Inherits TransportBase.

List of all members.


Public Types

typedef QList< Transport * > List

Public Member Functions

QString authenticationTypeString () const
Transport * clone () const
bool isComplete () const
bool isValid () const
QString password ()
void setPassword (const QString &passwd)
void updatePasswordState ()
virtual ~Transport ()

Protected Member Functions

void migrateToWallet ()
bool needsWalletMigration () const
 Transport (const QString &cfgGroup)
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().

Definition at line 35 of file transport.h.


Constructor & Destructor Documentation

Transport::~Transport (  )  [virtual]

Destructor.

Definition at line 61 of file transport.cpp.

Transport::Transport ( const QString &  cfgGroup  )  [protected]

Creates a Transport object.

Should only be used by TransportManager.

Parameters:
cfgGroup The KConfig group to read its data from.

Definition at line 50 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.

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 262 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 66 of file transport.cpp.

void Transport::migrateToWallet (  )  [protected]

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

Definition at line 251 of file transport.cpp.

bool Transport::needsWalletMigration (  )  const [protected]

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

Definition at line 246 of file transport.cpp.

QString Transport::password (  ) 

Returns the password of this transport.

Definition at line 71 of file transport.cpp.

void Transport::setPassword ( const QString &  passwd  ) 

Sets the password of this transport.

Parameters:
passwd The new password.

Definition at line 81 of file transport.cpp.

void Transport::updatePasswordState (  ) 

This function syncronizes 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:
  • transport.h
  • transport.cpp

mailtransport

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

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  • kabc
  • kblog
  • kcal
  • kimap
  • kioslave
  •   imap4
  •   mbox
  • kldap
  • kmime
  • kpimidentities
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.5.8
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