evolution-data-server-doc 3.18.5-1ubuntu1 / usr / share / gtk-doc / html / camel / CamelIMAPXServer.html

This file is indexed.

/usr/share/gtk-doc/html/camel/CamelIMAPXServer.html is in evolution-data-server-doc 3.18.5-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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CamelIMAPXServer: 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="CamelIMAPXSearch.html" title="CamelIMAPXSearch">
<link rel="next" href="CamelIMAPXSettings.html" title="CamelIMAPXSettings">
<meta name="generator" content="GTK-Doc V1.24 (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="#CamelIMAPXServer.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#CamelIMAPXServer.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#CamelIMAPXServer.properties" class="shortcut">Properties</a></span><span id="nav_signals">  <span class="dim">|</span> 
                  <a href="#CamelIMAPXServer.signals" class="shortcut">Signals</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="CamelIMAPXSearch.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="CamelIMAPXSettings.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="CamelIMAPXServer"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="CamelIMAPXServer.top_of_page"></a>CamelIMAPXServer</span></h2>
<p>CamelIMAPXServer</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="CamelIMAPXServer.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">
<a class="link" href="CamelIMAPXServer.html" title="CamelIMAPXServer"><span class="returnvalue">CamelIMAPXServer</span></a> *
</td>
<td class="function_name">
<a class="link" href="CamelIMAPXServer.html#camel-imapx-server-new" title="camel_imapx_server_new ()">camel_imapx_server_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">struct <a class="link" href="CamelIMAPXStore.html" title="CamelIMAPXStore"><span class="returnvalue">_CamelIMAPXStore</span></a> *
</td>
<td class="function_name">
<a class="link" href="CamelIMAPXServer.html#camel-imapx-server-ref-store" title="camel_imapx_server_ref_store ()">camel_imapx_server_ref_store</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">struct <a class="link" href="CamelIMAPXSettings.html" title="CamelIMAPXSettings"><span class="returnvalue">_CamelIMAPXSettings</span></a> *
</td>
<td class="function_name">
<a class="link" href="CamelIMAPXServer.html#camel-imapx-server-ref-settings" title="camel_imapx_server_ref_settings ()">camel_imapx_server_ref_settings</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gio/GInputStream.html"><span class="returnvalue">GInputStream</span></a> *
</td>
<td class="function_name">
<a class="link" href="CamelIMAPXServer.html#camel-imapx-server-ref-input-stream" title="camel_imapx_server_ref_input_stream ()">camel_imapx_server_ref_input_stream</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gio/GOutputStream.html"><span class="returnvalue">GOutputStream</span></a> *
</td>
<td class="function_name">
<a class="link" href="CamelIMAPXServer.html#camel-imapx-server-ref-output-stream" title="camel_imapx_server_ref_output_stream ()">camel_imapx_server_ref_output_stream</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="returnvalue">CamelIMAPXMailbox</span></a> *
</td>
<td class="function_name">
<a class="link" href="CamelIMAPXServer.html#camel-imapx-server-ref-selected" title="camel_imapx_server_ref_selected ()">camel_imapx_server_ref_selected</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="CamelIMAPXServer.html#camel-imapx-server-is-connected" title="camel_imapx_server_is_connected ()">camel_imapx_server_is_connected</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="CamelIMAPXServer.html#CAMEL-IMAPX-SERVER-ERROR:CAPS" title="CAMEL_IMAPX_SERVER_ERROR">CAMEL_IMAPX_SERVER_ERROR</a></td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a>
</td>
<td class="function_name">
<a class="link" href="CamelIMAPXServer.html#camel-imapx-server-error-quark" title="camel_imapx_server_error_quark ()">camel_imapx_server_error_quark</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a class="link" href="CamelIMAPXServer.html#CamelIMAPXUntaggedRespHandlerDesc" title="struct CamelIMAPXUntaggedRespHandlerDesc"><span class="returnvalue">CamelIMAPXUntaggedRespHandlerDesc</span></a> *
</td>
<td class="function_name">
<a class="link" href="CamelIMAPXServer.html#camel-imapx-server-register-untagged-handler" title="camel_imapx_server_register_untagged_handler ()">camel_imapx_server_register_untagged_handler</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="CamelIMAPXServer.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody><tr>
<td class="property_type">
<a class="link" href="CamelIMAPXStore.html" title="CamelIMAPXStore"><span class="type">CamelIMAPXStore</span></a> *</td>
<td class="property_name"><a class="link" href="CamelIMAPXServer.html#CamelIMAPXServer--store" title="The “store” property">store</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="CamelIMAPXServer.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody><tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="CamelIMAPXServer.html#CamelIMAPXServer-refresh-mailbox" title="The “refresh-mailbox” signal">refresh-mailbox</a></td>
<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="CamelIMAPXServer.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="CamelIMAPXServer.html#CamelIMAPXServer-struct" title="struct CamelIMAPXServer">CamelIMAPXServer</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="CamelIMAPXServer.html#CamelIMAPXServerError" title="enum CamelIMAPXServerError">CamelIMAPXServerError</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="CamelIMAPXServer.html#CamelIMAPXUntaggedRespHandlerDesc" title="struct CamelIMAPXUntaggedRespHandlerDesc">CamelIMAPXUntaggedRespHandlerDesc</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="CamelIMAPXServer.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
    <span class="lineart">╰──</span> CamelIMAPXServer
