Skip to content
Skip to link menu

kmail

KMail::ListJob Class Reference

#include <listjob.h>

Inheritance diagram for KMail::ListJob:

Inheritance graph

List of all members.

Detailed Description

Generic folder list job for (d)imap accounts.

Definition at line 52 of file listjob.h.


Signals
void	receivedFolders (const QStringList &, const QStringList &, const QStringList &, const QStringList &, const ImapAccountBase::jobData &)
Public Member Functions
virtual void	execute ()
bool	honorLocalSubscription () const
	ListJob (ImapAccountBase account, ImapAccountBase::ListType type, FolderStorage storage=0, const QString &path=QString(), bool complete=false, KPIM::ProgressItem *item=0)
void	setComplete (bool complete)
void	setHonorLocalSubscription (bool value)
void	setNamespace (const QString &ns)
void	setParentProgressItem (KPIM::ProgressItem *it)
void	setPath (const QString &path)
void	setStorage (FolderStorage *st)
virtual	~ListJob ()
Protected Slots
void	slotConnectionResult (int errorCode, const QString &errorMsg)
void	slotListEntries (KIO::Job *job, const KIO::UDSEntryList &uds)
void	slotListResult (KJob *job)
Protected Attributes
ImapAccountBase *	mAccount
bool	mComplete
bool	mHonorLocalSubscription
QString	mNamespace
KPIM::ProgressItem *	mParentProgressItem
QString	mPath
FolderStorage *	mStorage
QStringList	mSubfolderAttributes
QStringList	mSubfolderMimeTypes
QStringList	mSubfolderNames
QStringList	mSubfolderPaths
ImapAccountBase::ListType	mType

Constructor & Destructor Documentation

ListJob::ListJob	(	ImapAccountBase *	account,
		ImapAccountBase::ListType	type,
		FolderStorage *	storage = `0`,
		const QString &	path = `QString()`,
		bool	complete = `false`,
		KPIM::ProgressItem *	item = `0`
	)

Create a new job.

Parameters:

	storage	the parent folder, either provide this or a path
	account	the ImapAccountBase
	type	Type of subscription
	complete	list all folders or only next level
	path	the listing path; if empty the path of the folder will be taken
	item	a parent ProgressItem

Definition at line 52 of file listjob.cpp.

ListJob::~ListJob ( ) [virtual]

Definition at line 63 of file listjob.cpp.

Member Function Documentation

void ListJob::execute ( ) [virtual]

Has to be reimplemented.

It's called by the start() method. Should start the processing of the specified job function.

Implements KMail::FolderJob.

Definition at line 67 of file listjob.cpp.

bool KMail::ListJob::honorLocalSubscription ( ) const

Return whether the listing includes only folders that the account is subscribed to locally.

This is different from the server side subscription managed by the ctor parameter.

Definition at line 234 of file listjob.cpp.

void KMail::ListJob::receivedFolders	(	const QStringList &	,
		const QStringList &	,
		const QStringList &	,
		const QStringList &	,
		const ImapAccountBase::jobData &
	)			`[signal]`

Emitted when new folders have been received.

void KMail::ListJob::setComplete ( bool complete ) [inline]

Set this to true for a complete listing.

Definition at line 95 of file listjob.h.

void KMail::ListJob::setHonorLocalSubscription ( bool value )

Set whether the listing should include only folders that the account is subscribed to locally.

This is different from the server side subscription managed by the ctor parameter.

Definition at line 229 of file listjob.cpp.

void KMail::ListJob::setNamespace ( const QString & ns ) [inline]

Set the namespace for this listing.

Definition at line 102 of file listjob.h.

void KMail::ListJob::setParentProgressItem ( KPIM::ProgressItem * it ) [inline]

Set parent progress item.

Definition at line 98 of file listjob.h.

void KMail::ListJob::setPath ( const QString & path ) [inline]

Path.

Definition at line 89 of file listjob.h.

void KMail::ListJob::setStorage ( FolderStorage * st ) [inline]

Storage.

Definition at line 92 of file listjob.h.

void ListJob::slotConnectionResult	(	int	errorCode,
		const QString &	errorMsg
	)			`[protected, slot]`

Called from the account when a connection was established.

Definition at line 152 of file listjob.cpp.

void ListJob::slotListEntries	(	KIO::Job *	job,
		const KIO::UDSEntryList &	uds
	)			`[protected, slot]`

Collects the folder information.

Definition at line 187 of file listjob.cpp.

void ListJob::slotListResult ( KJob * job ) [protected, slot]

Is called when the listing is done Passes the folders and the jobData to the responding folder.

Definition at line 164 of file listjob.cpp.

Member Data Documentation

ImapAccountBase* KMail::ListJob::mAccount [protected]

Definition at line 130 of file listjob.h.

bool KMail::ListJob::mComplete [protected]

Definition at line 132 of file listjob.h.

bool KMail::ListJob::mHonorLocalSubscription [protected]

Definition at line 133 of file listjob.h.

QString KMail::ListJob::mNamespace [protected]

Definition at line 138 of file listjob.h.

KPIM::ProgressItem* KMail::ListJob::mParentProgressItem [protected]

Definition at line 137 of file listjob.h.

QString KMail::ListJob::mPath [protected]

Definition at line 134 of file listjob.h.

FolderStorage* KMail::ListJob::mStorage [protected]

Definition at line 129 of file listjob.h.

QStringList KMail::ListJob::mSubfolderAttributes [protected]

Definition at line 135 of file listjob.h.

QStringList KMail::ListJob::mSubfolderMimeTypes [protected]

Definition at line 135 of file listjob.h.

QStringList KMail::ListJob::mSubfolderNames [protected]

Definition at line 135 of file listjob.h.

QStringList KMail::ListJob::mSubfolderPaths [protected]

Definition at line 135 of file listjob.h.

ImapAccountBase::ListType KMail::ListJob::mType [protected]

Reimplemented from KMail::FolderJob.

Definition at line 131 of file listjob.h.

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