aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/core/imap/MCIMAPSession.h
blob: bd31527e6e590c9b173bb29febec1eda6801c04d (plain)
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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
#ifndef __MAILCORE_MCIMAPSESSION_H

#define __MAILCORE_MCIMAPSESSION_H

#include <mailcore/MCBaseTypes.h>
#include <mailcore/MCMessageConstants.h>
#include <libetpan/libetpan.h>

#ifdef __cplusplus

namespace mailcore {

	extern String * IMAPNamespacePersonal;
	extern String * IMAPNamespaceOther;
	extern String * IMAPNamespaceShared;

	class IMAPNamespace;
	class IMAPSearchExpression;
	class IMAPFolder;
	class IMAPProgressCallback;
    class IMAPSyncResult;
	
	class IMAPSession : public Object {
	public:
		IMAPSession();
		virtual ~IMAPSession();
		
		virtual void setHostname(String * hostname);
		virtual String * hostname();

		virtual void setPort(unsigned int port);
		virtual unsigned int port();

		virtual void setUsername(String * username);
		virtual String * username();

		virtual void setPassword(String * password);
		virtual String * password();

		virtual void setAuthType(AuthType authType);
		virtual AuthType authType();

		virtual void setConnectionType(ConnectionType connectionType);
		virtual ConnectionType connectionType();

		virtual void setTimeout(time_t timeout);
		virtual time_t timeout();
		
		virtual void setCheckCertificateEnabled(bool enabled);
		virtual bool isCheckCertificateEnabled();

		virtual void setVoIPEnabled(bool enabled);
		virtual bool isVoIPEnabled();

        // Needed for fetchSubscribedFolders() and fetchAllFolders().
		virtual void setDelimiter(char delimiter);
		virtual char delimiter();

        // Needed for fetchSubscribedFolders() and fetchAllFolders().
		virtual void setDefaultNamespace(IMAPNamespace * ns);
		virtual IMAPNamespace * defaultNamespace();

		virtual void select(String * folder, ErrorCode * pError);
		
		virtual Array * /* IMAPFolder */ fetchSubscribedFolders(ErrorCode * pError);
		virtual Array * /* IMAPFolder */ fetchAllFolders(ErrorCode * pError); // will use xlist if available

		virtual void renameFolder(String * folder, String * otherName, ErrorCode * pError);
		virtual void deleteFolder(String * folder, ErrorCode * pError);
		virtual void createFolder(String * folder, ErrorCode * pError);

		virtual void subscribeFolder(String * folder, ErrorCode * pError);
		virtual void unsubscribeFolder(String * folder, ErrorCode * pError);

		virtual void appendMessage(String * folder, Data * messageData, MessageFlag flags,
			IMAPProgressCallback * progressCallback, uint32_t * createdUID, ErrorCode * pError);
		
		virtual void copyMessages(String * folder, IndexSet * uidSet, String * destFolder,
			 IndexSet ** pDestUIDs, ErrorCode * pError);
		
		virtual void expunge(String * folder, ErrorCode * pError);
		
		virtual Array * /* IMAPMessage */ fetchMessagesByUID(String * folder, IMAPMessagesRequestKind requestKind,
                                                             IndexSet * uids, IMAPProgressCallback * progressCallback, ErrorCode * pError);
		virtual Array * /* IMAPMessage */ fetchMessagesByNumber(String * folder, IMAPMessagesRequestKind requestKind,
                                                                IndexSet * numbers, IMAPProgressCallback * progressCallback, ErrorCode * pError);
        
		virtual Data * fetchMessageByUID(String * folder, uint32_t uid,
			IMAPProgressCallback * progressCallback, ErrorCode * pError);
		virtual Data * fetchMessageAttachmentByUID(String * folder, uint32_t uid, String * partID,
		    Encoding encoding, IMAPProgressCallback * progressCallback, ErrorCode * pError);
		virtual HashMap * fetchMessageNumberUIDMapping(String * folder, uint32_t fromUID, uint32_t toUID,
			ErrorCode * pError);
        
