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

mailtransport

MailTransport::Transport

MailTransport::Transport Class Reference

#include <transport.h>

Inherits TransportBase.

List of all members.


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.


Public Types

typedef QList< Transport * > List

Public Member Functions

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

Protected Member Functions

 Transport (const QString &cfgGroup)
virtual void usrReadConfig ()
virtual void usrWriteConfig ()
bool needsWalletMigration () const
void migrateToWallet ()

Friends

class TransportManager

Constructor & Destructor Documentation

Transport::~Transport (  ) 

Destructor.

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


Member Function Documentation

bool Transport::isValid (  )  const

Returns true if this transport is valid, ie.

has all necessary data set.

Definition at line 65 of file transport.cpp.

QString Transport::password (  ) 

Returns the password of this transport.

Definition at line 70 of file transport.cpp.

void Transport::setPassword ( const QString &  passwd  ) 

Sets the password of this transport.

Parameters:
passwd The new password.

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

QString Transport::authenticationTypeString (  )  const

Returns a string representation of the authentication type.

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

Definition at line 228 of file transport.cpp.

bool Transport::needsWalletMigration (  )  const [protected]

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

Definition at line 212 of file transport.cpp.

void Transport::migrateToWallet (  )  [protected]

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

Definition at line 217 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"
  • kabc
  • kblog
  • kcal
  • kimap
  • kioslave
  •   imap4
  •   mbox
  • kldap
  • kmime
  • kpimidentities
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.5.5
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