kmail Library API Documentation

KMAcctExpPop Class Reference

KMail account for pop mail account The Exp in the name used to mean Experimental, but it's the stable one now :). More...

#include <kmacctexppop.h>

List of all members.

Public Member Functions

virtual void init (void)
virtual KIO::MetaData slaveConfig () const
virtual void pseudoAssign (const KMAccount *a)
virtual QString protocol () const
virtual unsigned short int defaultPort () const
bool usePipelining (void) const
virtual void setUsePipelining (bool)
bool leaveOnServer (void) const
virtual void setLeaveOnServer (bool)
bool filterOnServer (void) const
virtual void setFilterOnServer (bool)
unsigned int filterOnServerCheckSize (void) const
virtual void setFilterOnServerCheckSize (unsigned int)
virtual QString type (void) const
virtual void readConfig (KConfig &)
virtual void writeConfig (KConfig &)
virtual void processNewMail (bool _interactive)
virtual void killAllJobs (bool disconnectSlave=false)

Protected Types

enum  Stage {
  Idle, List, Uidl, Head,
  Retr, Dele, Quit
}

Protected Slots

void slotProcessPendingMsgs ()
void slotGetNextMsg ()
void slotMsgRetrieved (KIO::Job *, const QString &)
void slotData (KIO::Job *, const QByteArray &)
void slotResult (KIO::Job *)
void slotCancel ()
void slotAbortRequested ()
void slotJobFinished ()
void slotSlaveError (KIO::Slave *, int, const QString &)
void slotGetNextHdr ()

Protected Member Functions

 KMAcctExpPop (KMAcctMgr *owner, const QString &accountName, uint id)
void startJob ()
void connectJob ()
void processRemainingQueuedMessages ()
void saveUidList ()

Protected Attributes

bool mUsePipelining
bool mLeaveOnServer
bool gotMsgs
bool mFilterOnServer
unsigned int mFilterOnServerCheckSize
KIO::SimpleJob * job
QMap< QString, int > mMsgsPendingDownload
QPtrList< KMPopHeaders > headersOnServer
QPtrListIterator< KMPopHeaders > headerIt
bool headers
QMap< QString, bool > mHeaderDeleteUids
QMap< QString, bool > mHeaderDownUids
QMap< QString, bool > mHeaderLaterUids
QStringList idsOfMsgs
QValueList< int > lensOfMsgs
QMap< QString, QStringmUidForIdMap
QDict< int > mUidsOfSeenMsgsDict
QDict< int > mUidsOfNextSeenMsgsDict
QStringList idsOfMsgsToDelete
int indexOfCurrentMsg
QValueList< KMMessage * > msgsAwaitingProcessing
QStringList msgIdsAwaitingProcessing
QStringList msgUidsAwaitingProcessing
QByteArray curMsgData
QDataStreamcurMsgStrm
int curMsgLen
int stage
QTimer processMsgsTimer
int processingDelay
int numMsgs
int numBytes
int numBytesToRead
int numBytesRead
int numMsgBytesRead
bool interactive
bool mProcessing
bool mUidlFinished
int dataCounter


Detailed Description

KMail account for pop mail account The Exp in the name used to mean Experimental, but it's the stable one now :).

Definition at line 26 of file kmacctexppop.h.


Member Function Documentation

void KMAcctExpPop::pseudoAssign const KMAccount *  a  )  [virtual]
 

A weak assignment operator.

Definition at line 102 of file kmacctexppop.cpp.

References filterOnServer(), filterOnServerCheckSize(), leaveOnServer(), pseudoAssign(), slotAbortRequested(), and usePipelining().

Referenced by pseudoAssign().

bool KMAcctExpPop::usePipelining void   )  const [inline]
 

Sending of several commands at once.

Definition at line 44 of file kmacctexppop.h.

Referenced by pseudoAssign().

bool KMAcctExpPop::leaveOnServer void   )  const [inline]
 

Shall messages be left on the server upon retreival (TRUE) or deleted (FALSE).

Definition at line 51 of file kmacctexppop.h.

Referenced by pseudoAssign().

bool KMAcctExpPop::filterOnServer void   )  const [inline]
 

Shall messages be filter on the server (TRUE) or not (FALSE).

Definition at line 58 of file kmacctexppop.h.

Referenced by pseudoAssign().

unsigned int KMAcctExpPop::filterOnServerCheckSize void   )  const [inline]
 

Size of messages which should be check on the pop server before download.

Definition at line 65 of file kmacctexppop.h.

Referenced by pseudoAssign().

QString KMAcctExpPop::type void   )  const [virtual]
 

Inherited methods.