        /* When CONDSTORE or QRESYNC is available */
        virtual IMAPSyncResult * syncMessagesByUID(String * folder, IMAPMessagesRequestKind requestKind,
                                                   IndexSet * uids, uint64_t modseq,
                                                   IMAPProgressCallback * progressCallback, ErrorCode * pError);
        
		virtual void storeFlags(String * folder, IndexSet * uids, IMAPStoreFlagsRequestKind kind, MessageFlag flags, ErrorCode * pError);
		virtual void storeLabels(String * folder, IndexSet * uids, IMAPStoreFlagsRequestKind kind, Array * labels, ErrorCode * pError);
		
		virtual IndexSet * search(String * folder, IMAPSearchKind kind, String * searchString, ErrorCode * pError);
		virtual IndexSet * search(String * folder, IMAPSearchExpression * expression, ErrorCode * pError);
		
		virtual void setupIdle();
		virtual void idle(String * folder, uint32_t lastKnownUID, ErrorCode * pError);
		virtual void interruptIdle();
		virtual void unsetupIdle();
		
		virtual void connect(ErrorCode * pError);
		virtual void disconnect();
		
		virtual HashMap * fetchNamespace(ErrorCode * pError);
		
		virtual void login(ErrorCode * pError);
		
		virtual HashMap * identity(String * vendor, String * name, String * version, ErrorCode * pError);
        
        virtual IndexSet * capability(ErrorCode * pError);
        
		virtual uint32_t uidValidity();
		virtual uint32_t uidNext();
        virtual uint64_t modSequenceValue();
		virtual unsigned int lastFolderMessageCount();
        
        virtual bool isIdleEnabled();
        virtual bool isXListEnabled();
        virtual bool isCondstoreEnabled();
        virtual bool isQResyncEnabled();
        virtual bool isIdentityEnabled();
        
	private:
		String * mHostname;
		unsigned int mPort;
		String * mUsername;
		String * mPassword;
		AuthType mAuthType;
		ConnectionType mConnectionType;
		bool mCheckCertificateEnabled;
		bool mVoIPEnabled;
		char mDelimiter;
		IMAPNamespace * mDefaultNamespace;
		time_t mTimeout;
		
        bool mBodyProgressEnabled;
		bool mIdleEnabled;
		bool mXListEnabled;
        bool mCondstoreEnabled;
        bool mQResyncEnabled;
        bool mIdentityEnabled;
		String * mWelcomeString;
		bool mNeedsMboxMailWorkaround;
		uint32_t mUIDValidity;
		uint32_t mUIDNext;
        uint64_t mModSequenceValue;
		unsigned int mFolderMsgCount;
		unsigned int mLastFetchedSequenceNumber;
		String * mCurrentFolder;
		pthread_mutex_t mIdleLock;
		int mState;
		mailimap * mImap;
		IMAPProgressCallback * mProgressCallback;
		unsigned int mProgressItemsCount;
		
		void init();
		void bodyProgress(unsigned int current, unsigned int maximum);
		void itemsProgress(unsigned int current, unsigned int maximum);
		bool checkCertificate();
		static void body_progress(size_t current, size_t maximum, void * context);
		static void items_progress(size_t current, size_t maximum, void * context);
		void setup();
		void unsetup();
		void connectIfNeeded(ErrorCode * pError);
		void loginIfNeeded(ErrorCode * pError);
		void selectIfNeeded(String * folder, ErrorCode * pError);
		char fetchDelimiterIfNeeded(char defaultDelimiter, ErrorCode * pError);
		IMAPSyncResult * fetchMessages(String * folder, IMAPMessagesRequestKind requestKind, bool fetchByUID,
                                       struct mailimap_set * imapset, uint64_t modseq, HashMap * mapping, uint32_t startUid,
                                       IMAPProgressCallback * progressCallback, ErrorCode * pError);
		
	};
}

#endif

#endif