• Skip to content
  • Skip to link menu
KDE 4.1 API Reference
  • KDE API Reference
  • kdepim
  • Sitemap
  • Contact Us
 

kmail

KMail::NetworkAccount

KMail::NetworkAccount Class Reference

#include <networkaccount.h>

Inheritance diagram for KMail::NetworkAccount:

Inheritance graph
[legend]

List of all members.


Detailed Description

Definition at line 45 of file networkaccount.h.


Public Member Functions

QString auth () const
virtual void clearPasswd ()
virtual KUrl getUrl () const
QString host () const
virtual void init ()
virtual void killAllJobs (bool disconnectSlave=false)=0
QString login () const
virtual bool mailCheckCanProceed () const
QString passwd () const
unsigned short int port () const
virtual void pseudoAssign (const KMAccount *a)
virtual void readConfig (KConfigGroup &config)
void readPassword ()
virtual void setAuth (const QString &auth)
virtual void setCheckingMail (bool checking)
virtual void setHost (const QString &host)
virtual void setLogin (const QString &login)
virtual void setPasswd (const QString &passwd, bool storeInConfig=false)
virtual void setPort (unsigned short int port)
virtual void setSieveConfig (const KMail::SieveConfig &config)
virtual void setStorePasswd (bool store)
virtual void setUseSSL (bool use)
virtual void setUseTLS (bool use)
KMail::SieveConfig sieveConfig () const
KIO::Slave * slave () const
virtual KIO::MetaData slaveConfig () const
bool storePasswd () const
bool useSSL () const
bool useTLS () const
virtual void writeConfig (KConfigGroup &config)
virtual ~NetworkAccount ()

Static Public Member Functions

static void resetConnectionList (NetworkAccount *acct)

Protected Member Functions

virtual unsigned short int defaultPort () const =0
 NetworkAccount (AccountManager *parent, const QString &name, uint id)
virtual QString protocol () const =0

Protected Attributes

bool mAskAgain: 1
QString mAuth
QString mHost
QString mLogin
QString mOldPassKey
QString mPasswd
bool mPasswdDirty: 1
unsigned short int mPort
KMail::SieveConfig mSieveConfig
QPointer< KIO::Slave > mSlave
bool mStorePasswd: 1
bool mStorePasswdInConfig: 1
bool mUseSSL: 1
bool mUseTLS: 1

Constructor & Destructor Documentation

KMail::NetworkAccount::NetworkAccount ( AccountManager *  parent,
const QString &  name,
uint  id 
) [protected]

Definition at line 51 of file networkaccount.cpp.

KMail::NetworkAccount::~NetworkAccount (  )  [virtual]

Definition at line 65 of file networkaccount.cpp.


Member Function Documentation

QString KMail::NetworkAccount::auth (  )  const [inline]

authentication method

Definition at line 72 of file networkaccount.h.

void KMail::NetworkAccount::clearPasswd (  )  [virtual]

Set the password to "" (empty string).

Reimplemented from KMAccount.

Definition at line 107 of file networkaccount.cpp.

virtual unsigned short int KMail::NetworkAccount::defaultPort (  )  const [protected, pure virtual]

Implemented in KMail::ImapAccountBase, and KMail::PopAccount.

KUrl KMail::NetworkAccount::getUrl (  )  const [virtual]

Returns:
an URL for this account

Definition at line 288 of file networkaccount.cpp.

QString KMail::NetworkAccount::host (  )  const [inline]

Server hostname.

Definition at line 80 of file networkaccount.h.

void KMail::NetworkAccount::init ( void   )  [virtual]

Set the config options to a decent state.

Reimplemented from KMAccount.

Reimplemented in KMail::ImapAccountBase, KMAcctCachedImap, and KMail::PopAccount.

Definition at line 69 of file networkaccount.cpp.

virtual void KMail::NetworkAccount::killAllJobs ( bool  disconnectSlave = false  )  [pure virtual]

Kill all jobs that are currently in progress.

Implemented in KMail::ImapAccountBase, KMAcctCachedImap, KMAcctImap, and KMail::PopAccount.

QString KMail::NetworkAccount::login (  )  const [inline]

User login name.

Definition at line 59 of file networkaccount.h.

bool KMail::NetworkAccount::mailCheckCanProceed (  )  const [virtual]

Determines whether the account can be checked, currently.

Reimplementations can use this to prevent mailchecks due to exceeded connection limits, or because a network link iis down.

Returns:
whether mail checks can proceed

Reimplemented from KMAccount.

Definition at line 370 of file networkaccount.cpp.

QString KMail::NetworkAccount::passwd (  )  const

User password.

Definition at line 93 of file networkaccount.cpp.

unsigned short int KMail::NetworkAccount::port (  )  const [inline]

Server port number.

Definition at line 84 of file networkaccount.h.

virtual QString KMail::NetworkAccount::protocol (  )  const [protected, pure virtual]

Implemented in KMail::ImapAccountBase, and KMail::PopAccount.

void KMail::NetworkAccount::pseudoAssign ( const KMAccount *  a  )  [virtual]

A weak assignment operator.

Reimplemented from KMAccount.

Reimplemented in KMail::ImapAccountBase, KMAcctCachedImap, KMAcctImap, and KMail::PopAccount.

Definition at line 304 of file networkaccount.cpp.

void KMail::NetworkAccount::readConfig ( KConfigGroup &  config  )  [virtual]

Read config file entries.

This method is called by the account manager when a new account is created.

Reimplemented from KMAccount.

Reimplemented in KMail::ImapAccountBase, KMAcctCachedImap, KMAcctImap, and KMail::PopAccount.

Definition at line 149 of file networkaccount.cpp.

