kmail

KMail::AccountManager Class Reference

#include <accountmanager.h>

List of all members.


Detailed Description

The account manager is responsible for creating accounts of various types via the factory method create() and for keeping track of them.

Definition at line 35 of file accountmanager.h.


Public Slots

void singleCheckMail (KMAccount *, bool interactive=true)
void singleInvalidateIMAPFolders (KMAccount *)
void intCheckMail (int, bool interactive=true)
void processNextCheck (bool newMail)
void addToTotalNewMailCount (const QMap< QString, int > &newInFolder)

Signals

void checkedMail (bool newMail, bool interactive, const QMap< QString, int > &newInFolder)
void accountRemoved (KMAccount *account)
void accountAdded (KMAccount *account)

Public Member Functions

 AccountManager ()
 ~AccountManager ()
void readConfig (void)
void writeConfig (bool withSync=true)
KMAccountcreate (const QString &type, const QString &name=QString::null, uint id=0)
void add (KMAccount *account)
KMAccountfindByName (const QString &name) const
KMAccountfind (const uint id) const
bool remove (KMAccount *)
const KMAccountfirst () const
KMAccountfirst ()
const KMAccountnext () const
KMAccountnext ()
void checkMail (bool interactive=true)
void invalidateIMAPFolders ()
QStringList getAccounts () const
void cancelMailCheck ()
void readPasswords ()

Friends

class ::KMAccount

Constructor & Destructor Documentation

AccountManager::AccountManager (  ) 

Initializes the account manager.

readConfig() needs to be called in order to fill it with persisted account information from the config file.

Definition at line 32 of file accountmanager.cpp.


Member Function Documentation

void AccountManager::readConfig ( void   ) 

Completely reload accounts from config.

Definition at line 75 of file accountmanager.cpp.

void AccountManager::writeConfig ( bool  withSync = true  ) 

Write accounts to config.

Definition at line 48 of file accountmanager.cpp.

KMAccount * AccountManager::create ( const QString &  type,
const QString &  name = QString::null,
uint  id = 0 
)

Create a new account of given type with given name.

Currently the types "local" for local mail folders and "pop" are supported.

Definition at line 201 of file accountmanager.cpp.

void AccountManager::add ( KMAccount account  ) 

Adds an account to the list of accounts.

Definition at line 232 of file accountmanager.cpp.

KMAccount * AccountManager::findByName ( const QString &  name  )  const

Find account by name.

Returns 0 if account does not exist. Search is done case sensitive.

Definition at line 243 of file accountmanager.cpp.

KMAccount * AccountManager::find ( const uint  id  )  const

Find account by id.

Returns 0 if account does not exist.

Definition at line 255 of file accountmanager.cpp.

bool AccountManager::remove ( KMAccount  ) 

Physically remove account.

Also deletes the given account object ! Returns FALSE and does nothing if the account cannot be removed.

Definition at line 287 of file accountmanager.cpp.

const KMAccount* KMail::AccountManager::first (  )  const [inline]

First account of the list.

Definition at line 74 of file accountmanager.h.

const KMAccount* KMail::AccountManager::next (  )  const [inline]

Next account of the list.

Definition at line 78 of file accountmanager.h.

void AccountManager::checkMail ( bool  interactive = true  ) 

Processes all accounts looking for new mail.

Definition at line 297 of file accountmanager.cpp.

void AccountManager::invalidateIMAPFolders (  ) 

Delete all IMAP folders and resync them.

Definition at line 324 of file accountmanager.cpp.

void AccountManager::cancelMailCheck (  ) 

Called on exit (KMMainWin::queryExit).

Definition at line 385 of file accountmanager.cpp.

void AccountManager::readPasswords (  ) 

Read passwords of all accounts from the wallet.

Definition at line 394 of file accountmanager.cpp.

void AccountManager::addToTotalNewMailCount ( const QMap< QString, int > &  newInFolder  )  [slot]

this slot increases the count of new mails to show a total number after checking in multiple accounts.

Definition at line 354 of file accountmanager.cpp.

void KMail::AccountManager::checkedMail ( bool  newMail,
bool  interactive,
const QMap< QString, int > &  newInFolder 
) [signal]

Emitted if new mail has been collected.

Parameters:
newMail true if there was new mail
interactive true if the mail check was initiated by the user
newInFolder number of new messages for each folder

void KMail::AccountManager::accountRemoved ( KMAccount account  )  [signal]

emitted when an account is removed

void KMail::AccountManager::accountAdded ( KMAccount account  )  [signal]

emitted when an account is added


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys