1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
|
/*
* Copyright (c) 2004 Carsten Burghardt <[email protected]>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; version 2 of the License
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* In addition, as a special exception, the copyright holders give
* permission to link the code of this program with any edition of
* the Qt library by Trolltech AS, Norway (or with modified versions
* of Qt that use the same license as Qt), and distribute linked
* combinations including the two. You must obey the GNU General
* Public License in all respects for all of the code used other than
* Qt. If you modify this file, you may extend this exception to
* your version of the file, but you are not obligated to do so. If
* you do not wish to do so, delete this exception statement from
* your version.
*/
#ifndef LISTJOB_H
#define LISTJOB_H
#include "folderjob.h"
#include "imapaccountbase.h"
class KMFolderImap;
class KMFolderCachedImap;
class KMAcctImap;
class KMAcctCachedImap;
class FolderStorage;
class KURL;
namespace KIO {
class Job;
}
namespace KPIM {
class ProgressItem;
}
namespace KMail {
/**
* Generic folder list job for (d)imap accounts
*/
class ListJob : public FolderJob
{
Q_OBJECT
public:
/**
* Create a new job
* @param storage the parent folder, either provide this or a path
* @param account the ImapAccountBase
* @param type Type of subscription
* @param complete list all folders or only next level
* @param path the listing path;
* if empty the path of the folder will be taken
* @param item a parent ProgressItem
*/
ListJob( ImapAccountBase* account, ImapAccountBase::ListType type,
FolderStorage* storage = 0, const QString& path = QString::null,
bool complete = false, KPIM::ProgressItem* item = 0 );
virtual ~ListJob();
/**
* 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.
*/
void setHonorLocalSubscription( bool value );
/**
* 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.
*/
bool honorLocalSubscription() const;
virtual void execute();
/** Path */
void setPath( const QString& path ) { mPath = path; }
/** Storage */
void setStorage( FolderStorage* st ) { mStorage = st; }
/** Set this to true for a complete listing */
void setComplete( bool complete ) { mComplete = complete; }
/** Set parent progress item */
void setParentProgressItem( KPIM::ProgressItem* it ) {
mParentProgressItem = it; }
/** Set the namespace for this listing */
void setNamespace( const QString& ns ) { mNamespace = ns; }
protected slots:
/**
* Is called when the listing is done
* Passes the folders and the jobData to the responding folder
*/
void slotListResult( KIO::Job* job );
/**
* Collects the folder information
*/
void slotListEntries( KIO::Job* job, const KIO::UDSEntryList& uds );
/**
* Called from the account when a connection was established
*/
void slotConnectionResult( int errorCode, const QString& errorMsg );
signals:
/**
* Emitted when new folders have been received
*/
void receivedFolders( const QStringList&, const QStringList&,
const QStringList&, const QStringList&, const ImapAccountBase::jobData& );
protected:
FolderStorage* mStorage;
ImapAccountBase* mAccount;
ImapAccountBase::ListType mType;
bool mComplete;
bool mHonorLocalSubscription;
QString mPath;
QStringList mSubfolderNames, mSubfolderPaths,
mSubfolderMimeTypes, mSubfolderAttributes;
KPIM::ProgressItem* mParentProgressItem;
QString mNamespace;
};
} // namespace
#endif /* LISTJOB_H */
|
