← Back to branch summary

~ubuntu-branches/ubuntu/maverick/evolution-data-server/maverick-proposed

« back to all changes in this revision

Viewing changes to docs/reference/camel/html/camel-camel-provider.html

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.1.79 upstream) (1.6.12 experimental)
  • Revision ID: james.westby@ubuntu.com-20100517170206-4ufr52vwrhh26yh0
Tags: 2.30.1-1ubuntu1
https://launchpad.net/bugs/42199
https://launchpad.net/bugs/229669
https://launchpad.net/bugs/173703
https://launchpad.net/bugs/360344
https://launchpad.net/bugs/508494
* Merge from debian experimental. Remaining change:
  (LP: #42199, #229669, #173703, #360344, #508494)
  + debian/control:
    - add Vcs-Bzr tag
    - don't use libgnome
    - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  + debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    - use the upstream versioning, not a Debian-specific one 
  + debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
    debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
    - install html documentation
  + debian/rules:
    - don't build documentation it's shipped with the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/camel/html/camel-camel-provider.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>camel-provider</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
7
<link rel="home" href="index.html" title="Camel Reference Manual">
8
8
<link rel="up" href="Services.html" title="Services">
9
9
<link rel="prev" href="camel-CamelSession.html" title="CamelSession">
26
26
                  <a href="#camel-camel-provider.description" class="shortcut">Description</a>
27
27
</td></tr>
28
28
</table>
29
 
<div class="refentry" lang="en">
 
29
<div class="refentry" title="camel-provider">
30
30
<a name="camel-camel-provider"></a><div class="titlepage"></div>
31
31
<div class="refnamediv"><table width="100%"><tr>
32
32
<td valign="top">
35
35
</td>
36
36
<td valign="top" align="right"></td>
37
37
</tr></table></div>
38
 
<div class="refsynopsisdiv">
 
38
<div class="refsynopsisdiv" title="Synopsis">
39
39
<a name="camel-camel-provider.synopsis"></a><h2>Synopsis</h2>
40
40
<pre class="synopsis">                    <a class="link" href="camel-camel-provider.html#CamelProvider" title="CamelProvider">CamelProvider</a>;
41
41
enum                <a class="link" href="camel-camel-provider.html#CamelProviderType" title="enum CamelProviderType">CamelProviderType</a>;
106
106
                                                         <em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex</code></em>);
107
107
</pre>
108
108
</div>
109
 
<div class="refsect1" lang="en">
 
109
<div class="refsect1" title="Description">
110
110
<a name="camel-camel-provider.description"></a><h2>Description</h2>
111
111
<p>
112
112
</p>
113
113
</div>
114
 
<div class="refsect1" lang="en">
 
114
<div class="refsect1" title="Details">
115
115
<a name="camel-camel-provider.details"></a><h2>Details</h2>
116
 
<div class="refsect2" lang="en">
 