void KMail::NetworkAccount::readPassword (  ) 

Read password from wallet, used for on-demand wallet opening.

Definition at line 320 of file networkaccount.cpp.

void KMail::NetworkAccount::resetConnectionList ( NetworkAccount *  acct  )  [static]

Reset connection list for the account.

Definition at line 389 of file networkaccount.cpp.

void KMail::NetworkAccount::setAuth ( const QString &  auth  )  [virtual]

Definition at line 111 of file networkaccount.cpp.

void KMail::NetworkAccount::setCheckingMail ( bool  checking  )  [virtual]

Reimplemented from KMAccount.

Definition at line 346 of file networkaccount.cpp.

void KMail::NetworkAccount::setHost ( const QString &  host  )  [virtual]

Definition at line 123 of file networkaccount.cpp.

void KMail::NetworkAccount::setLogin ( const QString &  login  )  [virtual]

Definition at line 89 of file networkaccount.cpp.

void KMail::NetworkAccount::setPasswd ( const QString &  passwd,
bool  storeInConfig = false 
) [virtual]

Definition at line 99 of file networkaccount.cpp.

void KMail::NetworkAccount::setPort ( unsigned short int  port  )  [virtual]

Definition at line 127 of file networkaccount.cpp.

void KMail::NetworkAccount::setSieveConfig ( const KMail::SieveConfig &  config  )  [virtual]

Definition at line 139 of file networkaccount.cpp.

void KMail::NetworkAccount::setStorePasswd ( bool  store  )  [virtual]

Definition at line 115 of file networkaccount.cpp.

void KMail::NetworkAccount::setUseSSL ( bool  use  )  [virtual]

Definition at line 131 of file networkaccount.cpp.

void KMail::NetworkAccount::setUseTLS ( bool  use  )  [virtual]

Definition at line 135 of file networkaccount.cpp.

KMail::SieveConfig KMail::NetworkAccount::sieveConfig (  )  const [inline]

Returns:
the SieveConfig for this account

Definition at line 96 of file networkaccount.h.

KIO::Slave* KMail::NetworkAccount::slave (  )  const [inline]

Returns:
the KIO slave for this account

Definition at line 112 of file networkaccount.h.

MetaData KMail::NetworkAccount::slaveConfig (  )  const [virtual]

Configure the slave by adding to the meta data map.

Reimplemented in KMail::ImapAccountBase, and KMail::PopAccount.

Definition at line 298 of file networkaccount.cpp.

bool KMail::NetworkAccount::storePasswd (  )  const [inline]

Returns:
whether to store the password in the config file

Definition at line 76 of file networkaccount.h.

bool KMail::NetworkAccount::useSSL (  )  const [inline]

Returns:
whether to use SSL

Definition at line 88 of file networkaccount.h.

bool KMail::NetworkAccount::useTLS (  )  const [inline]

Returns:
whether to use TLS

Definition at line 92 of file networkaccount.h.

void KMail::NetworkAccount::writeConfig ( KConfigGroup &  config  )  [virtual]

Write all account information to given config file.

Reimplemented from KMAccount.

Reimplemented in KMail::ImapAccountBase, KMAcctCachedImap, and KMail::PopAccount.

Definition at line 190 of file networkaccount.cpp.


Member Data Documentation

bool KMail::NetworkAccount::mAskAgain [protected]

Definition at line 138 of file networkaccount.h.

QString KMail::NetworkAccount::mAuth [protected]

Definition at line 133 of file networkaccount.h.

QString KMail::NetworkAccount::mHost [protected]

Definition at line 133 of file networkaccount.h.

QString KMail::NetworkAccount::mLogin [protected]

Definition at line 133 of file networkaccount.h.

QString KMail::NetworkAccount::mOldPassKey [protected]

Definition at line 133 of file networkaccount.h.

QString KMail::NetworkAccount::mPasswd [protected]

Definition at line 133 of file networkaccount.h.

bool KMail::NetworkAccount::mPasswdDirty [protected]

Definition at line 139 of file networkaccount.h.

unsigned short int KMail::NetworkAccount::mPort [protected]

Definition at line 134 of file networkaccount.h.

KMail::SieveConfig KMail::NetworkAccount::mSieveConfig [protected]

Definition at line 131 of file networkaccount.h.

QPointer<KIO::Slave> KMail::NetworkAccount::mSlave [protected]

Definition at line 132 of file networkaccount.h.

bool KMail::NetworkAccount::mStorePasswd [protected]

Definition at line 135 of file networkaccount.h.

bool KMail::NetworkAccount::mStorePasswdInConfig [protected]

Definition at line 139 of file networkaccount.h.

bool KMail::NetworkAccount::mUseSSL [protected]

Definition at line 136 of file networkaccount.h.

bool KMail::NetworkAccount::mUseTLS [protected]

Definition at line 137 of file networkaccount.h.


The documentation for this class was generated from the following files:
  • networkaccount.h
  • networkaccount.cpp

kmail

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

kdepim

Skip menu "kdepim"
  • akonadi
  •   clients
  •   kabc
  •   kcal
  •   kcm
  • akregator
  • console
  •   kabcclient
  •   konsolekalendar
  • kaddressbook
  • kalarm
  •   lib
  • kdgantt
  • kdgantt1
  • kjots
  • kleopatra
  • kmail
  • kmobiletools
  • knode
  • knotes
  • kontact
  • kontactinterfaces
  • korganizer
  •   korgac
  • kpilot
  • ktimetracker
  •   doc
  • libkdepim
  • libkholidays
  • libkleo
  • libkpgp
  • maildir
Generated for kdepim by doxygen 1.5.4
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