kmail

#include <listjob.h>

Inherits KMail::FolderJob.

List of all members.

Signals

void receivedFolders (const TQStringList &, const TQStringList &, const TQStringList &, const TQStringList &, const ImapAccountBase::jobData &)

Public Member Functions

 ListJob (ImapAccountBase *account, ImapAccountBase::ListType type, FolderStorage *storage=0, const TQString &path=TQString(), bool complete=false, KPIM::ProgressItem *item=0)
void setHonorLocalSubscription (bool value)
bool honorLocalSubscription () const
virtual void execute ()
void setPath (const TQString &path)
void setStorage (FolderStorage *st)
void setComplete (bool complete)
void setParentProgressItem (KPIM::ProgressItem *it)
void setNamespace (const TQString &ns)

Protected Slots

void slotListResult (KIO::Job *job)
void slotListEntries (KIO::Job *job, const KIO::UDSEntryList &uds)
void slotConnectionResult (int errorCode, const TQString &errorMsg)

Protected Attributes

FolderStoragemStorage
ImapAccountBase * mAccount
ImapAccountBase::ListType mType
bool mComplete
bool mHonorLocalSubscription
TQString mPath
TQStringList mSubfolderNames
TQStringList mSubfolderPaths
TQStringList mSubfolderMimeTypes
TQStringList mSubfolderAttributes
KPIM::ProgressItem * mParentProgressItem
TQString mNamespace

Detailed Description

Generic folder list job for (d)imap accounts.

Definition at line 54 of file listjob.h.


Constructor & Destructor Documentation

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

Create a new job.

Parameters:
storagethe parent folder, either provide this or a path
accountthe ImapAccountBase
typeType of subscription
completelist all folders or only next level
paththe listing path; if empty the path of the folder will be taken
itema parent ProgressItem

Definition at line 53 of file listjob.cpp.


Member Function Documentation

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 250 of file listjob.cpp.

void KMail::ListJob::receivedFolders ( const TQStringList &  ,
const TQStringList &  ,
const TQStringList &  ,
const TQStringList &  ,
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 98 of file listjob.h.

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 245 of file listjob.cpp.

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

Set the namespace for this listing.

Definition at line 105 of file listjob.h.

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

Set parent progress item.

Definition at line 101 of file listjob.h.

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

Path.

Definition at line 92 of file listjob.h.

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

Storage.

Definition at line 95 of file listjob.h.

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

Called from the account when a connection was established.

Definition at line 154 of file listjob.cpp.

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

Collects the folder information.

Definition at line 189 of file listjob.cpp.

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

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

Definition at line 166 of file listjob.cpp.


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