</pre>
</div>
<div class="refsect1">
<a name="CamelIMAPXServer.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="CamelIMAPXServer.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="camel-imapx-server-new"></a><h3>camel_imapx_server_new ()</h3>
<pre class="programlisting"><a class="link" href="CamelIMAPXServer.html" title="CamelIMAPXServer"><span class="returnvalue">CamelIMAPXServer</span></a> *
camel_imapx_server_new (<em class="parameter"><code><span class="type">struct _CamelIMAPXStore</span> *store</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="camel-imapx-server-ref-store"></a><h3>camel_imapx_server_ref_store ()</h3>
<pre class="programlisting">struct <a class="link" href="CamelIMAPXStore.html" title="CamelIMAPXStore"><span class="returnvalue">_CamelIMAPXStore</span></a> *
camel_imapx_server_ref_store (<em class="parameter"><code><a class="link" href="CamelIMAPXServer.html" title="CamelIMAPXServer"><span class="type">CamelIMAPXServer</span></a> *is</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="camel-imapx-server-ref-settings"></a><h3>camel_imapx_server_ref_settings ()</h3>
<pre class="programlisting">struct <a class="link" href="CamelIMAPXSettings.html" title="CamelIMAPXSettings"><span class="returnvalue">_CamelIMAPXSettings</span></a> *
camel_imapx_server_ref_settings (<em class="parameter"><code><a class="link" href="CamelIMAPXServer.html" title="CamelIMAPXServer"><span class="type">CamelIMAPXServer</span></a> *is</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="camel-imapx-server-ref-input-stream"></a><h3>camel_imapx_server_ref_input_stream ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gio/GInputStream.html"><span class="returnvalue">GInputStream</span></a> *
camel_imapx_server_ref_input_stream (<em class="parameter"><code><a class="link" href="CamelIMAPXServer.html" title="CamelIMAPXServer"><span class="type">CamelIMAPXServer</span></a> *is</code></em>);</pre>
<p>Returns the <a href="/usr/share/gtk-doc/html/gio/GInputStream.html"><span class="type">GInputStream</span></a> for <em class="parameter"><code>is</code></em>
, which is owned by either a
<a href="/usr/share/gtk-doc/html/gio/GTcpConnection.html"><span class="type">GTcpConnection</span></a> or a <a href="/usr/share/gtk-doc/html/gio/GSubprocess.html"><span class="type">GSubprocess</span></a>.  If the <a class="link" href="CamelIMAPXServer.html" title="CamelIMAPXServer"><span class="type">CamelIMAPXServer</span></a> is not
yet connected or has lost its connection, the function returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
<p>The returned <a href="/usr/share/gtk-doc/html/gio/GInputStream.html"><span class="type">GInputStream</span></a> is referenced for thread-safety and must
be unreferenced with <a href="/usr/share/gtk-doc/html/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="id-1.3.3.10.9.5.6"></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>is</p></td>
<td class="parameter_description"><p>a <a class="link" href="CamelIMAPXServer.html" title="CamelIMAPXServer"><span class="type">CamelIMAPXServer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.3.10.9.5.7"></a><h4>Returns</h4>
<p> a <a href="/usr/share/gtk-doc/html/gio/GInputStream.html"><span class="type">GInputStream</span></a>, or <a href="/usr/share/gtk-doc/html/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" title="Index of new symbols in 3.12">3.12</a></p>
</div>
<hr>
<div class="refsect2">
<a name="camel-imapx-server-ref-output-stream"></a><h3>camel_imapx_server_ref_output_stream ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gio/GOutputStream.html"><span class="returnvalue">GOutputStream</span></a> *
camel_imapx_server_ref_output_stream (<em class="parameter"><code><a class="link" href="CamelIMAPXServer.html" title="CamelIMAPXServer"><span class="type">CamelIMAPXServer</span></a> *is</code></em>);</pre>
<p>Returns the <a href="/usr/share/gtk-doc/html/gio/GOutputStream.html"><span class="type">GOutputStream</span></a> for <em class="parameter"><code>is</code></em>
, which is owned by either a
<a href="/usr/share/gtk-doc/html/gio/GTcpConnection.html"><span class="type">GTcpConnection</span></a> or a <a href="/usr/share/gtk-doc/html/gio/GSubprocess.html"><span class="type">GSubprocess</span></a>.  If the <a class="link" href="CamelIMAPXServer.html" title="CamelIMAPXServer"><span class="type">CamelIMAPXServer</span></a> is not
yet connected or has lost its connection, the function returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
<p>The returned <a href="/usr/share/gtk-doc/html/gio/GOutputStream.html"><span class="type">GOutputStream</span></a> is referenced for thread-safety and must
be unreferenced with <a href="/usr/share/gtk-doc/html/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="id-1.3.3.10.9.6.6"></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>is</p></td>
<td class="parameter_description"><p>a <a class="link" href="CamelIMAPXServer.html" title="CamelIMAPXServer"><span class="type">CamelIMAPXServer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.3.10.9.6.7"></a><h4>Returns</h4>
<p> a <a href="/usr/share/gtk-doc/html/gio/GOutputStream.html"><span class="type">GOutputStream</span></a>, or <a href="/usr/share/gtk-doc/html/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" title="Index of new symbols in 3.12">3.12</a></p>
</div>
<hr>
<div class="refsect2">
<a name="camel-imapx-server-ref-selected"></a><h3>camel_imapx_server_ref_selected ()</h3>
<pre class="programlisting"><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="returnvalue">CamelIMAPXMailbox</span></a> *
camel_imapx_server_ref_selected (<em class="parameter"><code><a class="link" href="CamelIMAPXServer.html" title="CamelIMAPXServer"><span class="type">CamelIMAPXServer</span></a> *is</code></em>);</pre>
<p>Returns the <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> representing the currently selected
mailbox (or mailbox <span class="emphasis"><em>being</em></span> selected if a SELECT
command is in progress) on the IMAP server, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no mailbox
is currently selected or being selected on the server.</p>
<p>The returned <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> is reference for thread-safety and
should be unreferenced with <a href="/usr/share/gtk-doc/html/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="id-1.3.3.10.9.7.6"></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>is</p></td>
<td class="parameter_description"><p>a <a class="link" href="CamelIMAPXServer.html" title="CamelIMAPXServer"><span class="type">CamelIMAPXServer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.3.10.9.7.7"></a><h4>Returns</h4>
<p> a <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a>, or <a href="/usr/share/gtk-doc/html/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" title="Index of new symbols in 3.12">3.12</a></p>
</div>
<hr>
<div class="refsect2">
<a name="camel-imapx-server-is-connected"></a><h3>camel_imapx_server_is_connected ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
camel_imapx_server_is_connected (<em class="parameter"><code><a class="link" href="CamelIMAPXServer.html" title="CamelIMAPXServer"><span class="type">CamelIMAPXServer</span></a> *imapx_server</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="CAMEL-IMAPX-SERVER-ERROR:CAPS"></a><h3>CAMEL_IMAPX_SERVER_ERROR</h3>
<pre class="programlisting">#define CAMEL_IMAPX_SERVER_ERROR (camel_imapx_server_error_quark ())
</pre>
</div>
<hr>
<div class="refsect2">
<a name="camel-imapx-server-error-quark"></a><h3>camel_imapx_server_error_quark ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a>
camel_imapx_server_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="camel-imapx-server-register-untagged-handler"></a><h3>camel_imapx_server_register_untagged_handler ()</h3>
<pre class="programlisting">const <a class="link" href="CamelIMAPXServer.html#CamelIMAPXUntaggedRespHandlerDesc" title="struct CamelIMAPXUntaggedRespHandlerDesc"><span class="returnvalue">CamelIMAPXUntaggedRespHandlerDesc</span></a> *
camel_imapx_server_register_untagged_handler
                               (<em class="parameter"><code><a class="link" href="CamelIMAPXServer.html" title="CamelIMAPXServer"><span class="type">CamelIMAPXServer</span></a> *is</code></em>,
                                <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *untagged_response</code></em>,
                                <em class="parameter"><code>const <a class="link" href="CamelIMAPXServer.html#CamelIMAPXUntaggedRespHandlerDesc" title="struct CamelIMAPXUntaggedRespHandlerDesc"><span class="type">CamelIMAPXUntaggedRespHandlerDesc</span></a> *desc</code></em>);</pre>
<p>Register a new handler function for IMAP untagged responses.
Pass in a NULL descriptor to delete an existing handler (the
untagged response will remain known, but will no longer be acted
upon if the handler is deleted). The return value is intended
to be used in cases where e.g. an extension to existing handler
code is implemented with just some new code to be run before
or after the original handler code</p>
<div class="refsect3">
<a name="id-1.3.3.10.9.11.5"></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>is</p></td>
<td class="parameter_description"><p>a <a class="link" href="CamelIMAPXServer.html" title="CamelIMAPXServer"><span class="type">CamelIMAPXServer</span></a> instance</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>untagged_response</p></td>
<td class="parameter_description"><p>a string representation of the IMAP
untagged response code. Must be
all-uppercase with underscores allowed
(see RFC 3501)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>desc</p></td>
<td class="parameter_description"><p>a <a class="link" href="CamelIMAPXServer.html#CamelIMAPXUntaggedRespHandlerDesc" title="struct CamelIMAPXUntaggedRespHandlerDesc"><span class="type">CamelIMAPXUntaggedRespHandlerDesc</span></a> handler description
structure. The descriptor structure is expected to
remain stable over the lifetime of the <a class="link" href="CamelIMAPXServer.html" title="CamelIMAPXServer"><span class="type">CamelIMAPXServer</span></a>
instance it was registered with. It is the responsibility
of the caller to ensure this</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.3.10.9.11.6"></a><h4>Returns</h4>
<p> the <a class="link" href="CamelIMAPXServer.html#CamelIMAPXUntaggedRespHandlerDesc" title="struct CamelIMAPXUntaggedRespHandlerDesc"><span class="type">CamelIMAPXUntaggedRespHandlerDesc</span></a> previously
registered for this untagged response, if any,
NULL otherwise.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
</div>
</div>
<div class="refsect1">
<a name="CamelIMAPXServer.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="CamelIMAPXServer-struct"></a><h3>struct CamelIMAPXServer</h3>
<pre class="programlisting">struct CamelIMAPXServer;</pre>
</div>
<hr>
<div class="refsect2">
<a name="CamelIMAPXServerError"></a><h3>enum CamelIMAPXServerError</h3>
<div class="refsect3">
<a name="id-1.3.3.10.10.3.3"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="CAMEL-IMAPX-SERVER-ERROR-CONCURRENT-CONNECT-FAILED:CAPS"></a>CAMEL_IMAPX_SERVER_ERROR_CONCURRENT_CONNECT_FAILED</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CAMEL-IMAPX-SERVER-ERROR-TRY-RECONNECT:CAPS"></a>CAMEL_IMAPX_SERVER_ERROR_TRY_RECONNECT</p></td>
<td> </td>
<td> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="CamelIMAPXUntaggedRespHandlerDesc"></a><h3>struct CamelIMAPXUntaggedRespHandlerDesc</h3>
<pre class="programlisting">struct CamelIMAPXUntaggedRespHandlerDesc {
	const gchar *untagged_response;
	const CamelIMAPXUntaggedRespHandler handler;
	const gchar *next_response;
	gboolean skip_stream_when_done;
};
</pre>
<p>IMAP untagged response handler function descriptor. Use in conjunction
with <a class="link" href="CamelIMAPXServer.html#camel-imapx-server-register-untagged-handler" title="camel_imapx_server_register_untagged_handler ()"><code class="function">camel_imapx_server_register_untagged_handler()</code></a> to register a new
handler function for a given untagged response code</p>
<div class="refsect3">
<a name="id-1.3.3.10.10.4.5"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="CamelIMAPXUntaggedRespHandlerDesc.untagged-response"></a>untagged_response</code></em>;</p></td>
<td class="struct_member_description"><p>a string representation of the IMAP
untagged response code. Must be
all-uppercase with underscores allowed
(see RFC 3501)</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p>const <span class="type">CamelIMAPXUntaggedRespHandler</span> <em class="structfield"><code><a name="CamelIMAPXUntaggedRespHandlerDesc.handler"></a>handler</code></em>;</p></td>
<td class="struct_member_description"><p>an untagged response handler function for <a class="link" href="CamelIMAPXServer.html" title="CamelIMAPXServer"><span class="type">CamelIMAPXServer</span></a></p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="CamelIMAPXUntaggedRespHandlerDesc.next-response"></a>next_response</code></em>;</p></td>
<td class="struct_member_description"><p>the IMAP untagged code to call a registered
handler for directly after successfully
running <em class="parameter"><code>handler</code></em>
. If not NULL, <em class="parameter"><code>skip_stream_when_done</code></em>
for the current handler has no effect</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> <em class="structfield"><code><a name="CamelIMAPXUntaggedRespHandlerDesc.skip-stream-when-done"></a>skip_stream_when_done</code></em>;</p></td>
<td class="struct_member_description"><p>whether or not to skip the current IMAP
untagged response in the <a href="/usr/share/gtk-doc/html/gio/GInputStream.html"><span class="type">GInputStream</span></a>.
Set to TRUE if your handler does not eat
the stream up to the next response token</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
</div>
</div>
<div class="refsect1">
<a name="CamelIMAPXServer.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="CamelIMAPXServer--store"></a><h3>The <code class="literal">“store”</code> property</h3>
<pre class="programlisting">  “store”                    <a class="link" href="CamelIMAPXStore.html" title="CamelIMAPXStore"><span class="type">CamelIMAPXStore</span></a> *</pre>
<p>IMAPX store for this server.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
</div>
<div class="refsect1">
<a name="CamelIMAPXServer.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="CamelIMAPXServer-refresh-mailbox"></a><h3>The <code class="literal">“refresh-mailbox”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="CamelIMAPXServer.html" title="CamelIMAPXServer"><span class="type">CamelIMAPXServer</span></a>  *camelimapxserver,
               <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *arg1,
               <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>           user_data)</pre>
<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.