116
<div class="refsect2" title="CamelProvider">
117
117
<a name="CamelProvider"></a><h3>CamelProvider</h3>
118
118
<pre class="programlisting">typedef struct {
119
119
        /* Provider name used in CamelURLs. */
186
186
</p>
187
187
</div>
188
188
<hr>
189
 
<div class="refsect2" lang="en">
 
189
<div class="refsect2" title="enum CamelProviderType">
190
190
<a name="CamelProviderType"></a><h3>enum CamelProviderType</h3>
191
191
<pre class="programlisting">typedef enum {
192
192
        CAMEL_PROVIDER_STORE,
198
198
</p>
199
199
</div>
200
200
<hr>
201
 
<div class="refsect2" lang="en">
 
201
<div class="refsect2" title="CAMEL_PROVIDER_IS_LOCAL">
202
202
<a name="CAMEL-PROVIDER-IS-LOCAL:CAPS"></a><h3>CAMEL_PROVIDER_IS_LOCAL</h3>
203
203
<pre class="programlisting">#define CAMEL_PROVIDER_IS_LOCAL             (1 &lt;&lt; 1)
204
204
</pre>
206
206
</p>
207
207
</div>
208
208
<hr>
209
 
<div class="refsect2" lang="en">
 
209
<div class="refsect2" title="CAMEL_PROVIDER_IS_EXTERNAL">
210
210
<a name="CAMEL-PROVIDER-IS-EXTERNAL:CAPS"></a><h3>CAMEL_PROVIDER_IS_EXTERNAL</h3>
211
211
<pre class="programlisting">#define CAMEL_PROVIDER_IS_EXTERNAL (1 &lt;&lt; 2)
212
212
</pre>
214
214
</p>
215
215
</div>
216
216
<hr>
217
 
<div class="refsect2" lang="en">
 
217
<div class="refsect2" title="CAMEL_PROVIDER_IS_SOURCE">
218
218
<a name="CAMEL-PROVIDER-IS-SOURCE:CAPS"></a><h3>CAMEL_PROVIDER_IS_SOURCE</h3>
219
219
<pre class="programlisting">#define CAMEL_PROVIDER_IS_SOURCE (1 &lt;&lt; 3)
220
220
</pre>
222
222
</p>
223
223
</div>
224
224
<hr>
225
 
<div class="refsect2" lang="en">
 
225
<div class="refsect2" title="CAMEL_PROVIDER_IS_STORAGE">
226
226
<a name="CAMEL-PROVIDER-IS-STORAGE:CAPS"></a><h3>CAMEL_PROVIDER_IS_STORAGE</h3>
227
227
<pre class="programlisting">#define CAMEL_PROVIDER_IS_STORAGE (1 &lt;&lt; 4)
228
228
</pre>
230
230
</p>
231
231
</div>
232
232
<hr>
233
 
<div class="refsect2" lang="en">
 
233
<div class="refsect2" title="CAMEL_PROVIDER_SUPPORTS_SSL">
234
234
<a name="CAMEL-PROVIDER-SUPPORTS-SSL:CAPS"></a><h3>CAMEL_PROVIDER_SUPPORTS_SSL</h3>
235
235
<pre class="programlisting">#define CAMEL_PROVIDER_SUPPORTS_SSL (1 &lt;&lt; 5)
236
236
</pre>
238
238
</p>
239
239
</div>
240
240
<hr>
241
 
<div class="refsect2" lang="en">
 
241
<div class="refsect2" title="CAMEL_PROVIDER_HAS_LICENSE">
242
242
<a name="CAMEL-PROVIDER-HAS-LICENSE:CAPS"></a><h3>CAMEL_PROVIDER_HAS_LICENSE</h3>
243
243
<pre class="programlisting">#define CAMEL_PROVIDER_HAS_LICENSE      (1 &lt;&lt; 6)
244
244
</pre>
246
246
</p>
247
247
</div>
248
248
<hr>
249
 
<div class="refsect2" lang="en">
 
249
<div class="refsect2" title="CAMEL_PROVIDER_DISABLE_SENT_FOLDER">
250
250
<a name="CAMEL-PROVIDER-DISABLE-SENT-FOLDER:CAPS"></a><h3>CAMEL_PROVIDER_DISABLE_SENT_FOLDER</h3>
251
251
<pre class="programlisting">#define CAMEL_PROVIDER_DISABLE_SENT_FOLDER (1 &lt;&lt; 7)
252
252
</pre>
254
254
</p>
255
255
</div>
256
256
<hr>
257
 
<div class="refsect2" lang="en">
 
257
<div class="refsect2" title="CAMEL_URL_PART_USER">
258
258
<a name="CAMEL-URL-PART-USER:CAPS"></a><h3>CAMEL_URL_PART_USER</h3>
259
259
<pre class="programlisting">#define CAMEL_URL_PART_USER  (1 &lt;&lt; 0)
260
260
</pre>
262
262
</p>
263
263
</div>
264
264
<hr>
265
 
<div class="refsect2" lang="en">
 
265
<div class="refsect2" title="CAMEL_URL_PART_AUTH">
266
266
<a name="CAMEL-URL-PART-AUTH:CAPS"></a><h3>CAMEL_URL_PART_AUTH</h3>
267
267
<pre class="programlisting">#define CAMEL_URL_PART_AUTH  (1 &lt;&lt; 1)
268
268
</pre>
270
270
</p>
271
271
</div>
272
272
<hr>
273
 
<div class="refsect2" lang="en">
 
273
<div class="refsect2" title="CAMEL_URL_PART_PASSWORD">
274
274
<a name="CAMEL-URL-PART-PASSWORD:CAPS"></a><h3>CAMEL_URL_PART_PASSWORD</h3>
275
275
<pre class="programlisting">#define CAMEL_URL_PART_PASSWORD      (1 &lt;&lt; 2)
276
276
</pre>
278
278
</p>
279
279
</div>
280
280
<hr>
281
 
<div class="refsect2" lang="en">
 
281
<div class="refsect2" title="CAMEL_URL_PART_HOST">
282
282
<a name="CAMEL-URL-PART-HOST:CAPS"></a><h3>CAMEL_URL_PART_HOST</h3>
283
283
<pre class="programlisting">#define CAMEL_URL_PART_HOST  (1 &lt;&lt; 3)
284
284
</pre>
286
286
</p>
287
287
</div>
288
288
<hr>
289
 
<div class="refsect2" lang="en">
 
289
<div class="refsect2" title="CAMEL_URL_PART_PORT">
290
290
<a name="CAMEL-URL-PART-PORT:CAPS"></a><h3>CAMEL_URL_PART_PORT</h3>
291
291
<pre class="programlisting">#define CAMEL_URL_PART_PORT  (1 &lt;&lt; 4)
292
292
</pre>
294
294
</p>
295
295
</div>
296
296
<hr>
297
 
<div class="refsect2" lang="en">
 
297
<div class="refsect2" title="CAMEL_URL_PART_PATH">
298
298
<a name="CAMEL-URL-PART-PATH:CAPS"></a><h3>CAMEL_URL_PART_PATH</h3>
299
299
<pre class="programlisting">#define CAMEL_URL_PART_PATH  (1 &lt;&lt; 5)
300
300
</pre>
302
302
</p>
303
303
</div>
304
304
<hr>
305
 
<div class="refsect2" lang="en">
 
305
<div class="refsect2" title="CAMEL_URL_PART_PATH_DIR">
306
306
<a name="CAMEL-URL-PART-PATH-DIR:CAPS"></a><h3>CAMEL_URL_PART_PATH_DIR</h3>
307
307
<pre class="programlisting">#define CAMEL_URL_PART_PATH_DIR  (1 &lt;&lt; 6)
308
308
</pre>
310
310
</p>
311
311
</div>
312
312
<hr>
313
 
<div class="refsect2" lang="en">
 
313
<div class="refsect2" title="CAMEL_URL_PART_NEED">
314
314
<a name="CAMEL-URL-PART-NEED:CAPS"></a><h3>CAMEL_URL_PART_NEED</h3>
315
315
<pre class="programlisting">#define CAMEL_URL_PART_NEED        8
316
316
</pre>
318
318
</p>
319
319
</div>
320
320
<hr>
321
 
<div class="refsect2" lang="en">
 
321
<div class="refsect2" title="CAMEL_URL_PART_HIDDEN">
322
322
<a name="CAMEL-URL-PART-HIDDEN:CAPS"></a><h3>CAMEL_URL_PART_HIDDEN</h3>
323
323
<pre class="programlisting">#define CAMEL_URL_PART_HIDDEN (CAMEL_URL_PART_NEED + 8)
324
324
</pre>
326
326
</p>
327
327
</div>
328
328
<hr>
329
 
<div class="refsect2" lang="en">
 
329
<div class="refsect2" title="CAMEL_PROVIDER_ALLOWS()">
330
330
<a name="CAMEL-PROVIDER-ALLOWS:CAPS"></a><h3>CAMEL_PROVIDER_ALLOWS()</h3>
331
331
<pre class="programlisting">#define CAMEL_PROVIDER_ALLOWS(prov, flags) (prov-&gt;url_flags &amp; (flags | (flags &lt;&lt; CAMEL_URL_PART_NEED) | (flags &lt;&lt; CAMEL_URL_PART_HIDDEN)))
332
332
</pre>
349
349
</table></div>
350
350
</div>
351
351
<hr>
352
 
<div class="refsect2" lang="en">
 
352
<div class="refsect2" title="CAMEL_PROVIDER_NEEDS()">
353
353
<a name="CAMEL-PROVIDER-NEEDS:CAPS"></a><h3>CAMEL_PROVIDER_NEEDS()</h3>
354
354
<pre class="programlisting">#define CAMEL_PROVIDER_NEEDS(prov, flags) (prov-&gt;url_flags &amp; (flags &lt;&lt; CAMEL_URL_PART_NEED))
355
355
</pre>
372
372
</table></div>
373
373
</div>
374
374
<hr>
375
 
<div class="refsect2" lang="en">
 
375
<div class="refsect2" title="CAMEL_PROVIDER_HIDDEN()">
376
376
<a name="CAMEL-PROVIDER-HIDDEN:CAPS"></a><h3>CAMEL_PROVIDER_HIDDEN()</h3>
377
377
<pre class="programlisting">#define CAMEL_PROVIDER_HIDDEN(prov, flags) (prov-&gt;url_flags &amp; (flags &lt;&lt; CAMEL_URL_PART_HIDDEN))
378
378
</pre>
395
395
</table></div>
396
396
</div>
397
397
<hr>
398
 
<div class="refsect2" lang="en">
 
398
<div class="refsect2" title="CAMEL_URL_ALLOW_USER">
399
399
<a name="CAMEL-URL-ALLOW-USER:CAPS"></a><h3>CAMEL_URL_ALLOW_USER</h3>
400
400
<pre class="programlisting">#define CAMEL_URL_ALLOW_USER         (CAMEL_URL_PART_USER)
401
401
</pre>
403
403
</p>
404
404
</div>
405
405
<hr>
406
 
<div class="refsect2" lang="en">
 
406
<div class="refsect2" title="CAMEL_URL_ALLOW_AUTH">
407
407
<a name="CAMEL-URL-ALLOW-AUTH:CAPS"></a><h3>CAMEL_URL_ALLOW_AUTH</h3>
408
408
<pre class="programlisting">#define CAMEL_URL_ALLOW_AUTH         (CAMEL_URL_PART_AUTH)
409
409
</pre>
411
411
</p>
412
412
</div>
413
413
<hr>
414
 
<div class="refsect2" lang="en">
 
414
<div class="refsect2" title="CAMEL_URL_ALLOW_PASSWORD">
415
415
<a name="CAMEL-URL-ALLOW-PASSWORD:CAPS"></a><h3>CAMEL_URL_ALLOW_PASSWORD</h3>
416
416
<pre class="programlisting">#define CAMEL_URL_ALLOW_PASSWORD (CAMEL_URL_PART_PASSWORD)
417
417
</pre>
419
419
</p>
420
420
</div>
421
421
<hr>
422
 
<div class="refsect2" lang="en">
 
422
<div class="refsect2" title="CAMEL_URL_ALLOW_HOST">
423
423
<a name="CAMEL-URL-ALLOW-HOST:CAPS"></a><h3>CAMEL_URL_ALLOW_HOST</h3>
424
424
<pre class="programlisting">#define CAMEL_URL_ALLOW_HOST         (CAMEL_URL_PART_HOST)
425
425
</pre>
427
427
</p>
428
428
</div>
429
429
<hr>
430
 
<div class="refsect2" lang="en">
 
430
<div class="refsect2" title="CAMEL_URL_ALLOW_PORT">
431
431
<a name="CAMEL-URL-ALLOW-PORT:CAPS"></a><h3>CAMEL_URL_ALLOW_PORT</h3>
432
432
<pre class="programlisting">#define CAMEL_URL_ALLOW_PORT         (CAMEL_URL_PART_PORT)
433
433
</pre>
435
435
</p>
436
436
</div>
437
437
<hr>
438
 
<div class="refsect2" lang="en">
 
438
<div class="refsect2" title="CAMEL_URL_ALLOW_PATH">
439
439
<a name="CAMEL-URL-ALLOW-PATH:CAPS"></a><h3>CAMEL_URL_ALLOW_PATH</h3>
440
440
<pre class="programlisting">#define CAMEL_URL_ALLOW_PATH         (CAMEL_URL_PART_PATH)
441
441
</pre>
443
443
</p>
444
444
</div>
445
445
<hr>
446
 
<div class="refsect2" lang="en">
 
446
<div class="refsect2" title="CAMEL_URL_NEED_USER">
447
447
<a name="CAMEL-URL-NEED-USER:CAPS"></a><h3>CAMEL_URL_NEED_USER</h3>
448
448
<pre class="programlisting">#define CAMEL_URL_NEED_USER  (CAMEL_URL_PART_USER &lt;&lt; CAMEL_URL_PART_NEED)
449
449
</pre>
451
451
</p>
452
452
</div>
453
453
<hr>
454
 
<div class="refsect2" lang="en">
 
454
<div class="refsect2" title="CAMEL_URL_NEED_AUTH">
455
455
<a name="CAMEL-URL-NEED-AUTH:CAPS"></a><h3>CAMEL_URL_NEED_AUTH</h3>
456
456
<pre class="programlisting">#define CAMEL_URL_NEED_AUTH  (CAMEL_URL_PART_AUTH &lt;&lt; CAMEL_URL_PART_NEED)
457
457
</pre>
459
459
</p>
460
460
</div>
461
461
<hr>
462
 
<div class="refsect2" lang="en">
 
462
<div class="refsect2" title="CAMEL_URL_NEED_PASSWORD">
463
463
<a name="CAMEL-URL-NEED-PASSWORD:CAPS"></a><h3>CAMEL_URL_NEED_PASSWORD</h3>
464
464
<pre class="programlisting">#define CAMEL_URL_NEED_PASSWORD      (CAMEL_URL_PART_PASSWORD &lt;&lt; CAMEL_URL_PART_NEED)
465
465
</pre>
467
467
</p>
468
468
</div>
469
469
<hr>
470
 
<div class="refsect2" lang="en">
 
470
<div class="refsect2" title="CAMEL_URL_NEED_HOST">
471
471
<a name="CAMEL-URL-NEED-HOST:CAPS"></a><h3>CAMEL_URL_NEED_HOST</h3>
472
472
<pre class="programlisting">#define CAMEL_URL_NEED_HOST  (CAMEL_URL_PART_HOST &lt;&lt; CAMEL_URL_PART_NEED)
473
473
</pre>
475
475
</p>
476
476
</div>
477
477
<hr>
478
 
<div class="refsect2" lang="en">
 
478
<div class="refsect2" title="CAMEL_URL_NEED_PORT">
479
479
<a name="CAMEL-URL-NEED-PORT:CAPS"></a><h3>CAMEL_URL_NEED_PORT</h3>
480
480
<pre class="programlisting">#define CAMEL_URL_NEED_PORT  (CAMEL_URL_PART_PORT &lt;&lt; CAMEL_URL_PART_NEED)
481
481
</pre>
483
483
</p>
484
484
</div>
485
485
<hr>
486
 
<div class="refsect2" lang="en">
 
486
<div class="refsect2" title="CAMEL_URL_NEED_PATH">
487
487
<a name="CAMEL-URL-NEED-PATH:CAPS"></a><h3>CAMEL_URL_NEED_PATH</h3>
488
488
<pre class="programlisting">#define CAMEL_URL_NEED_PATH  (CAMEL_URL_PART_PATH &lt;&lt; CAMEL_URL_PART_NEED)
489
489
</pre>
491
491
</p>
492
492
</div>
493
493
<hr>
494
 
<div class="refsect2" lang="en">
 
494
<div class="refsect2" title="CAMEL_URL_NEED_PATH_DIR">
495
495
<a name="CAMEL-URL-NEED-PATH-DIR:CAPS"></a><h3>CAMEL_URL_NEED_PATH_DIR</h3>
496
496
<pre class="programlisting">#define CAMEL_URL_NEED_PATH_DIR  (CAMEL_URL_PART_PATH_DIR &lt;&lt; CAMEL_URL_PART_NEED)
497
497
</pre>
499
499
</p>
500
500
</div>
501
501
<hr>
502
 
<div class="refsect2" lang="en">
 
502
<div class="refsect2" title="CAMEL_URL_HIDDEN_USER">
503
503
<a name="CAMEL-URL-HIDDEN-USER:CAPS"></a><h3>CAMEL_URL_HIDDEN_USER</h3>
504
504
<pre class="programlisting">#define CAMEL_URL_HIDDEN_USER        (CAMEL_URL_PART_USER &lt;&lt; CAMEL_URL_PART_HIDDEN)
505
505
</pre>
507
507
</p>
508
508
</div>
509
509
<hr>
510
 
<div class="refsect2" lang="en">
 
510
<div class="refsect2" title="CAMEL_URL_HIDDEN_AUTH">
511
511
<a name="CAMEL-URL-HIDDEN-AUTH:CAPS"></a><h3>CAMEL_URL_HIDDEN_AUTH</h3>
512
512
<pre class="programlisting">#define CAMEL_URL_HIDDEN_AUTH        (CAMEL_URL_PART_AUTH &lt;&lt; CAMEL_URL_PART_HIDDEN)
513
513
</pre>
515
515
</p>
516
516
</div>
517
517
<hr>
518
 
<div class="refsect2" lang="en">
 
518
<div class="refsect2" title="CAMEL_URL_HIDDEN_PASSWORD">
519
519
<a name="CAMEL-URL-HIDDEN-PASSWORD:CAPS"></a><h3>CAMEL_URL_HIDDEN_PASSWORD</h3>
520
520
<pre class="programlisting">#define CAMEL_URL_HIDDEN_PASSWORD    (CAMEL_URL_PART_PASSWORD &lt;&lt; CAMEL_URL_PART_HIDDEN)
521
521
</pre>
523
523
</p>
524
524
</div>
525
525
<hr>
526
 
<div class="refsect2" lang="en">
 
526
<div class="refsect2" title="CAMEL_URL_HIDDEN_HOST">
527
527
<a name="CAMEL-URL-HIDDEN-HOST:CAPS"></a><h3>CAMEL_URL_HIDDEN_HOST</h3>
528
528
<pre class="programlisting">#define CAMEL_URL_HIDDEN_HOST        (CAMEL_URL_PART_HOST &lt;&lt; CAMEL_URL_PART_HIDDEN)
529
529
</pre>
531
531
</p>
532
532
</div>
533
533
<hr>
534
 
<div class="refsect2" lang="en">
 
534
<div class="refsect2" title="CAMEL_URL_HIDDEN_PORT">
535
535
<a name="CAMEL-URL-HIDDEN-PORT:CAPS"></a><h3>CAMEL_URL_HIDDEN_PORT</h3>
536
536
<pre class="programlisting">#define CAMEL_URL_HIDDEN_PORT        (CAMEL_URL_PART_PORT &lt;&lt; CAMEL_URL_PART_HIDDEN)
537
537
</pre>
539
539
</p>
540
540
</div>
541
541
<hr>
542
 
<div class="refsect2" lang="en">
 
542
<div class="refsect2" title="CAMEL_URL_HIDDEN_PATH">
543
543
<a name="CAMEL-URL-HIDDEN-PATH:CAPS"></a><h3>CAMEL_URL_HIDDEN_PATH</h3>
544
544
<pre class="programlisting">#define CAMEL_URL_HIDDEN_PATH        (CAMEL_URL_PART_PATH &lt;&lt; CAMEL_URL_PART_HIDDEN)
545
545
</pre>
547
547
</p>
548
548
</div>
549
549
<hr>
550
 
<div class="refsect2" lang="en">
 
550
<div class="refsect2" title="CAMEL_URL_FRAGMENT_IS_PATH">
551
551
<a name="CAMEL-URL-FRAGMENT-IS-PATH:CAPS"></a><h3>CAMEL_URL_FRAGMENT_IS_PATH</h3>
552
552
<pre class="programlisting">#define CAMEL_URL_FRAGMENT_IS_PATH  (1 &lt;&lt; 30) /* url uses fragment for folder name path, not path */
553
553
</pre>
555
555
</p>
556
556
</div>
557
557
<hr>
558
 
<div class="refsect2" lang="en">
 
558
<div class="refsect2" title="CAMEL_URL_PATH_IS_ABSOLUTE">
559
559
<a name="CAMEL-URL-PATH-IS-ABSOLUTE:CAPS"></a><h3>CAMEL_URL_PATH_IS_ABSOLUTE</h3>
560
560
<pre class="programlisting">#define CAMEL_URL_PATH_IS_ABSOLUTE (1 &lt;&lt; 31)
561
561
</pre>
563
563
</p>
564
564
</div>
565
565
<hr>
566
 
<div class="refsect2" lang="en">
 
566
<div class="refsect2" title="CAMEL_PROVIDER_IS_STORE_AND_TRANSPORT()">
567
567
<a name="CAMEL-PROVIDER-IS-STORE-AND-TRANSPORT:CAPS"></a><h3>CAMEL_PROVIDER_IS_STORE_AND_TRANSPORT()</h3>
568
568
<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])
569
569
</pre>
579
579
</table></div>
580
580
</div>
581
581
<hr>
582
 
