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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- qmailmessageservice.cpp -->
<head>
<title>QMailMessageSource Class Reference</title>
<link href="classic.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left" valign="top" width="32"><img src="images/qtlogo.png" align="left" border="0" /></td>
<td width="1"> </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a></td>
<td align="right" valign="top" width="230"><img src="images/codeless.png" border="0" /></td></tr></table><h1 class="title">QMailMessageSource Class Reference</h1>
<p>The QMailMessageSource class defines the interface to objects that provide access to externally sourced messages to the messageserver. <a href="#details">More...</a></p>
<pre> #include <QMailMessageSource></pre><p>Inherits <a href="http://doc.trolltech.com/4.5/qobject.html">QObject</a>.</p>
<ul>
<li><a href="qmailmessagesource-members.html">List of all members, including inherited members</a></li>
</ul>
<hr />
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr><td class="memItemLeft" align="right" valign="top">virtual QMailStore::MessageRemovalOption </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#messageRemovalOption">messageRemovalOption</a></b> () const</td></tr>
</table>
<ul>
<li><div bar="2" class="fn"></div>29 public functions inherited from <a href="http://doc.trolltech.com/4.5/qobject.html#public-functions">QObject</a></li>
</ul>
<hr />
<a name="public-slots"></a>
<h2>Public Slots</h2>
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#cancelSearch">cancelSearch</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#cancelSearch-2">cancelSearch</a></b> ( quint64 <i>action</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#copyMessages">copyMessages</a></b> ( const QMailMessageIdList & <i>ids</i>, const QMailFolderId & <i>destinationId</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#copyMessages-2">copyMessages</a></b> ( const QMailMessageIdList & <i>ids</i>, const QMailFolderId & <i>destinationId</i>, quint64 <i>action</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#createFolder">createFolder</a></b> ( const QString & <i>name</i>, const QMailAccountId & <i>accountId</i>, const QMailFolderId & <i>parentId</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#createFolder-2">createFolder</a></b> ( const QString & <i>name</i>, const QMailAccountId & <i>accountId</i>, const QMailFolderId & <i>parentId</i>, quint64 <i>action</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#deleteFolder">deleteFolder</a></b> ( const QMailFolderId & <i>folderId</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#deleteFolder-2">deleteFolder</a></b> ( const QMailFolderId & <i>folderId</i>, quint64 <i>action</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#deleteMessages">deleteMessages</a></b> ( const QMailMessageIdList & <i>ids</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#deleteMessages-2">deleteMessages</a></b> ( const QMailMessageIdList & <i>ids</i>, quint64 <i>action</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#exportUpdates">exportUpdates</a></b> ( const QMailAccountId & <i>accountId</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#exportUpdates-2">exportUpdates</a></b> ( const QMailAccountId & <i>accountId</i>, quint64 <i>action</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#flagMessages">flagMessages</a></b> ( const QMailMessageIdList & <i>ids</i>, quint64 <i>setMask</i>, quint64 <i>unsetMask</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#flagMessages-2">flagMessages</a></b> ( const QMailMessageIdList & <i>ids</i>, quint64 <i>setMask</i>, quint64 <i>unsetMask</i>, quint64 <i>action</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#moveMessages">moveMessages</a></b> ( const QMailMessageIdList & <i>ids</i>, const QMailFolderId & <i>destinationId</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#moveMessages-2">moveMessages</a></b> ( const QMailMessageIdList & <i>ids</i>, const QMailFolderId & <i>destinationId</i>, quint64 <i>action</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#prepareMessages">prepareMessages</a></b> ( const QList<QPair<QMailMessagePart::Location, QMailMessagePart::Location> > & <i>ids</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#prepareMessages-2">prepareMessages</a></b> ( const QList<QPair<QMailMessagePart::Location, QMailMessagePart::Location> > & <i>ids</i>, quint64 <i>action</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#protocolRequest">protocolRequest</a></b> ( const QMailAccountId & <i>accountId</i>, const QString & <i>request</i>, const QVariant & <i>data</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#protocolRequest-2">protocolRequest</a></b> ( const QMailAccountId & <i>accountId</i>, const QString & <i>request</i>, const QVariant & <i>data</i>, quint64 <i>action</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#renameFolder">renameFolder</a></b> ( const QMailFolderId & <i>folderId</i>, const QString & <i>name</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#renameFolder-2">renameFolder</a></b> ( const QMailFolderId & <i>folderId</i>, const QString & <i>name</i>, quint64 <i>action</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#retrieveAll">retrieveAll</a></b> ( const QMailAccountId & <i>accountId</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#retrieveAll-2">retrieveAll</a></b> ( const QMailAccountId & <i>accountId</i>, quint64 <i>action</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#retrieveFolderList">retrieveFolderList</a></b> ( const QMailAccountId & <i>accountId</i>, const QMailFolderId & <i>folderId</i>, bool <i>descending</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#retrieveFolderList-2">retrieveFolderList</a></b> ( const QMailAccountId & <i>accountId</i>, const QMailFolderId & <i>folderId</i>, bool <i>descending</i>, quint64 <i>action</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#retrieveMessageList">retrieveMessageList</a></b> ( const QMailAccountId & <i>accountId</i>, const QMailFolderId & <i>folderId</i>, uint <i>minimum</i>, const QMailMessageSortKey & <i>sort</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#retrieveMessageList-2">retrieveMessageList</a></b> ( const QMailAccountId & <i>accountId</i>, const QMailFolderId & <i>folderId</i>, uint <i>minimum</i>, const QMailMessageSortKey & <i>sort</i>, quint64 <i>action</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#retrieveMessagePart">retrieveMessagePart</a></b> ( const QMailMessagePart::Location & <i>partLocation</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#retrieveMessagePart-2">retrieveMessagePart</a></b> ( const QMailMessagePart::Location & <i>partLocation</i>, quint64 <i>action</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#retrieveMessagePartRange">retrieveMessagePartRange</a></b> ( const QMailMessagePart::Location & <i>partLocation</i>, uint <i>minimum</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#retrieveMessagePartRange-2">retrieveMessagePartRange</a></b> ( const QMailMessagePart::Location & <i>partLocation</i>, uint <i>minimum</i>, quint64 <i>action</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#retrieveMessageRange">retrieveMessageRange</a></b> ( const QMailMessageId & <i>messageId</i>, uint <i>minimum</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#retrieveMessageRange-2">retrieveMessageRange</a></b> ( const QMailMessageId & <i>messageId</i>, uint <i>minimum</i>, quint64 <i>action</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#retrieveMessages">retrieveMessages</a></b> ( const QMailMessageIdList & <i>ids</i>, QMailRetrievalAction::RetrievalSpecification <i>spec</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#retrieveMessages-2">retrieveMessages</a></b> ( const QMailMessageIdList & <i>messageIds</i>, QMailRetrievalAction::RetrievalSpecification <i>spec</i>, quint64 <i>action</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#searchMessages">searchMessages</a></b> ( const QMailMessageKey & <i>searchCriteria</i>, const QString & <i>bodyText</i>, const QMailMessageSortKey & <i>sort</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#searchMessages-2">searchMessages</a></b> ( const QMailMessageKey & <i>filter</i>, const QString & <i>bodyText</i>, const QMailMessageSortKey & <i>sort</i>, quint64 <i>action</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#synchronize">synchronize</a></b> ( const QMailAccountId & <i>accountId</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#synchronize-2">synchronize</a></b> ( const QMailAccountId & <i>accountId</i>, quint64 <i>action</i> )</td></tr>
</table>
<ul>
<li><div bar="2" class="fn"></div>1 public slot inherited from <a href="http://doc.trolltech.com/4.5/qobject.html#public-slots">QObject</a></li>
</ul>
<hr />
<a name="signals"></a>
<h2>Signals</h2>
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#matchingMessageIds">matchingMessageIds</a></b> ( const QMailMessageIdList & <i>ids</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#matchingMessageIds-2">matchingMessageIds</a></b> ( const QMailMessageIdList & <i>ids</i>, quint64 <i>action</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#messagesCopied">messagesCopied</a></b> ( const QMailMessageIdList & <i>ids</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#messagesCopied-2">messagesCopied</a></b> ( const QMailMessageIdList & <i>ids</i>, quint64 <i>action</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#messagesDeleted">messagesDeleted</a></b> ( const QMailMessageIdList & <i>ids</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#messagesDeleted-2">messagesDeleted</a></b> ( const QMailMessageIdList & <i>ids</i>, quint64 <i>action</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#messagesFlagged">messagesFlagged</a></b> ( const QMailMessageIdList & <i>ids</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#messagesFlagged-2">messagesFlagged</a></b> ( const QMailMessageIdList & <i>ids</i>, quint64 <i>action</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#messagesMoved">messagesMoved</a></b> ( const QMailMessageIdList & <i>ids</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#messagesMoved-2">messagesMoved</a></b> ( const QMailMessageIdList & <i>ids</i>, quint64 <i>action</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#messagesPrepared">messagesPrepared</a></b> ( const QMailMessageIdList & <i>ids</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#messagesPrepared-2">messagesPrepared</a></b> ( const QMailMessageIdList & <i>ids</i>, quint64 <i>action</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#newMessagesAvailable">newMessagesAvailable</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#newMessagesAvailable-2">newMessagesAvailable</a></b> ( quint64 <i>action</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#protocolResponse">protocolResponse</a></b> ( const QString & <i>response</i>, const QVariant & <i>data</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#protocolResponse-2">protocolResponse</a></b> ( const QString & <i>response</i>, const QVariant & <i>data</i>, quint64 <i>action</i> )</td></tr>
</table>
<ul>
<li><div bar="2" class="fn"></div>1 signal inherited from <a href="http://doc.trolltech.com/4.5/qobject.html#signals">QObject</a></li>
</ul>
<hr />
<a name="protected-functions"></a>
<h2>Protected Functions</h2>
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#QMailMessageSource">QMailMessageSource</a></b> ( QMailMessageService * <i>service</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagesource.html#notImplemented">notImplemented</a></b> ( quint64 <i>action</i> )</td></tr>
</table>
<ul>
<li><div bar="2" class="fn"></div>7 protected functions inherited from <a href="http://doc.trolltech.com/4.5/qobject.html#protected-functions">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li><div class="fn"></div>1 property inherited from <a href="http://doc.trolltech.com/4.5/qobject.html#properties">QObject</a></li>
<li><div class="fn"></div>1 public type inherited from <a href="http://doc.trolltech.com/4.5/qobject.html#public-variables">QObject</a></li>
<li><div class="fn"></div>4 static public members inherited from <a href="http://doc.trolltech.com/4.5/qobject.html#static-public-members">QObject</a></li>
<li><div class="fn"></div>2 protected variables inherited from <a href="http://doc.trolltech.com/4.5/qobject.html#protected-variables">QObject</a></li>
</ul>
<a name="details"></a>
<hr />
<h2>Detailed Description</h2>
<p>The QMailMessageSource class defines the interface to objects that provide access to externally sourced messages to the messageserver.</p>
<p>The Qt Extended messageserver uses the QMailMessageSource interface to cooperate with components loaded from plugin libraries, that act as sources of messaging data for the messaging framework. Instances of QMailMessageSource are not created directly by the messageserver, but are exported by <a href="qmailmessageservice.html">QMailMessageService</a> objects via their <a href="qmailmessageservice.html#source">source</a> function.</p>
<p>See also <a href="qmailmessageservice.html">QMailMessageService</a> and <a href="qmailstore.html">QMailStore</a>.</p>
<hr />
<h2>Member Function Documentation</h2>
<h3 class="fn"><a name="QMailMessageSource"></a>QMailMessageSource::QMailMessageSource ( <a href="qmailmessageservice.html">QMailMessageService</a> * <i>service</i> ) <tt> [protected]</tt></h3>
<p>Creates a message source object associated with the service <i>service</i>.</p>
<h3 class="fn"><a name="cancelSearch"></a>bool QMailMessageSource::cancelSearch () <tt> [virtual slot]</tt></h3>
<p>This method is obsolete. It is no longer invoked. QMailMessageService::cancelOperation is used instead.</p>
<p>Previously was invoked by the message server to initiate a request to stop remote searching.</p>
<p>Searches in progress will be stopped, and no further results returned.</p>
<p>See also QMailMessageService::cancelOperation.</p>
<h3 class="fn"><a name="cancelSearch-2"></a>bool QMailMessageSource::cancelSearch ( <a href="http://doc.trolltech.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>action</i> ) <tt> [virtual slot]</tt></h3>
<h3 class="fn"><a name="copyMessages"></a>bool QMailMessageSource::copyMessages ( const <a href="qmailmessageid.html#QMailMessageIdList-typedef">QMailMessageIdList</a> & <i>ids</i>, const <a href="qmailfolderid.html">QMailFolderId</a> & <i>destinationId</i> ) <tt> [virtual slot]</tt></h3>
<p>Invoked by the message server to initiate a message copy operation.</p>
<p>For each message listed in <i>ids</i>, create a new copy in the folder identified by <i>destinationId</i>.</p>
<p>Successfully copied messages should be progressively reported via <a href="qmailmessagesource.html#messagesCopied">messagesCopied</a>().</p>
<p>Return true if an operation is initiated.</p>
<p>See also <a href="qmailmessagesource.html#messagesCopied">messagesCopied</a>().</p>
<h3 class="fn"><a name="copyMessages-2"></a>bool QMailMessageSource::copyMessages ( const <a href="qmailmessageid.html#QMailMessageIdList-typedef">QMailMessageIdList</a> & <i>ids</i>, const <a href="qmailfolderid.html">QMailFolderId</a> & <i>destinationId</i>, <a href="http://doc.trolltech.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>action</i> ) <tt> [virtual slot]</tt></h3>
<h3 class="fn"><a name="createFolder"></a>bool QMailMessageSource::createFolder ( const <a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> & <i>name</i>, const <a href="qmailaccountid.html">QMailAccountId</a> & <i>accountId</i>, const <a href="qmailfolderid.html">QMailFolderId</a> & <i>parentId</i> ) <tt> [virtual slot]</tt></h3>
<p>Invoked by the message server to create a new folder.</p>
<p>Creates a new folder named <i>name</i>, created in the account identified by <i>accountId</i>. If <i>parentId</i> is a valid folder identifier the new folder will be a child of the parent; otherwise the folder will be have no parent and will be created at the highest level.</p>
<p>Return true if an operation is initiated.</p>
<p>See also <a href="qmailmessagesource.html#deleteFolder">deleteFolder</a>().</p>
<h3 class="fn"><a name="createFolder-2"></a>bool QMailMessageSource::createFolder ( const <a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> & <i>name</i>, const <a href="qmailaccountid.html">QMailAccountId</a> & <i>accountId</i>, const <a href="qmailfolderid.html">QMailFolderId</a> & <i>parentId</i>, <a href="http://doc.trolltech.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>action</i> ) <tt> [virtual slot]</tt></h3>
<h3 class="fn"><a name="deleteFolder"></a>bool QMailMessageSource::deleteFolder ( const <a href="qmailfolderid.html">QMailFolderId</a> & <i>folderId</i> ) <tt> [virtual slot]</tt></h3>
<p>Invoked by the message server to delete a folder.</p>
<p>Deletes the folder identified by <i>folderId</i>. It is the responsibility of the message source to ensure all subfolders and messages are also deleted.</p>
<p>Return true if an operation is initiated.</p>
<p>See also <a href="qmailmessagesource.html#createFolder">createFolder</a>().</p>
<h3 class="fn"><a name="deleteFolder-2"></a>bool QMailMessageSource::deleteFolder ( const <a href="qmailfolderid.html">QMailFolderId</a> & <i>folderId</i>, <a href="http://doc.trolltech.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>action</i> ) <tt> [virtual slot]</tt></h3>
<h3 class="fn"><a name="deleteMessages"></a>bool QMailMessageSource::deleteMessages ( const <a href="qmailmessageid.html#QMailMessageIdList-typedef">QMailMessageIdList</a> & <i>ids</i> ) <tt> [virtual slot]</tt></h3>
<p>Invoked by the message server to initiate a message deletion operation.</p>
<p>Delete all messages listed in <i>ids</i> from the local mail store and the external server.</p>
<p>Return true if an operation is initiated.</p>
<p>See also <a href="qmailmessagesource.html#messagesDeleted">messagesDeleted</a>().</p>
<h3 class="fn"><a name="deleteMessages-2"></a>bool QMailMessageSource::deleteMessages ( const <a href="qmailmessageid.html#QMailMessageIdList-typedef">QMailMessageIdList</a> & <i>ids</i>, <a href="http://doc.trolltech.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>action</i> ) <tt> [virtual slot]</tt></h3>
<h3 class="fn"><a name="exportUpdates"></a>bool QMailMessageSource::exportUpdates ( const <a href="qmailaccountid.html">QMailAccountId</a> & <i>accountId</i> ) <tt> [virtual slot]</tt></h3>
<p>Invoked by the message server to initiate an export operation.</p>
<p>Update the external server with any changes to message status that have been effected on the local device for account <i>accountId</i>.</p>
<p>Return true if an operation is initiated.</p>
<p>See also <a href="qmailmessagesource.html#synchronize">synchronize</a>().</p>
<h3 class="fn"><a name="exportUpdates-2"></a>bool QMailMessageSource::exportUpdates ( const <a href="qmailaccountid.html">QMailAccountId</a> & <i>accountId</i>, <a href="http://doc.trolltech.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>action</i> ) <tt> [virtual slot]</tt></h3>
<h3 class="fn"><a name="flagMessages"></a>bool QMailMessageSource::flagMessages ( const <a href="qmailmessageid.html#QMailMessageIdList-typedef">QMailMessageIdList</a> & <i>ids</i>, <a href="http://doc.trolltech.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>setMask</i>, <a href="http://doc.trolltech.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>unsetMask</i> ) <tt> [virtual slot]</tt></h3>
<p>Invoked by the message server to initiate a message flag operation.</p>
<p>Modify each message listed in <i>ids</i> such that the status flags set in <i>setMask</i> are set, and the status flags set in <i>unsetMask</i> are unset. If further changes are implied by modification of the flags (including message movement or deletion), thse actions should also be performed by the service.</p>
<p>Successfully modified messages should be progressively reported via <a href="qmailmessagesource.html#messagesFlagged">messagesFlagged</a>().</p>
<p>Return true if an operation is initiated.</p>
<p>See also <a href="qmailmessagesource.html#messagesFlagged">messagesFlagged</a>().</p>
<h3 class="fn"><a name="flagMessages-2"></a>bool QMailMessageSource::flagMessages ( const <a href="qmailmessageid.html#QMailMessageIdList-typedef">QMailMessageIdList</a> & <i>ids</i>, <a href="http://doc.trolltech.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>setMask</i>, <a href="http://doc.trolltech.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>unsetMask</i>, <a href="http://doc.trolltech.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>action</i> ) <tt> [virtual slot]</tt></h3>
<h3 class="fn"><a name="matchingMessageIds"></a>void QMailMessageSource::matchingMessageIds ( const <a href="qmailmessageid.html#QMailMessageIdList-typedef">QMailMessageIdList</a> & <i>ids</i> ) <tt> [signal]</tt></h3>
<p>Signal emitted by the source to report the messages listed in <i>ids</i> as matching the current search.</p>
<h3 class="fn"><a name="matchingMessageIds-2"></a>void QMailMessageSource::matchingMessageIds ( const <a href="qmailmessageid.html#QMailMessageIdList-typedef">QMailMessageIdList</a> & <i>ids</i>, <a href="http://doc.trolltech.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>action</i> ) <tt> [signal]</tt></h3>
<h3 class="fn"><a name="messageRemovalOption"></a><a href="qmailstore.html#MessageRemovalOption-enum">QMailStore::MessageRemovalOption</a> QMailMessageSource::messageRemovalOption () const <tt> [virtual]</tt></h3>
<p>Returns the removal option used when deleting messages via this message source.</p>
<p>See also <a href="qmailstore.html#removeMessages">QMailStore::removeMessages</a>().</p>
<h3 class="fn"><a name="messagesCopied"></a>void QMailMessageSource::messagesCopied ( const <a href="qmailmessageid.html#QMailMessageIdList-typedef">QMailMessageIdList</a> & <i>ids</i> ) <tt> [signal]</tt></h3>
<p>Signal emitted by the source to report the copying of the messages listed in <i>ids</i>.</p>
<h3 class="fn"><a name="messagesCopied-2"></a>void QMailMessageSource::messagesCopied ( const <a href="qmailmessageid.html#QMailMessageIdList-typedef">QMailMessageIdList</a> & <i>ids</i>, <a href="http://doc.trolltech.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>action</i> ) <tt> [signal]</tt></h3>
<h3 class="fn"><a name="messagesDeleted"></a>void QMailMessageSource::messagesDeleted ( const <a href="qmailmessageid.html#QMailMessageIdList-typedef">QMailMessageIdList</a> & <i>ids</i> ) <tt> [signal]</tt></h3>
<p>Signal emitted by the source to report the deletion of the messages listed in <i>ids</i>.</p>
<h3 class="fn"><a name="messagesDeleted-2"></a>void QMailMessageSource::messagesDeleted ( const <a href="qmailmessageid.html#QMailMessageIdList-typedef">QMailMessageIdList</a> & <i>ids</i>, <a href="http://doc.trolltech.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>action</i> ) <tt> [signal]</tt></h3>
<h3 class="fn"><a name="messagesFlagged"></a>void QMailMessageSource::messagesFlagged ( const <a href="qmailmessageid.html#QMailMessageIdList-typedef">QMailMessageIdList</a> & <i>ids</i> ) <tt> [signal]</tt></h3>
<p>Signal emitted by the source to report the modification of the messages listed in <i>ids</i>.</p>
<h3 class="fn"><a name="messagesFlagged-2"></a>void QMailMessageSource::messagesFlagged ( const <a href="qmailmessageid.html#QMailMessageIdList-typedef">QMailMessageIdList</a> & <i>ids</i>, <a href="http://doc.trolltech.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>action</i> ) <tt> [signal]</tt></h3>
<h3 class="fn"><a name="messagesMoved"></a>void QMailMessageSource::messagesMoved ( const <a href="qmailmessageid.html#QMailMessageIdList-typedef">QMailMessageIdList</a> & <i>ids</i> ) <tt> [signal]</tt></h3>
<p>Signal emitted by the source to report the moving of the messages listed in <i>ids</i>.</p>
<h3 class="fn"><a name="messagesMoved-2"></a>void QMailMessageSource::messagesMoved ( const <a href="qmailmessageid.html#QMailMessageIdList-typedef">QMailMessageIdList</a> & <i>ids</i>, <a href="http://doc.trolltech.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>action</i> ) <tt> [signal]</tt></h3>
<h3 class="fn"><a name="messagesPrepared"></a>void QMailMessageSource::messagesPrepared ( const <a href="qmailmessageid.html#QMailMessageIdList-typedef">QMailMessageIdList</a> & <i>ids</i> ) <tt> [signal]</tt></h3>
<p>Signal emitted by the source to report the successful preparation for transmission of the messages listed in <i>ids</i>.</p>
<h3 class="fn"><a name="messagesPrepared-2"></a>void QMailMessageSource::messagesPrepared ( const <a href="qmailmessageid.html#QMailMessageIdList-typedef">QMailMessageIdList</a> & <i>ids</i>, <a href="http://doc.trolltech.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>action</i> ) <tt> [signal]</tt></h3>
<h3 class="fn"><a name="moveMessages"></a>bool QMailMessageSource::moveMessages ( const <a href="qmailmessageid.html#QMailMessageIdList-typedef">QMailMessageIdList</a> & <i>ids</i>, const <a href="qmailfolderid.html">QMailFolderId</a> & <i>destinationId</i> ) <tt> [virtual slot]</tt></h3>
<p>Invoked by the message server to initiate a message move operation.</p>
<p>Move each message listed in <i>ids</i> into the folder identified by <i>destinationId</i>.</p>
<p>Successfully moved messages should be progressively reported via <a href="qmailmessagesource.html#messagesMoved">messagesMoved</a>().</p>
<p>Return true if an operation is initiated.</p>
<p>See also <a href="qmailmessagesource.html#messagesMoved">messagesMoved</a>().</p>
<h3 class="fn"><a name="moveMessages-2"></a>bool QMailMessageSource::moveMessages ( const <a href="qmailmessageid.html#QMailMessageIdList-typedef">QMailMessageIdList</a> & <i>ids</i>, const <a href="qmailfolderid.html">QMailFolderId</a> & <i>destinationId</i>, <a href="http://doc.trolltech.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>action</i> ) <tt> [virtual slot]</tt></h3>
<h3 class="fn"><a name="newMessagesAvailable"></a>void QMailMessageSource::newMessagesAvailable () <tt> [signal]</tt></h3>
<p>Signal emitted by the source to report the availability of new messages.</p>
<h3 class="fn"><a name="newMessagesAvailable-2"></a>void QMailMessageSource::newMessagesAvailable ( <a href="http://doc.trolltech.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>action</i> ) <tt> [signal]</tt></h3>
<h3 class="fn"><a name="notImplemented"></a>void QMailMessageSource::notImplemented ( <a href="http://doc.trolltech.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>action</i> ) <tt> [protected]</tt></h3>
<h3 class="fn"><a name="prepareMessages"></a>bool QMailMessageSource::prepareMessages ( const <a href="http://doc.trolltech.com/4.5/qlist.html">QList</a><<a href="http://doc.trolltech.com/4.5/qpair.html">QPair</a><<a href="qmailmessagepartcontainer-location.html">QMailMessagePart::Location</a>, <a href="qmailmessagepartcontainer-location.html">QMailMessagePart::Location</a>> > & <i>ids</i> ) <tt> [virtual slot]</tt></h3>
<p>Invoked by the message server to initiate a message preparation operation.</p>
<p>Prepare each message listed in <i>ids</i> for transmission by resolving any external references into URLs, and updating the reference in the associated location.</p>
<p>Messages successfully prepared for transmission should be progressively reported via <a href="qmailmessagesource.html#messagesPrepared">messagesPrepared</a>().</p>
<p>Return true if an operation is initiated.</p>
<p>See also <a href="qmailmessagesource.html#messagesPrepared">messagesPrepared</a>().</p>
<h3 class="fn"><a name="prepareMessages-2"></a>bool QMailMessageSource::prepareMessages ( const <a href="http://doc.trolltech.com/4.5/qlist.html">QList</a><<a href="http://doc.trolltech.com/4.5/qpair.html">QPair</a><<a href="qmailmessagepartcontainer-location.html">QMailMessagePart::Location</a>, <a href="qmailmessagepartcontainer-location.html">QMailMessagePart::Location</a>> > & <i>ids</i>, <a href="http://doc.trolltech.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>action</i> ) <tt> [virtual slot]</tt></h3>
<h3 class="fn"><a name="protocolRequest"></a>bool QMailMessageSource::protocolRequest ( const <a href="qmailaccountid.html">QMailAccountId</a> & <i>accountId</i>, const <a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> & <i>request</i>, const <a href="http://doc.trolltech.com/4.5/qvariant.html">QVariant</a> & <i>data</i> ) <tt> [virtual slot]</tt></h3>
<p>Invoked by the message server to initiate a protocol-specific operation.</p>
<p>If <i>request</i> corresponds to a protocol-specific action implemented by the source, initiate the requested operation for <i>accountId</i>, using any relevant information extracted from <i>data</i>.</p>
<p>Any responses resulting from the action should be progressively reported via <a href="qmailmessagesource.html#protocolResponse">protocolResponse</a>().</p>
<p>Return true if an operation is initiated.</p>
<p>See also <a href="qmailmessagesource.html#protocolResponse">protocolResponse</a>().</p>
<h3 class="fn"><a name="protocolRequest-2"></a>bool QMailMessageSource::protocolRequest ( const <a href="qmailaccountid.html">QMailAccountId</a> & <i>accountId</i>, const <a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> & <i>request</i>, const <a href="http://doc.trolltech.com/4.5/qvariant.html">QVariant</a> & <i>data</i>, <a href="http://doc.trolltech.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>action</i> ) <tt> [virtual slot]</tt></h3>
<h3 class="fn"><a name="protocolResponse"></a>void QMailMessageSource::protocolResponse ( const <a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> & <i>response</i>, const <a href="http://doc.trolltech.com/4.5/qvariant.html">QVariant</a> & <i>data</i> ) <tt> [signal]</tt></h3>
<p>Signal emitted by the source to report the response <i>response</i> resulting from a protocol-specific request, with any associated <i>data</i>.</p>
<h3 class="fn"><a name="protocolResponse-2"></a>void QMailMessageSource::protocolResponse ( const <a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> & <i>response</i>, const <a href="http://doc.trolltech.com/4.5/qvariant.html">QVariant</a> & <i>data</i>, <a href="http://doc.trolltech.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>action</i> ) <tt> [signal]</tt></h3>
<h3 class="fn"><a name="renameFolder"></a>bool QMailMessageSource::renameFolder ( const <a href="qmailfolderid.html">QMailFolderId</a> & <i>folderId</i>, const <a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> & <i>name</i> ) <tt> [virtual slot]</tt></h3>
<p>Invoked by the message server to rename a folder.</p>
<p>Renames the folder identified by <i>folderId</i> to <i>name</i>. The location of the folder in the existing hierarchy should not change.</p>
<p>Return true if an operation is initiated.</p>
<p>See also <a href="qmailmessagesource.html#deleteFolder">deleteFolder</a>() and <a href="qmailmessagesource.html#createFolder">createFolder</a>().</p>
<h3 class="fn"><a name="renameFolder-2"></a>bool QMailMessageSource::renameFolder ( const <a href="qmailfolderid.html">QMailFolderId</a> & <i>folderId</i>, const <a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> & <i>name</i>, <a href="http://doc.trolltech.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>action</i> ) <tt> [virtual slot]</tt></h3>
<h3 class="fn"><a name="retrieveAll"></a>bool QMailMessageSource::retrieveAll ( const <a href="qmailaccountid.html">QMailAccountId</a> & <i>accountId</i> ) <tt> [virtual slot]</tt></h3>
<p>Invoked by the message server to initiate a retrieval operation.</p>
<p>Retrieve all folders and meta data for all messages available for the account <i>accountId</i>.</p>
<p>All folders within the account should be discovered and searched for child folders. The <a href="qmailfolder.html#serverCount">QMailFolder::serverCount</a>(), <a href="qmailfolder.html#serverUnreadCount">QMailFolder::serverUnreadCount</a>() and <a href="qmailfolder.html#serverUndiscoveredCount">QMailFolder::serverUndiscoveredCount</a>() properties should be updated for each folder in the account, and the lastSynchronized() time of the account updated.</p>
<p>New messages should be added to the mail store in meta data form as they are discovered, and marked with the <a href="qmailmessagemetadata.html#New-var">QMailMessage::New</a> status flag. Messages that are present in the mail store but found to be no longer available should be marked with the <a href="qmailmessagemetadata.html#Removed-var">QMailMessage::Removed</a> status flag.</p>
<p>Return true if an operation is initiated.</p>
<p>See also <a href="qmailaccount.html#lastSynchronized">QMailAccount::lastSynchronized</a>(), <a href="qmailmessagesource.html#retrieveFolderList">retrieveFolderList</a>(), <a href="qmailmessagesource.html#retrieveMessageList">retrieveMessageList</a>(), and <a href="qmailmessagesource.html#synchronize">synchronize</a>().</p>
<h3 class="fn"><a name="retrieveAll-2"></a>bool QMailMessageSource::retrieveAll ( const <a href="qmailaccountid.html">QMailAccountId</a> & <i>accountId</i>, <a href="http://doc.trolltech.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>action</i> ) <tt> [virtual slot]</tt></h3>
<h3 class="fn"><a name="retrieveFolderList"></a>bool QMailMessageSource::retrieveFolderList ( const <a href="qmailaccountid.html">QMailAccountId</a> & <i>accountId</i>, const <a href="qmailfolderid.html">QMailFolderId</a> & <i>folderId</i>, bool <i>descending</i> ) <tt> [virtual slot]</tt></h3>
<p>Retrieve the list of folders available for the account <i>accountId</i>. If <i>folderId</i> is valid, only the identified folder is searched for child folders; otherwise the search begins at the root of the account. If <i>descending</i> is true, the search should also recursively search for child folders within folders discovered during the search.</p>
<p>The <a href="qmailfolder.html#serverCount">QMailFolder::serverCount</a>(), <a href="qmailfolder.html#serverUnreadCount">QMailFolder::serverUnreadCount</a>() and <a href="qmailfolder.html#serverUndiscoveredCount">QMailFolder::serverUndiscoveredCount</a>() properties will be updated for each folder that is searched for child folders; these properties are not updated for folders that are merely discovered by searching.</p>
<p>Return true if an operation is initiated.</p>
<p>See also <a href="qmailmessagesource.html#retrieveMessageList">retrieveMessageList</a>().</p>
<h3 class="fn"><a name="retrieveFolderList-2"></a>bool QMailMessageSource::retrieveFolderList ( const <a href="qmailaccountid.html">QMailAccountId</a> & <i>accountId</i>, const <a href="qmailfolderid.html">QMailFolderId</a> & <i>folderId</i>, bool <i>descending</i>, <a href="http://doc.trolltech.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>action</i> ) <tt> [virtual slot]</tt></h3>
<h3 class="fn"><a name="retrieveMessageList"></a>bool QMailMessageSource::retrieveMessageList ( const <a href="qmailaccountid.html">QMailAccountId</a> & <i>accountId</i>, const <a href="qmailfolderid.html">QMailFolderId</a> & <i>folderId</i>, <a href="http://doc.trolltech.com/4.5/qtglobal.html#uint-typedef">uint</a> <i>minimum</i>, const <a href="qmailmessagesortkey.html">QMailMessageSortKey</a> & <i>sort</i> ) <tt> [virtual slot]</tt></h3>
<p>Retrieve the list of messages available for the account <i>accountId</i>. If <i>folderId</i> is valid, then only messages within that folder should be retrieved; otherwise messages within all folders in the account should be retrieved, and the lastSynchronized() time of the account updated. If <i>minimum</i> is non-zero, then that value will be used to restrict the number of messages to be retrieved from each folder; otherwise, all messages will be retrieved.</p>
<p>If <i>sort</i> is not empty, the external service will report the discovered messages in the ordering indicated by the sort criterion, if possible. Services are not required to support this facility.</p>
<p>If a folder messages are being retrieved from contains at least <i>minimum</i> messages then the messageserver should ensure that at least <i>minimum</i> messages are available from the mail store for that folder; otherwise if the folder contains less than <i>minimum</i> messages the messageserver should ensure all the messages for that folder are available from the mail store. If a folder has messages locally available, then all previously undiscovered messages will be retrieved for that folder, even if that number exceeds <i>minimum</i>.</p>
<p>The <a href="qmailfolder.html#serverCount">QMailFolder::serverCount</a>(), <a href="qmailfolder.html#serverUnreadCount">QMailFolder::serverUnreadCount</a>() and <a href="qmailfolder.html#serverUndiscoveredCount">QMailFolder::serverUndiscoveredCount</a>() properties will be updated for each folder from which messages are retrieved.</p>
<p>New messages will be added to the mail store as they are discovered, and marked with the <a href="qmailmessagemetadata.html#New-var">QMailMessage::New</a> status flag. Messages that are present in the mail store but found to be no longer available are marked with the <a href="qmailmessagemetadata.html#Removed-var">QMailMessage::Removed</a> status flag.</p>
<p>Return true if an operation is initiated.</p>
<p>See also <a href="qmailaccount.html#lastSynchronized">QMailAccount::lastSynchronized</a>().</p>
<h3 class="fn"><a name="retrieveMessageList-2"></a>bool QMailMessageSource::retrieveMessageList ( const <a href="qmailaccountid.html">QMailAccountId</a> & <i>accountId</i>, const <a href="qmailfolderid.html">QMailFolderId</a> & <i>folderId</i>, <a href="http://doc.trolltech.com/4.5/qtglobal.html#uint-typedef">uint</a> <i>minimum</i>, const <a href="qmailmessagesortkey.html">QMailMessageSortKey</a> & <i>sort</i>, <a href="http://doc.trolltech.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>action</i> ) <tt> [virtual slot]</tt></h3>
<h3 class="fn"><a name="retrieveMessagePart"></a>bool QMailMessageSource::retrieveMessagePart ( const <a href="qmailmessagepartcontainer-location.html">QMailMessagePart::Location</a> & <i>partLocation</i> ) <tt> [virtual slot]</tt></h3>
<p>Invoked by the message server to initiate a message part retrieval operation.</p>
<p>Retrieve the content of the message part indicated by the location <i>partLocation</i>.</p>
<p>The <a href="qmailfolder.html#serverCount">QMailFolder::serverCount</a>(), <a href="qmailfolder.html#serverUnreadCount">QMailFolder::serverUnreadCount</a>() and <a href="qmailfolder.html#serverUndiscoveredCount">QMailFolder::serverUndiscoveredCount</a>() properties should be updated for the folder from which the part is retrieved.</p>
<p>Return true if an operation is initiated.</p>
<h3 class="fn"><a name="retrieveMessagePart-2"></a>bool QMailMessageSource::retrieveMessagePart ( const <a href="qmailmessagepartcontainer-location.html">QMailMessagePart::Location</a> & <i>partLocation</i>, <a href="http://doc.trolltech.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>action</i> ) <tt> [virtual slot]</tt></h3>
<h3 class="fn"><a name="retrieveMessagePartRange"></a>bool QMailMessageSource::retrieveMessagePartRange ( const <a href="qmailmessagepartcontainer-location.html">QMailMessagePart::Location</a> & <i>partLocation</i>, <a href="http://doc.trolltech.com/4.5/qtglobal.html#uint-typedef">uint</a> <i>minimum</i> ) <tt> [virtual slot]</tt></h3>
<p>Invoked by the message server to initiate a message part range retrieval operation.</p>
<p>Retrieve a portion of the content of the message part indicated by the location <i>partLocation</i>, ensuring that at least <i>minimum</i> bytes are available in the mail store.</p>
<p>The <a href="qmailfolder.html#serverCount">QMailFolder::serverCount</a>(), <a href="qmailfolder.html#serverUnreadCount">QMailFolder::serverUnreadCount</a>() and <a href="qmailfolder.html#serverUndiscoveredCount">QMailFolder::serverUndiscoveredCount</a>() properties should be updated for the folder from which the part is retrieved.</p>
<p>Return true if an operation is initiated.</p>
<h3 class="fn"><a name="retrieveMessagePartRange-2"></a>bool QMailMessageSource::retrieveMessagePartRange ( const <a href="qmailmessagepartcontainer-location.html">QMailMessagePart::Location</a> & <i>partLocation</i>, <a href="http://doc.trolltech.com/4.5/qtglobal.html#uint-typedef">uint</a> <i>minimum</i>, <a href="http://doc.trolltech.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>action</i> ) <tt> [virtual slot]</tt></h3>
<h3 class="fn"><a name="retrieveMessageRange"></a>bool QMailMessageSource::retrieveMessageRange ( const <a href="qmailmessageid.html">QMailMessageId</a> & <i>messageId</i>, <a href="http://doc.trolltech.com/4.5/qtglobal.html#uint-typedef">uint</a> <i>minimum</i> ) <tt> [virtual slot]</tt></h3>
<p>Invoked by the message server to initiate a message range retrieval operation.</p>
<p>Retrieve a portion of the content of the message identified by <i>messageId</i>, ensuring that at least <i>minimum</i> bytes are available in the mail store.</p>
<p>The <a href="qmailfolder.html#serverCount">QMailFolder::serverCount</a>(), <a href="qmailfolder.html#serverUnreadCount">QMailFolder::serverUnreadCount</a>() and <a href="qmailfolder.html#serverUndiscoveredCount">QMailFolder::serverUndiscoveredCount</a>() properties should be updated for the folder from which the message is retrieved.</p>
<p>Return true if an operation is initiated.</p>
<h3 class="fn"><a name="retrieveMessageRange-2"></a>bool QMailMessageSource::retrieveMessageRange ( const <a href="qmailmessageid.html">QMailMessageId</a> & <i>messageId</i>, <a href="http://doc.trolltech.com/4.5/qtglobal.html#uint-typedef">uint</a> <i>minimum</i>, <a href="http://doc.trolltech.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>action</i> ) <tt> [virtual slot]</tt></h3>
<h3 class="fn"><a name="retrieveMessages"></a>bool QMailMessageSource::retrieveMessages ( const <a href="qmailmessageid.html#QMailMessageIdList-typedef">QMailMessageIdList</a> & <i>ids</i>, <a href="qmailretrievalaction.html#RetrievalSpecification-enum">QMailRetrievalAction::RetrievalSpecification</a> <i>spec</i> ) <tt> [virtual slot]</tt></h3>
<p>Invoked by the message server to initiate a message retrieval operation.</p>
<p>Retrieve data regarding each of the messages listed in <i>ids</i>.</p>
<p>If <i>spec</i> is <a href="qmailretrievalaction.html#RetrievalSpecification-enum">QMailRetrievalAction::Flags</a>, then the message server should detect if the messages identified by <i>ids</i> have been marked as read or have been removed. Messages that have been read will be marked with the <a href="qmailmessagemetadata.html#ReadElsewhere-var">QMailMessage::ReadElsewhere</a> flag, and messages that have been removed will be marked with the <a href="qmailmessagemetadata.html#Removed-var">QMailMessage::Removed</a> status flag.</p>
<p>If <i>spec</i> is <a href="qmailretrievalaction.html#RetrievalSpecification-enum">QMailRetrievalAction::MetaData</a>, then the message server should retrieve the meta data of the each message listed in <i>ids</i>.</p>
<p>If <i>spec</i> is <a href="qmailretrievalaction.html#RetrievalSpecification-enum">QMailRetrievalAction::Content</a>, then the message server should retrieve the entirety of each message listed in <i>ids</i>.</p>
<p>The <a href="qmailfolder.html#serverCount">QMailFolder::serverCount</a>(), <a href="qmailfolder.html#serverUnreadCount">QMailFolder::serverUnreadCount</a>() and <a href="qmailfolder.html#serverUndiscoveredCount">QMailFolder::serverUndiscoveredCount</a>() properties should be updated for each folder from which messages are retrieved.</p>
<p>Return true if an operation is initiated.</p>
<h3 class="fn"><a name="retrieveMessages-2"></a>bool QMailMessageSource::retrieveMessages ( const <a href="qmailmessageid.html#QMailMessageIdList-typedef">QMailMessageIdList</a> & <i>messageIds</i>, <a href="qmailretrievalaction.html#RetrievalSpecification-enum">QMailRetrievalAction::RetrievalSpecification</a> <i>spec</i>, <a href="http://doc.trolltech.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>action</i> ) <tt> [virtual slot]</tt></h3>
<h3 class="fn"><a name="searchMessages"></a>bool QMailMessageSource::searchMessages ( const <a href="qmailmessagekey.html">QMailMessageKey</a> & <i>searchCriteria</i>, const <a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> & <i>bodyText</i>, const <a href="qmailmessagesortkey.html">QMailMessageSortKey</a> & <i>sort</i> ) <tt> [virtual slot]</tt></h3>
<p>Invoked by the message server to initiate a remote message search operation.</p>
<p>Search the remote server for messages that match the search criteria encoded by <i>searchCriteria</i>. If <i>bodyText</i> is non-empty, matching messages must also contain the specified string. Messages whose content is already present on the local device should be excluded from the remote search.</p>
<p>If <i>sort</i> is not empty, matched messages should be discovered by testing for matches in the ordering indicated by the sort criterion, if possible.</p>
<p>Messages matching the search criteria should be added to the mail store in meta data form marked with the <a href="qmailmessagemetadata.html#New-var">QMailMessage::New</a> status flag, and progressively reported via <a href="qmailmessagesource.html#matchingMessageIds">matchingMessageIds</a>().</p>
<p>Return true if a search operation is initiated.</p>
<p>See also <a href="qmailmessagesource.html#matchingMessageIds">matchingMessageIds</a>() and <a href="qmailmessagesource.html#retrieveMessages">retrieveMessages</a>().</p>
<h3 class="fn"><a name="searchMessages-2"></a>bool QMailMessageSource::searchMessages ( const <a href="qmailmessagekey.html">QMailMessageKey</a> & <i>filter</i>, const <a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> & <i>bodyText</i>, const <a href="qmailmessagesortkey.html">QMailMessageSortKey</a> & <i>sort</i>, <a href="http://doc.trolltech.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>action</i> ) <tt> [virtual slot]</tt></h3>
<h3 class="fn"><a name="synchronize"></a>bool QMailMessageSource::synchronize ( const <a href="qmailaccountid.html">QMailAccountId</a> & <i>accountId</i> ) <tt> [virtual slot]</tt></h3>
<p>Invoked by the message server to initiate a synchronization operation.</p>
<p>Synchronize the set of known folder and message identifiers with those currently available for the account identified by <i>accountId</i>. Newly discovered messages should have their meta data retrieved, and local changes to message status should be exported to the external server.</p>
<p>New messages should be added to the mail store in meta data form as they are discovered, and marked with the <a href="qmailmessagemetadata.html#New-var">QMailMessage::New</a> status flag. Messages that are present in the mail store but found to be no longer available should be marked with the <a href="qmailmessagemetadata.html#Removed-var">QMailMessage::Removed</a> status flag.</p>
<p>The folder structure of the account should be synchronized with that available from the external service. The <a href="qmailfolder.html#serverCount">QMailFolder::serverCount</a>(), <a href="qmailfolder.html#serverUnreadCount">QMailFolder::serverUnreadCount</a>() and <a href="qmailfolder.html#serverUndiscoveredCount">QMailFolder::serverUndiscoveredCount</a>() properties should be updated for each folder, and the lastSynchronized() time of the account updated.</p>
<p>Return true if an operation is initiated.</p>
<p>See also <a href="qmailaccount.html#lastSynchronized">QMailAccount::lastSynchronized</a>(), <a href="qmailmessagesource.html#retrieveAll">retrieveAll</a>(), and <a href="qmailmessagesource.html#exportUpdates">exportUpdates</a>().</p>
<h3 class="fn"><a name="synchronize-2"></a>bool QMailMessageSource::synchronize ( const <a href="qmailaccountid.html">QMailAccountId</a> & <i>accountId</i>, <a href="http://doc.trolltech.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>action</i> ) <tt> [virtual slot]</tt></h3>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td align="left">Copyright © 2010 QtSoftware</td>
<td align="right"><div align="right">Messaging Framework</div></td>
</tr></table></div></address></body>
</html>
|
