evolution-data-server-doc 3.28.1-1ubuntu1 / usr / share / gtk-doc / html / camel / camel-CamelIMAPXFolder.html

This file is indexed.

/usr/share/gtk-doc/html/camel/camel-CamelIMAPXFolder.html is in evolution-data-server-doc 3.28.1-1ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CamelIMAPXFolder: Camel Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Camel Reference Manual">
<link rel="up" href="IMAP.html" title="IMAP Service">
<link rel="prev" href="camel-CamelIMAPXConnManager.html" title="CamelIMAPXConnManager">
<link rel="next" href="camel-CamelIMAPXInputStream.html" title="CamelIMAPXInputStream">
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#camel-CamelIMAPXFolder.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="IMAP.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="camel-CamelIMAPXConnManager.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="camel-CamelIMAPXInputStream.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="camel-CamelIMAPXFolder"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="camel-CamelIMAPXFolder.top_of_page"></a>CamelIMAPXFolder</span></h2>
<p>CamelIMAPXFolder</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="camel-CamelIMAPXFolder.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">CamelFolder</span> *
</td>
<td class="function_name">
<a class="link" href="camel-CamelIMAPXFolder.html#camel-imapx-folder-new" title="camel_imapx_folder_new ()">camel_imapx_folder_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="camel-CamelIMAPXMailbox.html#CamelIMAPXMailbox" title="struct CamelIMAPXMailbox"><span class="returnvalue">CamelIMAPXMailbox</span></a> *
</td>
<td class="function_name">
<a class="link" href="camel-CamelIMAPXFolder.html#camel-imapx-folder-ref-mailbox" title="camel_imapx_folder_ref_mailbox ()">camel_imapx_folder_ref_mailbox</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="camel-CamelIMAPXFolder.html#camel-imapx-folder-set-mailbox" title="camel_imapx_folder_set_mailbox ()">camel_imapx_folder_set_mailbox</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="camel-CamelIMAPXMailbox.html#CamelIMAPXMailbox" title="struct CamelIMAPXMailbox"><span class="returnvalue">CamelIMAPXMailbox</span></a> *
</td>
<td class="function_name">
<a class="link" href="camel-CamelIMAPXFolder.html#camel-imapx-folder-list-mailbox" title="camel_imapx_folder_list_mailbox ()">camel_imapx_folder_list_mailbox</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Sequences.html#GSequence"><span class="returnvalue">GSequence</span></a> *
</td>
<td class="function_name">
<a class="link" href="camel-CamelIMAPXFolder.html#camel-imapx-folder-copy-message-map" title="camel_imapx_folder_copy_message_map ()">camel_imapx_folder_copy_message_map</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="camel-CamelIMAPXFolder.html#camel-imapx-folder-add-move-to-real-junk" title="camel_imapx_folder_add_move_to_real_junk ()">camel_imapx_folder_add_move_to_real_junk</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="camel-CamelIMAPXFolder.html#camel-imapx-folder-add-move-to-real-trash" title="camel_imapx_folder_add_move_to_real_trash ()">camel_imapx_folder_add_move_to_real_trash</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="camel-CamelIMAPXFolder.html#camel-imapx-folder-add-move-to-inbox" title="camel_imapx_folder_add_move_to_inbox ()">camel_imapx_folder_add_move_to_inbox</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="camel-CamelIMAPXFolder.html#camel-imapx-folder-invalidate-local-cache" title="camel_imapx_folder_invalidate_local_cache ()">camel_imapx_folder_invalidate_local_cache</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="camel-CamelIMAPXFolder.html#camel-imapx-folder-get-check-folder" title="camel_imapx_folder_get_check_folder ()">camel_imapx_folder_get_check_folder</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="camel-CamelIMAPXFolder.html#camel-imapx-folder-set-check-folder" title="camel_imapx_folder_set_check_folder ()">camel_imapx_folder_set_check_folder</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="camel-CamelIMAPXFolder.html#camel-imapx-folder-claim-move-to-real-junk-uids" title="camel_imapx_folder_claim_move_to_real_junk_uids ()">camel_imapx_folder_claim_move_to_real_junk_uids</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="camel-CamelIMAPXFolder.html#camel-imapx-folder-claim-move-to-real-trash-uids" title="camel_imapx_folder_claim_move_to_real_trash_uids ()">camel_imapx_folder_claim_move_to_real_trash_uids</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="camel-CamelIMAPXFolder.html#camel-imapx-folder-claim-move-to-inbox-uids" title="camel_imapx_folder_claim_move_to_inbox_uids ()">camel_imapx_folder_claim_move_to_inbox_uids</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="camel-CamelIMAPXFolder.html#camel-imapx-folder-update-cache-expire" title="camel_imapx_folder_update_cache_expire ()">camel_imapx_folder_update_cache_expire</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="camel-CamelIMAPXFolder.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="camel-CamelIMAPXFolder.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="camel-imapx-folder-new"></a><h3>camel_imapx_folder_new ()</h3>
<pre class="programlisting"><span class="returnvalue">CamelFolder</span> *
camel_imapx_folder_new (<em class="parameter"><code><span class="type">CamelStore</span> *parent</code></em>,
                        <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>,
                        <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *raw</code></em>,
                        <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="camel-imapx-folder-ref-mailbox"></a><h3>camel_imapx_folder_ref_mailbox ()</h3>
<pre class="programlisting"><a class="link" href="camel-CamelIMAPXMailbox.html#CamelIMAPXMailbox" title="struct CamelIMAPXMailbox"><span class="returnvalue">CamelIMAPXMailbox</span></a> *
camel_imapx_folder_ref_mailbox (<em class="parameter"><code><span class="type">CamelIMAPXFolder</span> *folder</code></em>);</pre>
<p>Returns the <a class="link" href="camel-CamelIMAPXMailbox.html#CamelIMAPXMailbox" title="struct CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> for <em class="parameter"><code>folder</code></em>
 from the current IMAP server
connection, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>folder</code></em>
's <span class="type">“parent-store”</span> is disconnected
from the IMAP server.</p>
<p>The returned <a class="link" href="camel-CamelIMAPXMailbox.html#CamelIMAPXMailbox" title="struct CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> is referenced for thread-safety and
should be unreferenced with <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when finished with it.</p>
<div class="refsect3">
<a name="camel-imapx-folder-ref-mailbox.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>folder</p></td>
<td class="parameter_description"><p>a <span class="type">CamelIMAPXFolder</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="camel-imapx-folder-ref-mailbox.returns"></a><h4>Returns</h4>
<p> a <a class="link" href="camel-CamelIMAPXMailbox.html#CamelIMAPXMailbox" title="struct CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-12.html#api-index-3.12">3.12</a></p>
</div>
<hr>
<div class="refsect2">
<a name="camel-imapx-folder-set-mailbox"></a><h3>camel_imapx_folder_set_mailbox ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
camel_imapx_folder_set_mailbox (<em class="parameter"><code><span class="type">CamelIMAPXFolder</span> *folder</code></em>,
                                <em class="parameter"><code><a class="link" href="camel-CamelIMAPXMailbox.html#CamelIMAPXMailbox" title="struct CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>);</pre>
<p>Sets the <a class="link" href="camel-CamelIMAPXMailbox.html#CamelIMAPXMailbox" title="struct CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> for <em class="parameter"><code>folder</code></em>
 from the current IMAP server
connection.  Note that <span class="type">CamelIMAPXFolder</span> only holds a weak reference
on its <a class="link" href="camel-CamelIMAPXMailbox.html#CamelIMAPXMailbox" title="struct CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> so that when the IMAP server connection is
lost, all mailbox instances are automatically destroyed.</p>
<div class="refsect3">
<a name="camel-imapx-folder-set-mailbox.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>folder</p></td>
<td class="parameter_description"><p>a <span class="type">CamelIMAPXFolder</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>mailbox</p></td>
<td class="parameter_description"><p>a <a class="link" href="camel-CamelIMAPXMailbox.html#CamelIMAPXMailbox" title="struct CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-12.html#api-index-3.12">3.12</a></p>
</div>
<hr>
<div class="refsect2">
<a name="camel-imapx-folder-list-mailbox"></a><h3>camel_imapx_folder_list_mailbox ()</h3>
<pre class="programlisting"><a class="link" href="camel-CamelIMAPXMailbox.html#CamelIMAPXMailbox" title="struct CamelIMAPXMailbox"><span class="returnvalue">CamelIMAPXMailbox</span></a> *
camel_imapx_folder_list_mailbox (<em class="parameter"><code><span class="type">CamelIMAPXFolder</span> *folder</code></em>,
                                 <em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>,
                                 <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Ensures that <em class="parameter"><code>folder</code></em>
's <span class="type">“mailbox”</span> property is set,
going so far as to issue a LIST command if necessary (but should
be a rarely needed last resort).</p>
<p>If <em class="parameter"><code>folder</code></em>
's <span class="type">“parent-store”</span> is disconnected from the IMAP
server or an error occurs during the LIST command, the function sets
<em class="parameter"><code>error</code></em>
 and returns <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
<p>The returned <a class="link" href="camel-CamelIMAPXMailbox.html#CamelIMAPXMailbox" title="struct CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> is referenced for thread-safety and
should be unreferenced with <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when finished with it.</p>
<div class="refsect3">
<a name="camel-imapx-folder-list-mailbox.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>folder</p></td>
<td class="parameter_description"><p>a <span class="type">CamelIMAPXFolder</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>optional <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> object, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="camel-imapx-folder-list-mailbox.returns"></a><h4>Returns</h4>
<p> a <a class="link" href="camel-CamelIMAPXMailbox.html#CamelIMAPXMailbox" title="struct CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-12.html#api-index-3.12">3.12</a></p>
</div>
<hr>
<div class="refsect2">
<a name="camel-imapx-folder-copy-message-map"></a><h3>camel_imapx_folder_copy_message_map ()</h3>
<pre class="programlisting"><a href="../glib/glib-Sequences.html#GSequence"><span class="returnvalue">GSequence</span></a> *
camel_imapx_folder_copy_message_map (<em class="parameter"><code><span class="type">CamelIMAPXFolder</span> *folder</code></em>);</pre>
<p>Returns a <a href="../glib/glib-Sequences.html#GSequence"><span class="type">GSequence</span></a> of 32-bit integers representing the locally cached
mapping of message sequence numbers to unique identifiers.</p>
<p>Free the returns <a href="../glib/glib-Sequences.html#GSequence"><span class="type">GSequence</span></a> with <a href="../glib/glib-Sequences.html#g-sequence-free"><code class="function">g_sequence_free()</code></a>.</p>
<div class="refsect3">
<a name="camel-imapx-folder-copy-message-map.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>folder</p></td>
<td class="parameter_description"><p>a <span class="type">CamelIMAPXFolder</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="camel-imapx-folder-copy-message-map.returns"></a><h4>Returns</h4>
<p> a <a href="../glib/glib-Sequences.html#GSequence"><span class="type">GSequence</span></a></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-12.html#api-index-3.12">3.12</a></p>
</div>
<hr>
<div class="refsect2">
<a name="camel-imapx-folder-add-move-to-real-junk"></a><h3>camel_imapx_folder_add_move_to_real_junk ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
camel_imapx_folder_add_move_to_real_junk
                               (<em class="parameter"><code><span class="type">CamelIMAPXFolder</span> *folder</code></em>,
                                <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *message_uid</code></em>);</pre>
<p>Adds <em class="parameter"><code>message_uid</code></em>
 to a pool of messages to be moved to a real junk
folder the next time <em class="parameter"><code>folder</code></em>
 is explicitly synchronized by way of
<a class="link" href="camel-CamelFolder.html#camel-folder-synchronize" title="camel_folder_synchronize ()"><code class="function">camel_folder_synchronize()</code></a> or <a class="link" href="camel-CamelFolder.html#camel-folder-synchronize-sync" title="camel_folder_synchronize_sync ()"><code class="function">camel_folder_synchronize_sync()</code></a>.</p>
<p>This only applies when using a real folder to track junk messages,
as specified by the <span class="type">“use-real-junk-path”</span> setting.</p>
<div class="refsect3">
<a name="camel-imapx-folder-add-move-to-real-junk.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>folder</p></td>
<td class="parameter_description"><p>a <span class="type">CamelIMAPXFolder</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>message_uid</p></td>
<td class="parameter_description"><p>a message UID</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-8.html#api-index-3.8">3.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="camel-imapx-folder-add-move-to-real-trash"></a><h3>camel_imapx_folder_add_move_to_real_trash ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
camel_imapx_folder_add_move_to_real_trash
                               (<em class="parameter"><code><span class="type">CamelIMAPXFolder</span> *folder</code></em>,
                                <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *message_uid</code></em>);</pre>
<p>Adds <em class="parameter"><code>message_uid</code></em>
 to a pool of messages to be moved to a real trash
folder the next time <em class="parameter"><code>folder</code></em>
 is explicitly synchronized by way of
<a class="link" href="camel-CamelFolder.html#camel-folder-synchronize" title="camel_folder_synchronize ()"><code class="function">camel_folder_synchronize()</code></a> or <a class="link" href="camel-CamelFolder.html#camel-folder-synchronize-sync" title="camel_folder_synchronize_sync ()"><code class="function">camel_folder_synchronize_sync()</code></a>.</p>
<p>This only applies when using a real folder to track deleted messages,
as specified by the <span class="type">“use-real-trash-path”</span> setting.</p>
<div class="refsect3">
<a name="camel-imapx-folder-add-move-to-real-trash.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>folder</p></td>
<td class="parameter_description"><p>a <span class="type">CamelIMAPXFolder</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>message_uid</p></td>
<td class="parameter_description"><p>a message UID</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-8.html#api-index-3.8">3.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="camel-imapx-folder-add-move-to-inbox"></a><h3>camel_imapx_folder_add_move_to_inbox ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
camel_imapx_folder_add_move_to_inbox (<em class="parameter"><code><span class="type">CamelIMAPXFolder</span> *folder</code></em>,
                                      <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *message_uid</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="camel-imapx-folder-invalidate-local-cache"></a><h3>camel_imapx_folder_invalidate_local_cache ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
camel_imapx_folder_invalidate_local_cache
                               (<em class="parameter"><code><span class="type">CamelIMAPXFolder</span> *folder</code></em>,
                                <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> new_uidvalidity</code></em>);</pre>
<p>Call this function when the IMAP server reports a different UIDVALIDITY
value than what is presently cached.  This means all cached message UIDs
are now invalid and must be discarded.</p>
<p>The local cache for <em class="parameter"><code>folder</code></em>
 is reset and the <em class="parameter"><code>new_uidvalidity</code></em>
 value is
recorded in the newly-reset cache.</p>
<div class="refsect3">
<a name="camel-imapx-folder-invalidate-local-cache.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>folder</p></td>
<td class="parameter_description"><p>a <span class="type">CamelIMAPXFolder</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>new_uidvalidity</p></td>
<td class="parameter_description"><p>the new UIDVALIDITY value</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-10.html#api-index-3.10">3.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="camel-imapx-folder-get-check-folder"></a><h3>camel_imapx_folder_get_check_folder ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
camel_imapx_folder_get_check_folder (<em class="parameter"><code><span class="type">CamelIMAPXFolder</span> *folder</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="camel-imapx-folder-set-check-folder"></a><h3>camel_imapx_folder_set_check_folder ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
camel_imapx_folder_set_check_folder (<em class="parameter"><code><span class="type">CamelIMAPXFolder</span> *folder</code></em>,
                                     <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> check_folder</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="camel-imapx-folder-claim-move-to-real-junk-uids"></a><h3>camel_imapx_folder_claim_move_to_real_junk_uids ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
camel_imapx_folder_claim_move_to_real_junk_uids
                               (<em class="parameter"><code><span class="type">CamelIMAPXFolder</span> *folder</code></em>,
                                <em class="parameter"><code><a href="../glib/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> *out_uids_to_copy</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="camel-imapx-folder-claim-move-to-real-trash-uids"></a><h3>camel_imapx_folder_claim_move_to_real_trash_uids ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
camel_imapx_folder_claim_move_to_real_trash_uids
                               (<em class="parameter"><code><span class="type">CamelIMAPXFolder</span> *folder</code></em>,
                                <em class="parameter"><code><a href="../glib/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> *out_uids_to_copy</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="camel-imapx-folder-claim-move-to-inbox-uids"></a><h3>camel_imapx_folder_claim_move_to_inbox_uids ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
camel_imapx_folder_claim_move_to_inbox_uids
                               (<em class="parameter"><code><span class="type">CamelIMAPXFolder</span> *folder</code></em>,
                                <em class="parameter"><code><a href="../glib/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> *out_uids_to_copy</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="camel-imapx-folder-update-cache-expire"></a><h3>camel_imapx_folder_update_cache_expire ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
camel_imapx_folder_update_cache_expire
                               (<em class="parameter"><code><span class="type">CamelFolder</span> *folder</code></em>,
                                <em class="parameter"><code><span class="type">time_t</span> expire_when</code></em>);</pre>
</div>
</div>
<div class="refsect1">
<a name="camel-CamelIMAPXFolder.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.