<div class="refsect2" lang="en">
 
582
<div class="refsect2" title="enum CamelProviderConfType">
583
583
<a name="CamelProviderConfType"></a><h3>enum CamelProviderConfType</h3>
584
584
<pre class="programlisting">typedef enum {
585
585
        CAMEL_PROVIDER_CONF_END,
597
597
</p>
598
598
</div>
599
599
<hr>
600
 
<div class="refsect2" lang="en">
 
600
<div class="refsect2" title="CamelProviderConfEntry">
601
601
<a name="CamelProviderConfEntry"></a><h3>CamelProviderConfEntry</h3>
602
602
<pre class="programlisting">typedef struct {
603
603
        CamelProviderConfType type;
609
609
</p>
610
610
</div>
611
611
<hr>
612
 
<div class="refsect2" lang="en">
 
612
<div class="refsect2" title="CAMEL_PROVIDER_CONF_DEFAULT_USERNAME">
613
613
<a name="CAMEL-PROVIDER-CONF-DEFAULT-USERNAME:CAPS"></a><h3>CAMEL_PROVIDER_CONF_DEFAULT_USERNAME</h3>
614
614
<pre class="programlisting">#define CAMEL_PROVIDER_CONF_DEFAULT_USERNAME  { CAMEL_PROVIDER_CONF_LABEL, "username", NULL, N_("User_name:"), NULL }
615
615
</pre>
617
617
</p>
618
618
</div>
619
619
<hr>
620
 
<div class="refsect2" lang="en">
 
620
<div class="refsect2" title="CAMEL_PROVIDER_CONF_DEFAULT_HOSTNAME">
621
621
<a name="CAMEL-PROVIDER-CONF-DEFAULT-HOSTNAME:CAPS"></a><h3>CAMEL_PROVIDER_CONF_DEFAULT_HOSTNAME</h3>
622
622
<pre class="programlisting">#define CAMEL_PROVIDER_CONF_DEFAULT_HOSTNAME  { CAMEL_PROVIDER_CONF_LABEL, "hostname", NULL, N_("_Host:"), NULL }
623
623
</pre>
625
625
</p>
626
626
</div>
627
627
<hr>
628
 
<div class="refsect2" lang="en">
 
628
<div class="refsect2" title="CAMEL_PROVIDER_CONF_DEFAULT_PATH">
629
629
<a name="CAMEL-PROVIDER-CONF-DEFAULT-PATH:CAPS"></a><h3>CAMEL_PROVIDER_CONF_DEFAULT_PATH</h3>
630
630
<pre class="programlisting">#define CAMEL_PROVIDER_CONF_DEFAULT_PATH      { CAMEL_PROVIDER_CONF_ENTRY, "path", NULL, N_("_Path:"), "" }
631
631
</pre>
633
633
</p>
634
634
</div>
635
635
<hr>
636
 
<div class="refsect2" lang="en">
 
636
<div class="refsect2" title="CamelProviderAutoDetectFunc ()">
637
637
<a name="CamelProviderAutoDetectFunc"></a><h3>CamelProviderAutoDetectFunc ()</h3>
638
638
<pre class="programlisting"><span class="returnvalue">gint</span>                (*CamelProviderAutoDetectFunc)      (<em class="parameter"><code><a class="link" href="camel-camel-url.html#CamelURL" title="CamelURL"><span class="type">CamelURL</span></a> *url</code></em>,
639
639
                                                         <em class="parameter"><code><span class="type">GHashTable</span> **auto_detected</code></em>,
667
667
</table></div>
668
668
</div>
669
669
<hr>
670
 
<div class="refsect2" lang="en">
 
670
<div class="refsect2" title="CamelProviderModule">
671
671
<a name="CamelProviderModule"></a><h3>CamelProviderModule</h3>
672
672
<pre class="programlisting">typedef struct {
673
673
        gchar *path;
679
679
</p>
680
680
</div>
681
681
<hr>
682
 
<div class="refsect2" lang="en">
 
682
<div class="refsect2" title="camel_provider_init ()">
683
683
<a name="camel-provider-init"></a><h3>camel_provider_init ()</h3>
684
684
<pre class="programlisting"><span class="returnvalue">void</span>                camel_provider_init                 (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
685
685
<p>
694
694
</p>
695
695
<p>
696
696
TODO: This should be pathed?
697
 
TODO: This should be plugin-d?</p>
 
697
TODO: This should be plugin-d?
 
698
</p>
698
699
</div>
699
700
<hr>
700
 
<div class="refsect2" lang="en">
 
701
<div class="refsect2" title="camel_provider_load ()">
701
702
<a name="camel-provider-load"></a><h3>camel_provider_load ()</h3>
702
703
<pre class="programlisting"><span class="returnvalue">void</span>                camel_provider_load                 (<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>,
703
704
                                                         <em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex</code></em>);</pre>
704
705
<p>
705
706
Loads the provider at <em class="parameter"><code>path</code></em>, and calls its initialization function,
706
707
passing <em class="parameter"><code>session</code></em> as an argument. The provider should then register
707
 
itself with <em class="parameter"><code>session</code></em>.</p>
 
708
itself with <em class="parameter"><code>session</code></em>.
 
709
</p>
708
710
<div class="variablelist"><table border="0">
709
711
<col align="left" valign="top">
710
712
<tbody>
722
724
</table></div>
723
725
</div>
724
726
<hr>
725
 
<div class="refsect2" lang="en">
 
727
<div class="refsect2" title="camel_provider_register ()">
726
728
<a name="camel-provider-register"></a><h3>camel_provider_register ()</h3>
727
729
<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>
728
730
<p>
729
 
Registers a provider.</p>
 
731
Registers a provider.
 
732
</p>
730
733
<div class="variablelist"><table border="0">
731
734
<col align="left" valign="top">
732
735
<tbody><tr>
737
740
</table></div>
738
741
</div>
739
742
<hr>
740
 
<div class="refsect2" lang="en">
 
743
<div class="refsect2" title="camel_provider_list ()">
741
744
<a name="camel-provider-list"></a><h3>camel_provider_list ()</h3>
742
745
<pre class="programlisting"><span class="returnvalue">GList</span> *             camel_provider_list                 (<em class="parameter"><code><span class="type">gboolean</span> load</code></em>);</pre>
743
746
<p>
759
762
</table></div>
760
763
</div>
761
764
<hr>
762
 
<div class="refsect2" lang="en">
 
765
<div class="refsect2" title="camel_provider_get ()">
763
766
<a name="camel-provider-get"></a><h3>camel_provider_get ()</h3>
764
767
<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>,
765
768
                                                         <em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex</code></em>);</pre>
766
769
<p>
767
770
This returns the CamelProvider that would be used to handle
768
 
<em class="parameter"><code>url_string</code></em>, loading it in from disk if necessary.</p>
 
771
<em class="parameter"><code>url_string</code></em>, loading it in from disk if necessary.
 
772
</p>
769
773
<div class="variablelist"><table border="0">
770
774
<col align="left" valign="top">
771
775
<tbody>
788
792
</table></div>
789
793
</div>
790
794
<hr>
791
 
<div class="refsect2" lang="en">
 
795
<div class="refsect2" title="camel_provider_module_init ()">
792
796
<a name="camel-provider-module-init"></a><h3>camel_provider_module_init ()</h3>
793
797
<pre class="programlisting"><span class="returnvalue">void</span>                camel_provider_module_init          (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
794
798
<p>
795
799
</p>
796
800
</div>
797
801
<hr>
798
 
<div class="refsect2" lang="en">
 
802
<div class="refsect2" title="camel_provider_auto_detect ()">
799
803
<a name="camel-provider-auto-detect"></a><h3>camel_provider_auto_detect ()</h3>
800
804
<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>,
801
805
                                                         <em class="parameter"><code><a class="link" href="camel-camel-url.html#CamelURL" title="CamelURL"><span class="type">CamelURL</span></a> *url</code></em>,
813
817
auto-detect whatever it can and file them into <em class="parameter"><code>auto_detected</code></em>. If
814
818
for some reason it cannot auto-detect anything (not enough
815
819
information provided in <em class="parameter"><code>url</code></em>?) then <em class="parameter"><code>auto_detected</code></em> will be
816
 
set to <code class="literal">NULL</code> and an exception may be set to explain why it failed.</p>
 
820
set to <code class="literal">NULL</code> and an exception may be set to explain why it failed.
 
821
</p>
817
822
<div class="variablelist"><table border="0">
818
823
<col align="left" valign="top">
819
824
<tbody>