kmail

KMail::PopAccount

KMail::PopAccount Class Reference

#include <popaccount.h>

Inheritance diagram for KMail::PopAccount:

[legend]

List of all members.

Detailed Description

KMail account for pop mail account.

Definition at line 30 of file popaccount.h.


Public Member Functions
virtual unsigned short int	defaultPort () const
bool	filterOnServer (void) const
unsigned int	filterOnServerCheckSize (void) const
virtual void	init (void)
virtual void	killAllJobs (bool disconnectSlave=false)
bool	leaveOnServer (void) const
int	leaveOnServerCount (void) const
int	leaveOnServerDays (void) const
int	leaveOnServerSize (void) const
virtual void	processNewMail (bool _interactive)
virtual QString	protocol () const
virtual void	pseudoAssign (const KMAccount *a)
virtual void	readConfig (KConfigGroup &)
virtual void	setFilterOnServer (bool)
virtual void	setFilterOnServerCheckSize (unsigned int)
virtual void	setLeaveOnServer (bool)
virtual void	setLeaveOnServerCount (int)
virtual void	setLeaveOnServerDays (int)
virtual void	setLeaveOnServerSize (int)
virtual void	setUsePipelining (bool)
virtual KIO::MetaData	slaveConfig () const
bool	usePipelining (void) const
virtual void	writeConfig (KConfigGroup &)
virtual	~PopAccount ()
Protected Slots
void	slotAbortRequested ()
void	slotCancel ()
void	slotData (KIO::Job *, const QByteArray &)
void	slotGetNextHdr ()
void	slotGetNextMsg ()
void	slotJobFinished ()
void	slotMsgRetrieved (KJob *, const QString &, const QString &)
void	slotProcessPendingMsgs ()
void	slotResult (KJob *)
void	slotSlaveError (KIO::Slave *, int, const QString &)

Constructor & Destructor Documentation

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

Definition at line 81 of file popaccount.cpp.

Member Function Documentation

unsigned short int KMail::PopAccount::defaultPort ( ) const [virtual]

Implements KMail::NetworkAccount.

Definition at line 96 of file popaccount.cpp.

bool KMail::PopAccount::filterOnServer ( void ) const [inline]

Shall messages be filter on the server (true) or not (false).

Definition at line 80 of file popaccount.h.

unsigned int KMail::PopAccount::filterOnServerCheckSize ( void ) const [inline]

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

Definition at line 87 of file popaccount.h.

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

Set the config options to a decent state.

Reimplemented from KMail::NetworkAccount.

Definition at line 101 of file popaccount.cpp.

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

Kill all jobs that are currently in progress.

Implements KMail::NetworkAccount.

Definition at line 1096 of file popaccount.cpp.

bool KMail::PopAccount::leaveOnServer ( void ) const [inline]

Shall messages be left on the server upon retreival (true) or deleted (false).

Definition at line 55 of file popaccount.h.

int KMail::PopAccount::leaveOnServerCount ( void ) const [inline]

If value is positive, leave so many messages on the server.

Definition at line 67 of file popaccount.h.

int KMail::PopAccount::leaveOnServerDays ( void ) const [inline]

If value is positive, leave mail on the server for so many days.

Definition at line 61 of file popaccount.h.

int KMail::PopAccount::leaveOnServerSize ( void ) const [inline]

If value is positive, leave so many MBs on the server.

Definition at line 73 of file popaccount.h.

void KMail::PopAccount::processNewMail ( bool interactive ) [virtual]

Process new mail for this account if one arrived.

Returns true if new mail has been found. Whether the mail is automatically loaded to an associated folder or not depends on the type of the account.

Implements KMAccount.

Definition at line 133 of file popaccount.cpp.

QString KMail::PopAccount::protocol ( ) const [virtual]

Implements KMail::NetworkAccount.

Definition at line 92 of file popaccount.cpp.

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

A weak assignment operator.

Reimplemented from KMail::NetworkAccount.

Definition at line 116 of file popaccount.cpp.

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

Inherited methods.

Reimplemented from KMail::NetworkAccount.

Definition at line 198 of file popaccount.cpp.

void KMail::PopAccount::setFilterOnServer ( bool b ) [virtual]

Definition at line 258 of file popaccount.cpp.

void KMail::PopAccount::setFilterOnServerCheckSize ( unsigned int aSize ) [virtual]

Definition at line 264 of file popaccount.cpp.

void KMail::PopAccount::setLeaveOnServer ( bool b ) [virtual]

Definition at line 234 of file popaccount.cpp.

void KMail::PopAccount::setLeaveOnServerCount ( int count ) [virtual]

Definition at line 246 of file popaccount.cpp.

void KMail::PopAccount::setLeaveOnServerDays ( int days ) [virtual]

Definition at line 240 of file popaccount.cpp.

void KMail::PopAccount::setLeaveOnServerSize ( int size ) [virtual]

Definition at line 252 of file popaccount.cpp.

void KMail::PopAccount::setUsePipelining ( bool b ) [virtual]

Definition at line 228 of file popaccount.cpp.

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

Configure the slave by adding to the meta data map.

Reimplemented from KMail::NetworkAccount.

Definition at line 407 of file popaccount.cpp.

void KMail::PopAccount::slotAbortRequested ( ) [protected, slot]

Kills the job if still stage == List.

Definition at line 338 of file popaccount.cpp.

void KMail::PopAccount::slotCancel ( ) [protected, slot]

Cleans up after a user cancels the current job.

Definition at line 282 of file popaccount.cpp.

void KMail::PopAccount::slotData	(	KIO::Job *	job,
		const QByteArray &	data
	)			`[protected, slot]`

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

Definition at line 884 of file popaccount.cpp.

void KMail::PopAccount::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 1086 of file popaccount.cpp.

void KMail::PopAccount::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 863 of file popaccount.cpp.

void KMail::PopAccount::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 459 of file popaccount.cpp.

void KMail::PopAccount::slotMsgRetrieved	(	KJob *	,
		const QString &	infoMsg,
		const QString &
	)			`[protected, slot]`

A messages has been retrieved successfully.

The next data belongs to the next message.

Definition at line 427 of file popaccount.cpp.

void KMail::PopAccount::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 303 of file popaccount.cpp.

void KMail::PopAccount::slotResult ( KJob * ) [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 1029 of file popaccount.cpp.

void KMail::PopAccount::slotSlaveError	(	KIO::Slave *	aSlave,
		int	error,
		const QString &	errorMsg
	)			`[protected, slot]`

Slave error handling.

Definition at line 1059 of file popaccount.cpp.

bool KMail::PopAccount::usePipelining ( void ) const [inline]

Sending of several commands at once.

Definition at line 48 of file popaccount.h.

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

Write all account information to given config file.

Reimplemented from KMail::NetworkAccount.

Definition at line 213 of file popaccount.cpp.

The documentation for this class was generated from the following files:

kmail

KMail::PopAccount Class Reference

Detailed Description

Public Member Functions

Protected Slots

Constructor & Destructor Documentation

Member Function Documentation

kmail

kdepim