#include <listjob.h>
Inherits KMail::FolderJob.
|
FolderStorage * | mStorage |
|
ImapAccountBase * | mAccount |
|
ImapAccountBase::ListType | mType |
|
bool | mComplete |
|
bool | mHonorLocalSubscription |
|
TQString | mPath |
|
TQStringList | mSubfolderNames |
|
TQStringList | mSubfolderPaths |
|
TQStringList | mSubfolderMimeTypes |
|
TQStringList | mSubfolderAttributes |
|
KPIM::ProgressItem * | mParentProgressItem |
|
TQString | mNamespace |
|
Generic folder list job for (d)imap accounts.
Definition at line 54 of file listjob.h.
◆ ListJob()
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
-
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 53 of file listjob.cpp.
◆ honorLocalSubscription()
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 250 of file listjob.cpp.
◆ receivedFolders
void KMail::ListJob::receivedFolders |
( |
const TQStringList & |
, |
|
|
const TQStringList & |
, |
|
|
const TQStringList & |
, |
|
|
const TQStringList & |
, |
|
|
const ImapAccountBase::jobData & |
|
|
) |
| |
|
signal |
Emitted when new folders have been received.
◆ setComplete()
void KMail::ListJob::setComplete |
( |
bool |
complete | ) |
|
|
inline |
Set this to true for a complete listing.
Definition at line 98 of file listjob.h.
◆ setHonorLocalSubscription()
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 245 of file listjob.cpp.
◆ setNamespace()
void KMail::ListJob::setNamespace |
( |
const TQString & |
ns | ) |
|
|
inline |
Set the namespace for this listing.
Definition at line 105 of file listjob.h.
◆ setParentProgressItem()
void KMail::ListJob::setParentProgressItem |
( |
KPIM::ProgressItem * |
it | ) |
|
|
inline |
Set parent progress item.
Definition at line 101 of file listjob.h.
◆ setPath()
void KMail::ListJob::setPath |
( |
const TQString & |
path | ) |
|
|
inline |
◆ setStorage()
◆ slotConnectionResult
void ListJob::slotConnectionResult |
( |
int |
errorCode, |
|
|
const TQString & |
errorMsg |
|
) |
| |
|
protectedslot |
Called from the account when a connection was established.
Definition at line 154 of file listjob.cpp.
◆ slotListEntries
void ListJob::slotListEntries |
( |
TDEIO::Job * |
job, |
|
|
const TDEIO::UDSEntryList & |
uds |
|
) |
| |
|
protectedslot |
Collects the folder information.
Definition at line 189 of file listjob.cpp.
◆ slotListResult
void ListJob::slotListResult |
( |
TDEIO::Job * |
job | ) |
|
|
protectedslot |
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:
|