This file is indexed.

/usr/share/gtk-doc/html/camel/camel-camel-provider.html is in libcamel1.2-dev 3.2.3-0ubuntu6.

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
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>camel-provider</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Camel Reference Manual">
<link rel="up" href="Services.html" title="Services">
<link rel="prev" href="CamelSession.html" title="CamelSession">
<link rel="next" href="CamelService.html" title="CamelService">
<meta name="generator" content="GTK-Doc V1.18 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="CamelSession.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="Services.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Camel Reference Manual</th>
<td><a accesskey="n" href="CamelService.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#camel-camel-provider.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#camel-camel-provider.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="camel-camel-provider"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="camel-camel-provider.top_of_page"></a>camel-provider</span></h2>
<p>camel-provider</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="camel-camel-provider.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">                    <a class="link" href="camel-camel-provider.html#CamelProvider" title="CamelProvider">CamelProvider</a>;
enum                <a class="link" href="camel-camel-provider.html#CamelProviderType" title="enum CamelProviderType">CamelProviderType</a>;
enum                <a class="link" href="camel-camel-provider.html#CamelProviderFlags" title="enum CamelProviderFlags">CamelProviderFlags</a>;
#define             <a class="link" href="camel-camel-provider.html#CAMEL-URL-PART-USER:CAPS" title="CAMEL_URL_PART_USER">CAMEL_URL_PART_USER</a>
#define             <a class="link" href="camel-camel-provider.html#CAMEL-URL-PART-AUTH:CAPS" title="CAMEL_URL_PART_AUTH">CAMEL_URL_PART_AUTH</a>
#define             <a class="link" href="camel-camel-provider.html#CAMEL-URL-PART-PASSWORD:CAPS" title="CAMEL_URL_PART_PASSWORD">CAMEL_URL_PART_PASSWORD</a>
#define             <a class="link" href="camel-camel-provider.html#CAMEL-URL-PART-HOST:CAPS" title="CAMEL_URL_PART_HOST">CAMEL_URL_PART_HOST</a>
#define             <a class="link" href="camel-camel-provider.html#CAMEL-URL-PART-PORT:CAPS" title="CAMEL_URL_PART_PORT">CAMEL_URL_PART_PORT</a>
#define             <a class="link" href="camel-camel-provider.html#CAMEL-URL-PART-PATH:CAPS" title="CAMEL_URL_PART_PATH">CAMEL_URL_PART_PATH</a>
#define             <a class="link" href="camel-camel-provider.html#CAMEL-URL-PART-PATH-DIR:CAPS" title="CAMEL_URL_PART_PATH_DIR">CAMEL_URL_PART_PATH_DIR</a>
#define             <a class="link" href="camel-camel-provider.html#CAMEL-URL-PART-NEED:CAPS" title="CAMEL_URL_PART_NEED">CAMEL_URL_PART_NEED</a>
#define             <a class="link" href="camel-camel-provider.html#CAMEL-URL-PART-HIDDEN:CAPS" title="CAMEL_URL_PART_HIDDEN">CAMEL_URL_PART_HIDDEN</a>
#define             <a class="link" href="camel-camel-provider.html#CAMEL-PROVIDER-ALLOWS:CAPS" title="CAMEL_PROVIDER_ALLOWS()">CAMEL_PROVIDER_ALLOWS</a>               (prov,
                                                         flags)
#define             <a class="link" href="camel-camel-provider.html#CAMEL-PROVIDER-NEEDS:CAPS" title="CAMEL_PROVIDER_NEEDS()">CAMEL_PROVIDER_NEEDS</a>                (prov,
                                                         flags)
#define             <a class="link" href="camel-camel-provider.html#CAMEL-PROVIDER-HIDDEN:CAPS" title="CAMEL_PROVIDER_HIDDEN()">CAMEL_PROVIDER_HIDDEN</a>               (prov,
                                                         flags)
