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
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
|
<refentry id="camel-CamelSession">
<refmeta>
<refentrytitle role="top_of_page" id="camel-CamelSession.top_of_page">CamelSession</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>CAMEL Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>CamelSession</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="camel-CamelSession.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
struct <link linkend="CamelSession">CamelSession</link>;
<link linkend="gboolean">gboolean</link> (<link linkend="CamelTimeoutCallback">*CamelTimeoutCallback</link>) (<link linkend="gpointer">gpointer</link> data);
enum <link linkend="CamelSessionAlertType">CamelSessionAlertType</link>;
<link linkend="CamelSessionThreadOps">CamelSessionThreadOps</link>;
<link linkend="CamelSessionThreadMsg">CamelSessionThreadMsg</link>;
<link linkend="void">void</link> <link linkend="camel-session-construct">camel_session_construct</link> (<link linkend="CamelSession">CamelSession</link> *session,
const <link linkend="char">char</link> *storage_path);
<link linkend="CamelService">CamelService</link>* <link linkend="camel-session-get-service">camel_session_get_service</link> (<link linkend="CamelSession">CamelSession</link> *session,
const <link linkend="char">char</link> *url_string,
<link linkend="CamelProviderType">CamelProviderType</link> type,
<link linkend="CamelException">CamelException</link> *ex);
<link linkend="CamelService">CamelService</link>* <link linkend="camel-session-get-service-connected">camel_session_get_service_connected</link> (<link linkend="CamelSession">CamelSession</link> *session,
const <link linkend="char">char</link> *url_string,
<link linkend="CamelProviderType">CamelProviderType</link> type,
<link linkend="CamelException">CamelException</link> *ex);
#define <link linkend="camel-session-get-store">camel_session_get_store</link> (session, url_string, ex)
#define <link linkend="camel-session-get-transport">camel_session_get_transport</link> (session, url_string, ex)
<link linkend="char">char</link>* <link linkend="camel-session-get-storage-path">camel_session_get_storage_path</link> (<link linkend="CamelSession">CamelSession</link> *session,
<link linkend="CamelService">CamelService</link> *service,
<link linkend="CamelException">CamelException</link> *ex);
<link linkend="char">char</link>* <link linkend="camel-session-get-password">camel_session_get_password</link> (<link linkend="CamelSession">CamelSession</link> *session,
<link linkend="CamelService">CamelService</link> *service,
const <link linkend="char">char</link> *domain,
const <link linkend="char">char</link> *prompt,
const <link linkend="char">char</link> *item,
<link linkend="guint32">guint32</link> flags,
<link linkend="CamelException">CamelException</link> *ex);
<link linkend="void">void</link> <link linkend="camel-session-forget-password">camel_session_forget_password</link> (<link linkend="CamelSession">CamelSession</link> *session,
<link linkend="CamelService">CamelService</link> *service,
const <link linkend="char">char</link> *domain,
const <link linkend="char">char</link> *item,
<link linkend="CamelException">CamelException</link> *ex);
<link linkend="gboolean">gboolean</link> <link linkend="camel-session-alert-user">camel_session_alert_user</link> (<link linkend="CamelSession">CamelSession</link> *session,
<link linkend="CamelSessionAlertType">CamelSessionAlertType</link> type,
const <link linkend="char">char</link> *prompt,
<link linkend="gboolean">gboolean</link> cancel);
<link linkend="char">char</link>* <link linkend="camel-session-build-password-prompt">camel_session_build_password_prompt</link> (const <link linkend="char">char</link> *type,
const <link linkend="char">char</link> *user,
const <link linkend="char">char</link> *host);
<link linkend="gboolean">gboolean</link> <link linkend="camel-session-is-online">camel_session_is_online</link> (<link linkend="CamelSession">CamelSession</link> *session);
<link linkend="void">void</link> <link linkend="camel-session-set-online">camel_session_set_online</link> (<link linkend="CamelSession">CamelSession</link> *session,
<link linkend="gboolean">gboolean</link> online);
<link linkend="CamelFilterDriver">CamelFilterDriver</link>* <link linkend="camel-session-get-filter-driver">camel_session_get_filter_driver</link> (<link linkend="CamelSession">CamelSession</link> *session,
const <link linkend="char">char</link> *type,
<link linkend="CamelException">CamelException</link> *ex);
<link linkend="gboolean">gboolean</link> <link linkend="camel-session-check-junk">camel_session_check_junk</link> (<link linkend="CamelSession">CamelSession</link> *session);
<link linkend="void">void</link> <link linkend="camel-session-set-check-junk">camel_session_set_check_junk</link> (<link linkend="CamelSession">CamelSession</link> *session,
<link linkend="gboolean">gboolean</link> check_junk);
<link linkend="void">void</link>* <link linkend="camel-session-thread-msg-new">camel_session_thread_msg_new</link> (<link linkend="CamelSession">CamelSession</link> *session,
<link linkend="CamelSessionThreadOps">CamelSessionThreadOps</link> *ops,
unsigned <link linkend="int">int</link> size);
<link linkend="void">void</link> <link linkend="camel-session-thread-msg-free">camel_session_thread_msg_free</link> (<link linkend="CamelSession">CamelSession</link> *session,
<link linkend="CamelSessionThreadMsg">CamelSessionThreadMsg</link> *msg);
<link linkend="int">int</link> <link linkend="camel-session-thread-queue">camel_session_thread_queue</link> (<link linkend="CamelSession">CamelSession</link> *session,
<link linkend="CamelSessionThreadMsg">CamelSessionThreadMsg</link> *msg,
<link linkend="int">int</link> flags);
<link linkend="void">void</link> <link linkend="camel-session-thread-wait">camel_session_thread_wait</link> (<link linkend="CamelSession">CamelSession</link> *session,
<link linkend="int">int</link> id);
<link linkend="gboolean">gboolean</link> <link linkend="camel-session-get-network-state">camel_session_get_network_state</link> (<link linkend="CamelSession">CamelSession</link> *session);
<link linkend="void">void</link> <link linkend="camel-session-set-network-state">camel_session_set_network_state</link> (<link linkend="CamelSession">CamelSession</link> *session,
<link linkend="gboolean">gboolean</link> network_state);
const <link linkend="GHashTable">GHashTable</link>* <link linkend="camel-session-get-junk-headers">camel_session_get_junk_headers</link> (<link linkend="CamelSession">CamelSession</link> *session);
<link linkend="void">void</link> <link linkend="camel-session-set-junk-headers">camel_session_set_junk_headers</link> (<link linkend="CamelSession">CamelSession</link> *session,
const <link linkend="char">char</link> **headers,
const <link linkend="char">char</link> **values,
<link linkend="int">int</link> len);
<link linkend="gboolean">gboolean</link> <link linkend="camel-session-lookup-addressbook">camel_session_lookup_addressbook</link> (<link linkend="CamelSession">CamelSession</link> *session,
const <link linkend="char">char</link> *name);
</synopsis>
</refsynopsisdiv>
<refsect1 id="camel-CamelSession.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="camel-CamelSession.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="CamelSession" role="struct">
<title>struct CamelSession</title>
<indexterm zone="CamelSession"><primary>CamelSession</primary></indexterm><programlisting>struct CamelSession {
CamelObject parent_object;
struct _CamelSessionPrivate *priv;
char *storage_path;
CamelJunkPlugin *junk_plugin;
guint online:1;
guint check_junk:1;
guint network_state:1;
};
</programlisting>
<para>
</para></refsect2>
<refsect2 id="CamelTimeoutCallback" role="function">
<title>CamelTimeoutCallback ()</title>
<indexterm zone="CamelTimeoutCallback"><primary>CamelTimeoutCallback</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> (*CamelTimeoutCallback) (<link linkend="gpointer">gpointer</link> data);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>data</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="CamelSessionAlertType" role="enum">
<title>enum CamelSessionAlertType</title>
<indexterm zone="CamelSessionAlertType"><primary>CamelSessionAlertType</primary></indexterm><programlisting>typedef enum {
CAMEL_SESSION_ALERT_INFO,
CAMEL_SESSION_ALERT_WARNING,
CAMEL_SESSION_ALERT_ERROR
} CamelSessionAlertType;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="CamelSessionThreadOps" role="struct">
<title>CamelSessionThreadOps</title>
<indexterm zone="CamelSessionThreadOps"><primary>CamelSessionThreadOps</primary></indexterm><programlisting>typedef struct {
void (*receive)(CamelSession *session, struct _CamelSessionThreadMsg *m);
void (*free)(CamelSession *session, struct _CamelSessionThreadMsg *m);
} CamelSessionThreadOps;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="CamelSessionThreadMsg" role="struct">
<title>CamelSessionThreadMsg</title>
<indexterm zone="CamelSessionThreadMsg"><primary>CamelSessionThreadMsg</primary></indexterm><programlisting>typedef struct {
EMsg msg;
int id;
CamelException ex;
CamelSessionThreadOps *ops;
struct _CamelOperation *op;
CamelSession *session;
void *data; /* free for implementation to define, not used by camel, do not use in client code */
/* user fields follow */
} CamelSessionThreadMsg;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="camel-session-construct" role="function">
<title>camel_session_construct ()</title>
<indexterm zone="camel-session-construct"><primary>camel_session_construct</primary></indexterm><programlisting><link linkend="void">void</link> camel_session_construct (<link linkend="CamelSession">CamelSession</link> *session,
const <link linkend="char">char</link> *storage_path);</programlisting>
<para>
Constructs <parameter>session</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>session</parameter> :</term>
<listitem><simpara> a <link linkend="CamelSession"><type>CamelSession</type></link> object to construct
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>storage_path</parameter> :</term>
<listitem><simpara> path to a directory the session can use for
persistent storage. (This directory must already exist.)
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-session-get-service" role="function">
<title>camel_session_get_service ()</title>
<indexterm zone="camel-session-get-service"><primary>camel_session_get_service</primary></indexterm><programlisting><link linkend="CamelService">CamelService</link>* camel_session_get_service (<link linkend="CamelSession">CamelSession</link> *session,
const <link linkend="char">char</link> *url_string,
<link linkend="CamelProviderType">CamelProviderType</link> type,
<link linkend="CamelException">CamelException</link> *ex);</programlisting>
<para>
This resolves a <link linkend="CamelURL"><type>CamelURL</type></link> into a <link linkend="CamelService"><type>CamelService</type></link>, including loading the
provider library for that service if it has not already been loaded.
</para>
<para>
Services are cached, and asking for "the same" <parameter>url_string</parameter> multiple
times will return the same CamelService (with its reference count
incremented by one each time). What constitutes "the same" URL
depends in part on the provider.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>session</parameter> :</term>
<listitem><simpara> a <link linkend="CamelSession"><type>CamelSession</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>url_string</parameter> :</term>
<listitem><simpara> a <link linkend="CamelURL"><type>CamelURL</type></link> describing the service to get
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>type</parameter> :</term>
<listitem><simpara> the provider type (<link linkend="CAMEL-PROVIDER-STORE:CAPS"><type>CAMEL_PROVIDER_STORE</type></link> or
<link linkend="CAMEL-PROVIDER-TRANSPORT:CAPS"><type>CAMEL_PROVIDER_TRANSPORT</type></link>) to get, since some URLs may be able
to specify either type.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ex</parameter> :</term>
<listitem><simpara> a <link linkend="CamelException"><type>CamelException</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the requested <link linkend="CamelService"><type>CamelService</type></link>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-session-get-service-connected" role="function">
<title>camel_session_get_service_connected ()</title>
<indexterm zone="camel-session-get-service-connected"><primary>camel_session_get_service_connected</primary></indexterm><programlisting><link linkend="CamelService">CamelService</link>* camel_session_get_service_connected (<link linkend="CamelSession">CamelSession</link> *session,
const <link linkend="char">char</link> *url_string,
<link linkend="CamelProviderType">CamelProviderType</link> type,
<link linkend="CamelException">CamelException</link> *ex);</programlisting>
<para>
This works like <link linkend="camel-session-get-service"><type>camel_session_get_service</type></link>, but also ensures that
the returned service will have been successfully connected (via
<link linkend="camel-service-connect"><type>camel_service_connect</type></link>.)</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>session</parameter> :</term>
<listitem><simpara> a <link linkend="CamelSession"><type>CamelSession</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>url_string</parameter> :</term>
<listitem><simpara> a <link linkend="CamelURL"><type>CamelURL</type></link> describing the service to get
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>type</parameter> :</term>
<listitem><simpara> the provider type
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ex</parameter> :</term>
<listitem><simpara> a <link linkend="CamelException"><type>CamelException</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the requested <link linkend="CamelService"><type>CamelService</type></link>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-session-get-store" role="macro">
<title>camel_session_get_store()</title>
<indexterm zone="camel-session-get-store"><primary>camel_session_get_store</primary></indexterm><programlisting>#define camel_session_get_store(session, url_string, ex)</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>session</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>url_string</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ex</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-session-get-transport" role="macro">
<title>camel_session_get_transport()</title>
<indexterm zone="camel-session-get-transport"><primary>camel_session_get_transport</primary></indexterm><programlisting>#define camel_session_get_transport(session, url_string, ex)</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>session</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>url_string</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ex</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-session-get-storage-path" role="function">
<title>camel_session_get_storage_path ()</title>
<indexterm zone="camel-session-get-storage-path"><primary>camel_session_get_storage_path</primary></indexterm><programlisting><link linkend="char">char</link>* camel_session_get_storage_path (<link linkend="CamelSession">CamelSession</link> *session,
<link linkend="CamelService">CamelService</link> *service,
<link linkend="CamelException">CamelException</link> *ex);</programlisting>
<para>
This returns the path to a directory which the service can use for
its own purposes. Data stored there will remain between Evolution
sessions. No code outside of that service should ever touch the
files in this directory. If the directory does not exist, it will
be created.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>session</parameter> :</term>
<listitem><simpara> a <link linkend="CamelSession"><type>CamelSession</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>service</parameter> :</term>
<listitem><simpara> a <link linkend="CamelService"><type>CamelService</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ex</parameter> :</term>
<listitem><simpara> a <link linkend="CamelException"><type>CamelException</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the path (which the caller must free), or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if an error
occurs.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-session-get-password" role="function">
<title>camel_session_get_password ()</title>
<indexterm zone="camel-session-get-password"><primary>camel_session_get_password</primary></indexterm><programlisting><link linkend="char">char</link>* camel_session_get_password (<link linkend="CamelSession">CamelSession</link> *session,
<link linkend="CamelService">CamelService</link> *service,
const <link linkend="char">char</link> *domain,
const <link linkend="char">char</link> *prompt,
const <link linkend="char">char</link> *item,
<link linkend="guint32">guint32</link> flags,
<link linkend="CamelException">CamelException</link> *ex);</programlisting>
<para>
This function is used by a <link linkend="CamelService"><type>CamelService</type></link> to ask the application and
the user for a password or other authentication data.
</para>
<para>
<parameter>service</parameter> and <parameter>item</parameter> together uniquely identify the piece of data the
caller is concerned with.
</para>
<para>
<parameter>prompt</parameter> is a question to ask the user (if the application doesn't
already have the answer cached). If <link linkend="CAMEL-SESSION-PASSWORD-SECRET:CAPS"><type>CAMEL_SESSION_PASSWORD_SECRET</type></link>
is set, the user's input will not be echoed back.
</para>
<para>
If <link linkend="CAMEL-SESSION-PASSWORD-STATIC:CAPS"><type>CAMEL_SESSION_PASSWORD_STATIC</type></link> is set, it means the password returned
will be stored statically by the caller automatically, for the current
session.
</para>
<para>
The authenticator should set <parameter>ex</parameter> to <link linkend="CAMEL-EXCEPTION-USER-CANCEL:CAPS"><type>CAMEL_EXCEPTION_USER_CANCEL</type></link> if
the user did not provide the information. The caller must <link linkend="g-free"><type>g_free</type></link>
the information returned when it is done with it.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>session</parameter> :</term>
<listitem><simpara> a <link linkend="CamelSession"><type>CamelSession</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>service</parameter> :</term>
<listitem><simpara> the <link linkend="CamelService"><type>CamelService</type></link> this query is being made by
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>domain</parameter> :</term>
<listitem><simpara> domain of password request. May be null to use the default.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>prompt</parameter> :</term>
<listitem><simpara> prompt to provide to user
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>item</parameter> :</term>
<listitem><simpara> an identifier, unique within this service, for the information
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>flags</parameter> :</term>
<listitem><simpara> <link linkend="CAMEL-SESSION-PASSWORD-REPROMPT:CAPS"><type>CAMEL_SESSION_PASSWORD_REPROMPT</type></link>, the prompt should force a reprompt
<link linkend="CAMEL-SESSION-PASSWORD-SECRET:CAPS"><type>CAMEL_SESSION_PASSWORD_SECRET</type></link>, whether the password is secret
<link linkend="CAMEL-SESSION-PASSWORD-STATIC:CAPS"><type>CAMEL_SESSION_PASSWORD_STATIC</type></link>, the password is remembered externally
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ex</parameter> :</term>
<listitem><simpara> a <link linkend="CamelException"><type>CamelException</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the authentication information or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-session-forget-password" role="function">
<title>camel_session_forget_password ()</title>
<indexterm zone="camel-session-forget-password"><primary>camel_session_forget_password</primary></indexterm><programlisting><link linkend="void">void</link> camel_session_forget_password (<link linkend="CamelSession">CamelSession</link> *session,
<link linkend="CamelService">CamelService</link> *service,
const <link linkend="char">char</link> *domain,
const <link linkend="char">char</link> *item,
<link linkend="CamelException">CamelException</link> *ex);</programlisting>
<para>
This function is used by a <link linkend="CamelService"><type>CamelService</type></link> to tell the application
that the authentication information it provided via
<link linkend="camel-session-get-password"><type>camel_session_get_password</type></link> was rejected by the service. If the
application was caching this information, it should stop,
and if the service asks for it again, it should ask the user.
</para>
<para>
<parameter>service</parameter> and <parameter>item</parameter> identify the rejected authentication information,
as with <link linkend="camel-session-get-password"><type>camel_session_get_password</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>session</parameter> :</term>
<listitem><simpara> a <link linkend="CamelSession"><type>CamelSession</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>service</parameter> :</term>
<listitem><simpara> the <link linkend="CamelService"><type>CamelService</type></link> rejecting the password
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>domain</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>item</parameter> :</term>
<listitem><simpara> an identifier, unique within this service, for the information
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ex</parameter> :</term>
<listitem><simpara> a <link linkend="CamelException"><type>CamelException</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-session-alert-user" role="function">
<title>camel_session_alert_user ()</title>
<indexterm zone="camel-session-alert-user"><primary>camel_session_alert_user</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> camel_session_alert_user (<link linkend="CamelSession">CamelSession</link> *session,
<link linkend="CamelSessionAlertType">CamelSessionAlertType</link> type,
const <link linkend="char">char</link> *prompt,
<link linkend="gboolean">gboolean</link> cancel);</programlisting>
<para>
Presents the given <parameter>prompt</parameter> to the user, in the style indicated by
<parameter>type</parameter>. If <parameter>cancel</parameter> is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, the user will be able to accept or
cancel. Otherwise, the message is purely informational.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>session</parameter> :</term>
<listitem><simpara> a <link linkend="CamelSession"><type>CamelSession</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>type</parameter> :</term>
<listitem><simpara> the type of alert (info, warning, or error)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>prompt</parameter> :</term>
<listitem><simpara> the message for the user
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>cancel</parameter> :</term>
<listitem><simpara> whether or not to provide a "Cancel" option in addition to
an "OK" option.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>%TRUE if the user accepts, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if they cancel.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-session-build-password-prompt" role="function">
<title>camel_session_build_password_prompt ()</title>
<indexterm zone="camel-session-build-password-prompt"><primary>camel_session_build_password_prompt</primary></indexterm><programlisting><link linkend="char">char</link>* camel_session_build_password_prompt (const <link linkend="char">char</link> *type,
const <link linkend="char">char</link> *user,
const <link linkend="char">char</link> *host);</programlisting>
<para>
Constructs a localized password prompt from <parameter>type</parameter>, <parameter>user</parameter> and <parameter>host</parameter>,
suitable for passing to <link linkend="camel-session-get-password"><function>camel_session_get_password()</function></link>. The resulting
string contains markup tags. Use <link linkend="g-free"><function>g_free()</function></link> to free it.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>type</parameter> :</term>
<listitem><simpara> account type (e.g. "IMAP")
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user</parameter> :</term>
<listitem><simpara> user name for the account
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>host</parameter> :</term>
<listitem><simpara> host name for the account
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a newly-allocated password prompt string
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-session-is-online" role="function">
<title>camel_session_is_online ()</title>
<indexterm zone="camel-session-is-online"><primary>camel_session_is_online</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> camel_session_is_online (<link linkend="CamelSession">CamelSession</link> *session);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>session</parameter> :</term>
<listitem><simpara> a <link linkend="CamelSession"><type>CamelSession</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>whether or not <parameter>session</parameter> is online
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-session-set-online" role="function">
<title>camel_session_set_online ()</title>
<indexterm zone="camel-session-set-online"><primary>camel_session_set_online</primary></indexterm><programlisting><link linkend="void">void</link> camel_session_set_online (<link linkend="CamelSession">CamelSession</link> *session,
<link linkend="gboolean">gboolean</link> online);</programlisting>
<para>
Sets the online status of <parameter>session</parameter> to <parameter>online</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>session</parameter> :</term>
<listitem><simpara> a <link linkend="CamelSession"><type>CamelSession</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>online</parameter> :</term>
<listitem><simpara> whether or not the session should be online
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-session-get-filter-driver" role="function">
<title>camel_session_get_filter_driver ()</title>
<indexterm zone="camel-session-get-filter-driver"><primary>camel_session_get_filter_driver</primary></indexterm><programlisting><link linkend="CamelFilterDriver">CamelFilterDriver</link>* camel_session_get_filter_driver (<link linkend="CamelSession">CamelSession</link> *session,
const <link linkend="char">char</link> *type,
<link linkend="CamelException">CamelException</link> *ex);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>session</parameter> :</term>
<listitem><simpara> a <link linkend="CamelSession"><type>CamelSession</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>type</parameter> :</term>
<listitem><simpara> the type of filter (eg, "incoming")
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ex</parameter> :</term>
<listitem><simpara> a <link linkend="CamelException"><type>CamelException</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>a filter driver, loaded with applicable rules
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-session-check-junk" role="function">
<title>camel_session_check_junk ()</title>
<indexterm zone="camel-session-check-junk"><primary>camel_session_check_junk</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> camel_session_check_junk (<link linkend="CamelSession">CamelSession</link> *session);</programlisting>
<para>
Do we have to check incoming messages to be junk?</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>session</parameter> :</term>
<listitem><simpara> a <link linkend="CamelSession"><type>CamelSession</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>whether or not we are checking incoming messages for junk
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-session-set-check-junk" role="function">
<title>camel_session_set_check_junk ()</title>
<indexterm zone="camel-session-set-check-junk"><primary>camel_session_set_check_junk</primary></indexterm><programlisting><link linkend="void">void</link> camel_session_set_check_junk (<link linkend="CamelSession">CamelSession</link> *session,
<link linkend="gboolean">gboolean</link> check_junk);</programlisting>
<para>
Set check_junk flag, if set, incoming mail will be checked for being junk.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>session</parameter> :</term>
<listitem><simpara> a <link linkend="CamelSession"><type>CamelSession</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>check_junk</parameter> :</term>
<listitem><simpara> state
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-session-thread-msg-new" role="function">
<title>camel_session_thread_msg_new ()</title>
<indexterm zone="camel-session-thread-msg-new"><primary>camel_session_thread_msg_new</primary></indexterm><programlisting><link linkend="void">void</link>* camel_session_thread_msg_new (<link linkend="CamelSession">CamelSession</link> *session,
<link linkend="CamelSessionThreadOps">CamelSessionThreadOps</link> *ops,
unsigned <link linkend="int">int</link> size);</programlisting>
<para>
Create a new thread message, using ops as the receive/reply/free
ops, of <parameter>size</parameter> bytes.
</para>
<para>
<parameter>ops</parameter> points to the operations used to recieve/process and finally
free the message.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>session</parameter> :</term>
<listitem><simpara> a <link linkend="CamelSession"><type>CamelSession</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ops</parameter> :</term>
<listitem><simpara> thread operations
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>size</parameter> :</term>
<listitem><simpara> number of bytes
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>a new <link linkend="CamelSessionThreadMsg"><type>CamelSessionThreadMsg</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-session-thread-msg-free" role="function">
<title>camel_session_thread_msg_free ()</title>
<indexterm zone="camel-session-thread-msg-free"><primary>camel_session_thread_msg_free</primary></indexterm><programlisting><link linkend="void">void</link> camel_session_thread_msg_free (<link linkend="CamelSession">CamelSession</link> *session,
<link linkend="CamelSessionThreadMsg">CamelSessionThreadMsg</link> *msg);</programlisting>
<para>
Free a <parameter>msg</parameter>. Note that the message must have been allocated using
msg_new, and must nto have been submitted to any queue function.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>session</parameter> :</term>
<listitem><simpara> a <link linkend="CamelSession"><type>CamelSession</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>msg</parameter> :</term>
<listitem><simpara> a <link linkend="CamelSessionThreadMsg"><type>CamelSessionThreadMsg</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-session-thread-queue" role="function">
<title>camel_session_thread_queue ()</title>
<indexterm zone="camel-session-thread-queue"><primary>camel_session_thread_queue</primary></indexterm><programlisting><link linkend="int">int</link> camel_session_thread_queue (<link linkend="CamelSession">CamelSession</link> *session,
<link linkend="CamelSessionThreadMsg">CamelSessionThreadMsg</link> *msg,
<link linkend="int">int</link> flags);</programlisting>
<para>
Queue a thread message in another thread for processing.
The operation should be (but needn't) run in a queued manner
with other operations queued in this manner.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>session</parameter> :</term>
<listitem><simpara> a <link linkend="CamelSession"><type>CamelSession</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>msg</parameter> :</term>
<listitem><simpara> a <link linkend="CamelSessionThreadMsg"><type>CamelSessionThreadMsg</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>flags</parameter> :</term>
<listitem><simpara> queue type flags, currently 0.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the id of the operation queued
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-session-thread-wait" role="function">
<title>camel_session_thread_wait ()</title>
<indexterm zone="camel-session-thread-wait"><primary>camel_session_thread_wait</primary></indexterm><programlisting><link linkend="void">void</link> camel_session_thread_wait (<link linkend="CamelSession">CamelSession</link> *session,
<link linkend="int">int</link> id);</programlisting>
<para>
Wait on an operation to complete (by id).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>session</parameter> :</term>
<listitem><simpara> a <link linkend="CamelSession"><type>CamelSession</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>id</parameter> :</term>
<listitem><simpara> id of the operation to wait on
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-session-get-network-state" role="function">
<title>camel_session_get_network_state ()</title>
<indexterm zone="camel-session-get-network-state"><primary>camel_session_get_network_state</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> camel_session_get_network_state (<link linkend="CamelSession">CamelSession</link> *session);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>session</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-session-set-network-state" role="function">
<title>camel_session_set_network_state ()</title>
<indexterm zone="camel-session-set-network-state"><primary>camel_session_set_network_state</primary></indexterm><programlisting><link linkend="void">void</link> camel_session_set_network_state (<link linkend="CamelSession">CamelSession</link> *session,
<link linkend="gboolean">gboolean</link> network_state);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>session</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>network_state</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-session-get-junk-headers" role="function">
<title>camel_session_get_junk_headers ()</title>
<indexterm zone="camel-session-get-junk-headers"><primary>camel_session_get_junk_headers</primary></indexterm><programlisting>const <link linkend="GHashTable">GHashTable</link>* camel_session_get_junk_headers (<link linkend="CamelSession">CamelSession</link> *session);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>session</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-session-set-junk-headers" role="function">
<title>camel_session_set_junk_headers ()</title>
<indexterm zone="camel-session-set-junk-headers"><primary>camel_session_set_junk_headers</primary></indexterm><programlisting><link linkend="void">void</link> camel_session_set_junk_headers (<link linkend="CamelSession">CamelSession</link> *session,
const <link linkend="char">char</link> **headers,
const <link linkend="char">char</link> **values,
<link linkend="int">int</link> len);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>session</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>headers</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>values</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>len</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-session-lookup-addressbook" role="function">
<title>camel_session_lookup_addressbook ()</title>
<indexterm zone="camel-session-lookup-addressbook"><primary>camel_session_lookup_addressbook</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> camel_session_lookup_addressbook (<link linkend="CamelSession">CamelSession</link> *session,
const <link linkend="char">char</link> *name);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>session</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