Definition at line 76 of file kmacctexppop.cpp.

void KMAcctExpPop::startJob  )  [protected]
 

Start a KIO Job to get a list of messages on the pop server.

Definition at line 294 of file kmacctexppop.cpp.

References connectJob(), slotAbortRequested(), and slotSlaveError().

void KMAcctExpPop::connectJob  )  [protected]
 

Connect up the standard signals/slots for the KIO Jobs.

Definition at line 215 of file kmacctexppop.cpp.

References slotData(), slotMsgRetrieved(), and slotResult().

Referenced by slotJobFinished(), and startJob().

void KMAcctExpPop::processRemainingQueuedMessages  )  [protected]
 

Process any queued messages.

Definition at line 659 of file kmacctexppop.cpp.

References slotProcessPendingMsgs().

Referenced by slotCancel(), and slotJobFinished().

void KMAcctExpPop::saveUidList  )  [protected]
 

Save the list of seen uids for this user/server.

Definition at line 671 of file kmacctexppop.cpp.

Referenced by slotCancel(), and slotJobFinished().

void KMAcctExpPop::slotProcessPendingMsgs  )  [protected, slot]
 

Messages are downloaded in the background and then once every x seconds a batch of messages are processed.

Messages are processed in batches to reduce flicker (multiple refreshes of the qlistview of messages headers in a single second causes flicker) when using a fast pop server such as one on a lan.

Processing a message means applying KMAccount::processNewMsg to it and adding its UID to the list of seen UIDs

Definition at line 238 of file kmacctexppop.cpp.

Referenced by processRemainingQueuedMessages().

void KMAcctExpPop::slotGetNextMsg  )  [protected, slot]
 

If there are more messages to be downloaded then start a new kio job to get the message whose id is at the head of the queue.

Definition at line 692 of file kmacctexppop.cpp.

Referenced by slotJobFinished(), and slotMsgRetrieved().

void KMAcctExpPop::slotMsgRetrieved KIO::Job *  ,
const QString
[protected, slot]
 

A messages has been retrieved successfully.

The next data belongs to the next message.

Definition at line 368 of file kmacctexppop.cpp.

References slotGetNextHdr(), slotGetNextMsg(), and slotMsgRetrieved().

Referenced by connectJob(), and slotMsgRetrieved().

void KMAcctExpPop::slotData KIO::Job *  ,
const QByteArray
[protected, slot]
 

New data has arrived append it to the end of the current message.

Definition at line 715 of file kmacctexppop.cpp.

References slotData().

Referenced by connectJob(), and slotData().

void KMAcctExpPop::slotResult KIO::Job *   )  [protected, slot]
 

Finished downloading the current kio job, either due to an error or because the job has been canceled or because the complete message has been downloaded.

Definition at line 808 of file kmacctexppop.cpp.

References slotCancel(), slotJobFinished(), and slotResult().

Referenced by connectJob(), and slotResult().

void KMAcctExpPop::slotCancel  )  [protected, slot]
 

Cleans up after a user cancels the current job.

Definition at line 228 of file kmacctexppop.cpp.

References processRemainingQueuedMessages(), saveUidList(), and slotJobFinished().

Referenced by slotAbortRequested(), slotResult(), and slotSlaveError().

void KMAcctExpPop::slotAbortRequested  )  [protected, slot]
 

Kills the job if still stage == List.

Definition at line 280 of file kmacctexppop.cpp.

References slotCancel().

Referenced by pseudoAssign(), and startJob().

void KMAcctExpPop::slotJobFinished  )  [protected, slot]
 

Called when a job is finished.

Basically a finite state machine for cycling through the Idle, List, Uidl, Retr, Quit stages

Definition at line 400 of file kmacctexppop.cpp.

References connectJob(), processRemainingQueuedMessages(), saveUidList(), slotGetNextHdr(), and slotGetNextMsg().

Referenced by slotCancel(), and slotResult().

void KMAcctExpPop::slotSlaveError KIO::Slave *  ,
int  ,
const QString
[protected, slot]
 

Slave error handling.

Definition at line 837 of file kmacctexppop.cpp.

References slotCancel(), and slotSlaveError().

Referenced by slotSlaveError(), and startJob().

void KMAcctExpPop::slotGetNextHdr  )  [protected, slot]
 

If there are more headers to be downloaded then start a new kio job to get the next header.

Definition at line 864 of file kmacctexppop.cpp.

Referenced by slotJobFinished(), and slotMsgRetrieved().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kmail Library Version 3.3.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Fri Oct 1 15:19:25 2004 by doxygen 1.3.7 written by Dimitri van Heesch, © 1997-2003