enum                <a class="link" href="camel-camel-provider.html#CamelProviderURLFlags" title="enum CamelProviderURLFlags">CamelProviderURLFlags</a>;
#define             <a class="link" href="camel-camel-provider.html#CAMEL-PROVIDER-IS-STORE-AND-TRANSPORT:CAPS" title="CAMEL_PROVIDER_IS_STORE_AND_TRANSPORT()">CAMEL_PROVIDER_IS_STORE_AND_TRANSPORT</a>(prov)
enum                <a class="link" href="camel-camel-provider.html#CamelProviderConfType" title="enum CamelProviderConfType">CamelProviderConfType</a>;
                    <a class="link" href="camel-camel-provider.html#CamelProviderConfEntry" title="CamelProviderConfEntry">CamelProviderConfEntry</a>;
                    <a class="link" href="camel-camel-provider.html#CamelProviderPortEntry" title="CamelProviderPortEntry">CamelProviderPortEntry</a>;
#define             <a class="link" href="camel-camel-provider.html#CAMEL-PROVIDER-CONF-DEFAULT-USERNAME:CAPS" title="CAMEL_PROVIDER_CONF_DEFAULT_USERNAME">CAMEL_PROVIDER_CONF_DEFAULT_USERNAME</a>
#define             <a class="link" href="camel-camel-provider.html#CAMEL-PROVIDER-CONF-DEFAULT-HOSTNAME:CAPS" title="CAMEL_PROVIDER_CONF_DEFAULT_HOSTNAME">CAMEL_PROVIDER_CONF_DEFAULT_HOSTNAME</a>
#define             <a class="link" href="camel-camel-provider.html#CAMEL-PROVIDER-CONF-DEFAULT-PATH:CAPS" title="CAMEL_PROVIDER_CONF_DEFAULT_PATH">CAMEL_PROVIDER_CONF_DEFAULT_PATH</a>
<span class="returnvalue">gint</span>                (<a class="link" href="camel-camel-provider.html#CamelProviderAutoDetectFunc" title="CamelProviderAutoDetectFunc ()">*CamelProviderAutoDetectFunc</a>)      (<em class="parameter"><code><a class="link" href="camel-camel-url.html#CamelURL" title="struct CamelURL"><span class="type">CamelURL</span></a> *url</code></em>,
                                                         <em class="parameter"><code><span class="type">GHashTable</span> **auto_detected</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
struct              <a class="link" href="camel-camel-provider.html#CamelProviderModule" title="struct CamelProviderModule">CamelProviderModule</a>;
<span class="returnvalue">void</span>                <a class="link" href="camel-camel-provider.html#camel-provider-init" title="camel_provider_init ()">camel_provider_init</a>                 (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="camel-camel-provider.html#camel-provider-load" title="camel_provider_load ()">camel_provider_load</a>                 (<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="camel-camel-provider.html#camel-provider-register" title="camel_provider_register ()">camel_provider_register</a>             (<em class="parameter"><code><a class="link" href="camel-camel-provider.html#CamelProvider" title="CamelProvider"><span class="type">CamelProvider</span></a> *provider</code></em>);
<span class="returnvalue">GList</span> *             <a class="link" href="camel-camel-provider.html#camel-provider-list" title="camel_provider_list ()">camel_provider_list</a>                 (<em class="parameter"><code><span class="type">gboolean</span> load</code></em>);
<a class="link" href="camel-camel-provider.html#CamelProvider" title="CamelProvider"><span class="returnvalue">CamelProvider</span></a> *     <a class="link" href="camel-camel-provider.html#camel-provider-get" title="camel_provider_get ()">camel_provider_get</a>                  (<em class="parameter"><code>const <span class="type">gchar</span> *url_string</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="camel-camel-provider.html#camel-provider-module-init" title="camel_provider_module_init ()">camel_provider_module_init</a>          (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">gint</span>                <a class="link" href="camel-camel-provider.html#camel-provider-auto-detect" title="camel_provider_auto_detect ()">camel_provider_auto_detect</a>          (<em class="parameter"><code><a class="link" href="camel-camel-provider.html#CamelProvider" title="CamelProvider"><span class="type">CamelProvider</span></a> *provider</code></em>,
                                                         <em class="parameter"><code><a class="link" href="camel-camel-url.html#CamelURL" title="struct CamelURL"><span class="type">CamelURL</span></a> *url</code></em>,
                                                         <em class="parameter"><code><span class="type">GHashTable</span> **auto_detected</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="camel-camel-provider.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="camel-camel-provider.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="CamelProvider"></a><h3>CamelProvider</h3>
<pre class="programlisting">typedef struct {
	/* Provider name used in CamelURLs. */
	const gchar *protocol;

	/* Provider name as used by people. (May be the same as protocol) */
	const gchar *name;

	/* Description of the provider. A novice user should be able
	 * to read this description, and the information provided by
	 * an ISP, IS department, etc, and determine whether or not
	 * this provider is relevant to him, and if so, which
	 * information goes with it.
	 */
	const gchar *description;

	/* The category of message that this provider works with.
	 * (evolution-mail will only list a provider in the store/transport
	 * config dialogs if its domain is "mail".)
	 */
	const gchar *domain;

	/* Flags describing the provider, flags describing its URLs */
	CamelProviderFlags flags;
	CamelProviderURLFlags url_flags;

	/* The ConfEntry and AutoDetect functions will probably be
	 * DEPRECATED in a future release */

	/* Extra configuration information */
	CamelProviderConfEntry *extra_conf;

	/* The list of CamelProviderPortEntry structs. Each struct contains 
	 * port number and a short string description ("Default IMAP port"
	 * or "POP3 over SSL" etc.
	 */
	CamelProviderPortEntry *port_entries;

	/* auto-detection function */
	CamelProviderAutoDetectFunc auto_detect;

	/* GType(s) of its store and/or transport. If both are
	 * set, then they are assumed to be linked together and the
	 * transport type can only be used in an account that also
	 * uses the store type (eg, Exchange or NNTP).
	 */
	GType object_types[CAMEL_NUM_PROVIDER_TYPES];

	/* GList of CamelServiceAuthTypes the provider supports */
	GList *authtypes;

	GHashFunc url_hash;
	GEqualFunc url_equal;

	/* gettext translation domain (NULL for providers in the
	 * evolution source tree).
	 */
	const gchar *translation_domain;

	/* This string points to the provider's gconf key value
	 */
	const gchar *license;

	/* This holds the license file name [ ascii text format ] containing
	 * the license agreement. This should be the absolute file path. This
	 * is read only when the HAS_LICENSE flag is set
	 */
	const gchar *license_file;

	/* Private to the provider */
	gpointer priv;
} CamelProvider;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CamelProviderType"></a><h3>enum CamelProviderType</h3>
<pre class="programlisting">typedef enum {
	CAMEL_PROVIDER_STORE,
	CAMEL_PROVIDER_TRANSPORT,
	CAMEL_NUM_PROVIDER_TYPES  /*&lt; skip &gt;*/
} CamelProviderType;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CamelProviderFlags"></a><h3>enum CamelProviderFlags</h3>
<pre class="programlisting">typedef enum {
 /*&lt; flags &gt;*/
	CAMEL_PROVIDER_IS_REMOTE               = 1 &lt;&lt; 0,
	CAMEL_PROVIDER_IS_LOCAL                = 1 &lt;&lt; 1,
	CAMEL_PROVIDER_IS_EXTERNAL             = 1 &lt;&lt; 2,
	CAMEL_PROVIDER_IS_SOURCE               = 1 &lt;&lt; 3,
	CAMEL_PROVIDER_IS_STORAGE              = 1 &lt;&lt; 4,
	CAMEL_PROVIDER_SUPPORTS_SSL            = 1 &lt;&lt; 5,
	CAMEL_PROVIDER_HAS_LICENSE             = 1 &lt;&lt; 6,
	CAMEL_PROVIDER_DISABLE_SENT_FOLDER     = 1 &lt;&lt; 7,
	CAMEL_PROVIDER_ALLOW_REAL_TRASH_FOLDER = 1 &lt;&lt; 8,
	CAMEL_PROVIDER_ALLOW_REAL_JUNK_FOLDER  = 1 &lt;&lt; 9
} CamelProviderFlags;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CAMEL-URL-PART-USER:CAPS"></a><h3>CAMEL_URL_PART_USER</h3>
<pre class="programlisting">#define CAMEL_URL_PART_USER	 (1 &lt;&lt; 0)
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CAMEL-URL-PART-AUTH:CAPS"></a><h3>CAMEL_URL_PART_AUTH</h3>
<pre class="programlisting">#define CAMEL_URL_PART_AUTH	 (1 &lt;&lt; 1)
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CAMEL-URL-PART-PASSWORD:CAPS"></a><h3>CAMEL_URL_PART_PASSWORD</h3>
<pre class="programlisting">#define CAMEL_URL_PART_PASSWORD	 (1 &lt;&lt; 2)
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CAMEL-URL-PART-HOST:CAPS"></a><h3>CAMEL_URL_PART_HOST</h3>
<pre class="programlisting">#define CAMEL_URL_PART_HOST	 (1 &lt;&lt; 3)
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CAMEL-URL-PART-PORT:CAPS"></a><h3>CAMEL_URL_PART_PORT</h3>
<pre class="programlisting">#define CAMEL_URL_PART_PORT	 (1 &lt;&lt; 4)
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CAMEL-URL-PART-PATH:CAPS"></a><h3>CAMEL_URL_PART_PATH</h3>
<pre class="programlisting">#define CAMEL_URL_PART_PATH	 (1 &lt;&lt; 5)
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CAMEL-URL-PART-PATH-DIR:CAPS"></a><h3>CAMEL_URL_PART_PATH_DIR</h3>
<pre class="programlisting">#define CAMEL_URL_PART_PATH_DIR  (1 &lt;&lt; 6)
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CAMEL-URL-PART-NEED:CAPS"></a><h3>CAMEL_URL_PART_NEED</h3>
<pre class="programlisting">#define CAMEL_URL_PART_NEED	       8
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CAMEL-URL-PART-HIDDEN:CAPS"></a><h3>CAMEL_URL_PART_HIDDEN</h3>
<pre class="programlisting">#define CAMEL_URL_PART_HIDDEN (CAMEL_URL_PART_NEED + 8)
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CAMEL-PROVIDER-ALLOWS:CAPS"></a><h3>CAMEL_PROVIDER_ALLOWS()</h3>
<pre class="programlisting">#define             CAMEL_PROVIDER_ALLOWS(prov, flags)</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CAMEL-PROVIDER-NEEDS:CAPS"></a><h3>CAMEL_PROVIDER_NEEDS()</h3>
<pre class="programlisting">#define             CAMEL_PROVIDER_NEEDS(prov, flags)</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CAMEL-PROVIDER-HIDDEN:CAPS"></a><h3>CAMEL_PROVIDER_HIDDEN()</h3>
<pre class="programlisting">#define             CAMEL_PROVIDER_HIDDEN(prov, flags)</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CamelProviderURLFlags"></a><h3>enum CamelProviderURLFlags</h3>
<pre class="programlisting">typedef enum {
	CAMEL_URL_ALLOW_USER       = CAMEL_URL_PART_USER,
	CAMEL_URL_ALLOW_AUTH       = CAMEL_URL_PART_AUTH,
	CAMEL_URL_ALLOW_PASSWORD   = CAMEL_URL_PART_PASSWORD,
	CAMEL_URL_ALLOW_HOST       = CAMEL_URL_PART_HOST,
	CAMEL_URL_ALLOW_PORT       = CAMEL_URL_PART_PORT,
	CAMEL_URL_ALLOW_PATH       = CAMEL_URL_PART_PATH,

	CAMEL_URL_NEED_USER        = CAMEL_URL_PART_USER &lt;&lt; CAMEL_URL_PART_NEED,
	CAMEL_URL_NEED_AUTH        = CAMEL_URL_PART_AUTH &lt;&lt; CAMEL_URL_PART_NEED,
	CAMEL_URL_NEED_PASSWORD    = CAMEL_URL_PART_PASSWORD &lt;&lt; CAMEL_URL_PART_NEED,
	CAMEL_URL_NEED_HOST        = CAMEL_URL_PART_HOST &lt;&lt; CAMEL_URL_PART_NEED,
	CAMEL_URL_NEED_PORT        = CAMEL_URL_PART_PORT &lt;&lt; CAMEL_URL_PART_NEED,
	CAMEL_URL_NEED_PATH        = CAMEL_URL_PART_PATH &lt;&lt; CAMEL_URL_PART_NEED,
	CAMEL_URL_NEED_PATH_DIR    = CAMEL_URL_PART_PATH_DIR &lt;&lt; CAMEL_URL_PART_NEED,

	CAMEL_URL_HIDDEN_USER      = CAMEL_URL_PART_USER &lt;&lt; CAMEL_URL_PART_HIDDEN,
	CAMEL_URL_HIDDEN_AUTH      = CAMEL_URL_PART_AUTH &lt;&lt; CAMEL_URL_PART_HIDDEN,
	CAMEL_URL_HIDDEN_PASSWORD  = CAMEL_URL_PART_PASSWORD &lt;&lt; CAMEL_URL_PART_HIDDEN,
	CAMEL_URL_HIDDEN_HOST      = CAMEL_URL_PART_HOST &lt;&lt; CAMEL_URL_PART_HIDDEN,
	CAMEL_URL_HIDDEN_PORT      = CAMEL_URL_PART_PORT &lt;&lt; CAMEL_URL_PART_HIDDEN,
	CAMEL_URL_HIDDEN_PATH      = CAMEL_URL_PART_PATH &lt;&lt; CAMEL_URL_PART_HIDDEN,

	CAMEL_URL_FRAGMENT_IS_PATH = 1 &lt;&lt; 30, /* url uses fragment for folder name path, not path */
	CAMEL_URL_PATH_IS_ABSOLUTE = 1 &lt;&lt; 31,
} CamelProviderURLFlags;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CAMEL-PROVIDER-IS-STORE-AND-TRANSPORT:CAPS"></a><h3>CAMEL_PROVIDER_IS_STORE_AND_TRANSPORT()</h3>
<pre class="programlisting">#define CAMEL_PROVIDER_IS_STORE_AND_TRANSPORT(prov) (prov-&gt;object_types[CAMEL_PROVIDER_STORE] &amp;&amp; prov-&gt;object_types[CAMEL_PROVIDER_TRANSPORT])
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CamelProviderConfType"></a><h3>enum CamelProviderConfType</h3>
<pre class="programlisting">typedef enum {
	CAMEL_PROVIDER_CONF_END,
	CAMEL_PROVIDER_CONF_SECTION_START,
	CAMEL_PROVIDER_CONF_SECTION_END,
	CAMEL_PROVIDER_CONF_CHECKBOX,
	CAMEL_PROVIDER_CONF_CHECKSPIN,
	CAMEL_PROVIDER_CONF_ENTRY,
	CAMEL_PROVIDER_CONF_LABEL,
	CAMEL_PROVIDER_CONF_HIDDEN,
	CAMEL_PROVIDER_CONF_OPTIONS
} CamelProviderConfType;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CamelProviderConfEntry"></a><h3>CamelProviderConfEntry</h3>
<pre class="programlisting">typedef struct {
	CamelProviderConfType type;
	const gchar *name, *depname;
	const gchar *text, *value;
} CamelProviderConfEntry;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CamelProviderPortEntry"></a><h3>CamelProviderPortEntry</h3>
<pre class="programlisting">typedef struct {
	gint port;
	const gchar *desc;
	gboolean is_ssl;
} CamelProviderPortEntry;
</pre>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="CAMEL-PROVIDER-CONF-DEFAULT-USERNAME:CAPS"></a><h3>CAMEL_PROVIDER_CONF_DEFAULT_USERNAME</h3>
<pre class="programlisting">#define             CAMEL_PROVIDER_CONF_DEFAULT_USERNAME</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CAMEL-PROVIDER-CONF-DEFAULT-HOSTNAME:CAPS"></a><h3>CAMEL_PROVIDER_CONF_DEFAULT_HOSTNAME</h3>
<pre class="programlisting">#define             CAMEL_PROVIDER_CONF_DEFAULT_HOSTNAME</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CAMEL-PROVIDER-CONF-DEFAULT-PATH:CAPS"></a><h3>CAMEL_PROVIDER_CONF_DEFAULT_PATH</h3>
<pre class="programlisting">#define             CAMEL_PROVIDER_CONF_DEFAULT_PATH</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CamelProviderAutoDetectFunc"></a><h3>CamelProviderAutoDetectFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>                (*CamelProviderAutoDetectFunc)      (<em class="parameter"><code><a class="link" href="camel-camel-url.html#CamelURL" title="struct CamelURL"><span class="type">CamelURL</span></a> *url</code></em>,
                                                         <em class="parameter"><code><span class="type">GHashTable</span> **auto_detected</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CamelProviderModule"></a><h3>struct CamelProviderModule</h3>
<pre class="programlisting">struct CamelProviderModule {
	gchar *path;
	GSList *types;
	guint loaded : 1;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-provider-init"></a><h3>camel_provider_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                camel_provider_init                 (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Initialize the Camel provider system by reading in the .urls
files in the provider directory and creating a hash table mapping
URLs to module names.
</p>
<p>
A .urls file has the same initial prefix as the shared library it
correspond to, and consists of a series of lines containing the URL
protocols that that library handles.
</p>
<p>
TODO: This should be pathed?
TODO: This should be plugin-d?
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-provider-load"></a><h3>camel_provider_load ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            camel_provider_load                 (<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Loads the provider at <em class="parameter"><code>path</code></em>, and calls its initialization function,
passing <em class="parameter"><code>session</code></em> as an argument. The provider should then register
itself with <em class="parameter"><code>session</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>the path to a shared library</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> on failure</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-provider-register"></a><h3>camel_provider_register ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                camel_provider_register             (<em class="parameter"><code><a class="link" href="camel-camel-provider.html#CamelProvider" title="CamelProvider"><span class="type">CamelProvider</span></a> *provider</code></em>);</pre>
<p>
Registers a provider.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
<td>provider object</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-provider-list"></a><h3>camel_provider_list ()</h3>
<pre class="programlisting"><span class="returnvalue">GList</span> *             camel_provider_list                 (<em class="parameter"><code><span class="type">gboolean</span> load</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-provider-get"></a><h3>camel_provider_get ()</h3>
<pre class="programlisting"><a class="link" href="camel-camel-provider.html#CamelProvider" title="CamelProvider"><span class="returnvalue">CamelProvider</span></a> *     camel_provider_get                  (<em class="parameter"><code>const <span class="type">gchar</span> *url_string</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
This returns the CamelProvider that would be used to handle
<em class="parameter"><code>url_string</code></em>, loading it in from disk if necessary.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>url_string</code></em> :</span></p></td>
<td>the URL for the service whose provider you want</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the provider, or <code class="literal">NULL</code>, in which case <em class="parameter"><code>error</code></em> will be set.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-provider-module-init"></a><h3>camel_provider_module_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                camel_provider_module_init          (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-provider-auto-detect"></a><h3>camel_provider_auto_detect ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>                camel_provider_auto_detect          (<em class="parameter"><code><a class="link" href="camel-camel-provider.html#CamelProvider" title="CamelProvider"><span class="type">CamelProvider</span></a> *provider</code></em>,
                                                         <em class="parameter"><code><a class="link" href="camel-camel-url.html#CamelURL" title="struct CamelURL"><span class="type">CamelURL</span></a> *url</code></em>,
                                                         <em class="parameter"><code><span class="type">GHashTable</span> **auto_detected</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
After filling in the standard Username/Hostname/Port/Path settings
(which must be set in <em class="parameter"><code>url</code></em>), if the provider supports it, you
may wish to have the provider auto-detect further settings based on
the aformentioned settings.
</p>
<p>
If the provider does not support auto-detection, <em class="parameter"><code>auto_detected</code></em>
will be set to <code class="literal">NULL</code>. Otherwise the provider will attempt to
auto-detect whatever it can and file them into <em class="parameter"><code>auto_detected</code></em>. If
for some reason it cannot auto-detect anything (not enough
information provided in <em class="parameter"><code>url</code></em>?) then <em class="parameter"><code>auto_detected</code></em> will be
set to <code class="literal">NULL</code> and an exception may be set to explain why it failed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
<td>camel provider</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>url</code></em> :</span></p></td>
<td>a <a class="link" href="camel-camel-url.html#CamelURL" title="struct CamelURL"><span class="type">CamelURL</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>auto_detected</code></em> :</span></p></td>
<td>output hash table of auto-detected values</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>0 on success or -1 on fail.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>