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
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CamelSession</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="Services.html" title="Services">
<link rel="next" href="camel-camel-provider.html" title="camel-provider">
<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="Services.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="camel-camel-provider.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#CamelSession.synopsis" class="shortcut">Top</a>
|
<a href="#CamelSession.description" class="shortcut">Description</a>
|
<a href="#CamelSession.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#CamelSession.properties" class="shortcut">Properties</a>
|
<a href="#CamelSession.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="CamelSession"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="CamelSession.top_of_page"></a>CamelSession</span></h2>
<p>CamelSession</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="CamelSession.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="CamelSession.html#CamelSession-struct" title="struct CamelSession">CamelSession</a>;
enum <a class="link" href="CamelSession.html#CamelSessionAlertType" title="enum CamelSessionAlertType">CamelSessionAlertType</a>;
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="CamelSession.html#camel-session-get-user-data-dir" title="camel_session_get_user_data_dir ()">camel_session_get_user_data_dir</a> (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>);
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="CamelSession.html#camel-session-get-user-cache-dir" title="camel_session_get_user_cache_dir ()">camel_session_get_user_cache_dir</a> (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelSession.html#camel-session-get-socks-proxy" title="camel_session_get_socks_proxy ()">camel_session_get_socks_proxy</a> (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *for_host</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **host_ret</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *port_ret</code></em>);
<a class="link" href="CamelService.html" title="CamelService"><span class="returnvalue">CamelService</span></a> * <a class="link" href="CamelSession.html#camel-session-add-service" title="camel_session_add_service ()">camel_session_add_service</a> (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uid</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *protocol</code></em>,
<em class="parameter"><code><a class="link" href="camel-camel-provider.html#CamelProviderType" title="enum CamelProviderType"><span class="type">CamelProviderType</span></a> type</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelSession.html#camel-session-remove-service" title="camel_session_remove_service ()">camel_session_remove_service</a> (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>);
<a class="link" href="CamelService.html" title="CamelService"><span class="returnvalue">CamelService</span></a> * <a class="link" href="CamelSession.html#camel-session-get-service" title="camel_session_get_service ()">camel_session_get_service</a> (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uid</code></em>);
<a class="link" href="CamelService.html" title="CamelService"><span class="returnvalue">CamelService</span></a> * <a class="link" href="CamelSession.html#camel-session-get-service-by-url" title="camel_session_get_service_by_url ()">camel_session_get_service_by_url</a> (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</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><a class="link" href="camel-camel-provider.html#CamelProviderType" title="enum CamelProviderType"><span class="type">CamelProviderType</span></a> type</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * <a class="link" href="CamelSession.html#camel-session-list-services" title="camel_session_list_services ()">camel_session_list_services</a> (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelSession.html#camel-session-remove-services" title="camel_session_remove_services ()">camel_session_remove_services</a> (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="CamelSession.html#camel-session-get-password" title="camel_session_get_password ()">camel_session_get_password</a> (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *prompt</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *item</code></em>,
<em class="parameter"><code><span class="type">guint32</span> flags</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="CamelSession.html#camel-session-forget-password" title="camel_session_forget_password ()">camel_session_forget_password</a> (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *item</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> <a class="link" href="CamelSession.html#camel-session-alert-user" title="camel_session_alert_user ()">camel_session_alert_user</a> (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code><a class="link" href="CamelSession.html#CamelSessionAlertType" title="enum CamelSessionAlertType"><span class="type">CamelSessionAlertType</span></a> type</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *prompt</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *button_captions</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="CamelSession.html#camel-session-build-password-prompt" title="camel_session_build_password_prompt ()">camel_session_build_password_prompt</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *type</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *user</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *host</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="CamelSession.html#camel-session-get-online" title="camel_session_get_online ()">camel_session_get_online</a> (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelSession.html#camel-session-set-online" title="camel_session_set_online ()">camel_session_set_online</a> (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> online</code></em>);
<a class="link" href="CamelFilterDriver.html" title="CamelFilterDriver"><span class="returnvalue">CamelFilterDriver</span></a> * <a class="link" href="CamelSession.html#camel-session-get-filter-driver" title="camel_session_get_filter_driver ()">camel_session_get_filter_driver</a> (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *type</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="CamelSession.html#camel-session-get-check-junk" title="camel_session_get_check_junk ()">camel_session_get_check_junk</a> (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelSession.html#camel-session-set-check-junk" title="camel_session_set_check_junk ()">camel_session_set_check_junk</a> (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> check_junk</code></em>);
<a class="link" href="CamelJunkFilter.html" title="CamelJunkFilter"><span class="returnvalue">CamelJunkFilter</span></a> * <a class="link" href="CamelSession.html#camel-session-get-junk-filter" title="camel_session_get_junk_filter ()">camel_session_get_junk_filter</a> (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelSession.html#camel-session-set-junk-filter" title="camel_session_set_junk_filter ()">camel_session_set_junk_filter</a> (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code><a class="link" href="CamelJunkFilter.html" title="CamelJunkFilter"><span class="type">CamelJunkFilter</span></a> *junk_filter</code></em>);
<span class="returnvalue">void</span> (<a class="link" href="CamelSession.html#CamelSessionCallback" title="CamelSessionCallback ()">*CamelSessionCallback</a>) (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelSession.html#camel-session-submit-job" title="camel_session_submit_job ()">camel_session_submit_job</a> (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code><a class="link" href="CamelSession.html#CamelSessionCallback" title="CamelSessionCallback ()"><span class="type">CamelSessionCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> notify</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="CamelSession.html#camel-session-get-network-available" title="camel_session_get_network_available ()">camel_session_get_network_available</a> (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelSession.html#camel-session-set-network-available" title="camel_session_set_network_available ()">camel_session_set_network_available</a> (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> network_available</code></em>);
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> * <a class="link" href="CamelSession.html#camel-session-get-junk-headers" title="camel_session_get_junk_headers ()">camel_session_get_junk_headers</a> (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelSession.html#camel-session-set-junk-headers" title="camel_session_set_junk_headers ()">camel_session_set_junk_headers</a> (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **headers</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **values</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> len</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="CamelSession.html#camel-session-lookup-addressbook" title="camel_session_lookup_addressbook ()">camel_session_lookup_addressbook</a> (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="CamelSession.html#camel-session-forward-to" title="camel_session_forward_to ()">camel_session_forward_to</a> (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code><a class="link" href="CamelFolder.html" title="CamelFolder"><span class="type">CamelFolder</span></a> *folder</code></em>,
<em class="parameter"><code><a class="link" href="CamelMimeMessage.html" title="CamelMimeMessage"><span class="type">CamelMimeMessage</span></a> *message</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *address</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
enum <a class="link" href="CamelSession.html#CamelSessionLock" title="enum CamelSessionLock">CamelSessionLock</a>;
<span class="returnvalue">void</span> <a class="link" href="CamelSession.html#camel-session-lock" title="camel_session_lock ()">camel_session_lock</a> (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code><a class="link" href="CamelSession.html#CamelSessionLock" title="enum CamelSessionLock"><span class="type">CamelSessionLock</span></a> lock</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelSession.html#camel-session-unlock" title="camel_session_unlock ()">camel_session_unlock</a> (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code><a class="link" href="CamelSession.html#CamelSessionLock" title="enum CamelSessionLock"><span class="type">CamelSessionLock</span></a> lock</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="CamelSession.html#camel-session-authenticate-sync" title="camel_session_authenticate_sync ()">camel_session_authenticate_sync</a> (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *mechanism</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelSession.html#camel-session-authenticate" title="camel_session_authenticate ()">camel_session_authenticate</a> (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *mechanism</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> io_priority</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="CamelSession.html#camel-session-authenticate-finish" title="camel_session_authenticate_finish ()">camel_session_authenticate_finish</a> (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *result</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="CamelSession.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----<a class="link" href="CamelObject.html" title="CamelObject">CamelObject</a>
+----CamelSession
</pre>
</div>
<div class="refsect1">
<a name="CamelSession.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="CamelSession.html#CamelSession--check-junk" title='The "check-junk" property'>check-junk</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct
"<a class="link" href="CamelSession.html#CamelSession--junk-filter" title='The "junk-filter" property'>junk-filter</a>" <a class="link" href="CamelJunkFilter.html" title="CamelJunkFilter"><span class="type">CamelJunkFilter</span></a>* : Read / Write
"<a class="link" href="CamelSession.html#CamelSession--network-available" title='The "network-available" property'>network-available</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct
"<a class="link" href="CamelSession.html#CamelSession--online" title='The "online" property'>online</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct
"<a class="link" href="CamelSession.html#CamelSession--user-cache-dir" title='The "user-cache-dir" property'>user-cache-dir</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct
"<a class="link" href="CamelSession.html#CamelSession--user-data-dir" title='The "user-data-dir" property'>user-data-dir</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct
</pre>
</div>
<div class="refsect1">
<a name="CamelSession.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="CamelSession.html#CamelSession-job-finished" title='The "job-finished" signal'>job-finished</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
"<a class="link" href="CamelSession.html#CamelSession-job-started" title='The "job-started" signal'>job-started</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
</pre>
</div>
<div class="refsect1">
<a name="CamelSession.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="CamelSession.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="CamelSession-struct"></a><h3>struct CamelSession</h3>
<pre class="programlisting">struct CamelSession;</pre>
</div>
<hr>
<div class="refsect2">
<a name="CamelSessionAlertType"></a><h3>enum CamelSessionAlertType</h3>
<pre class="programlisting">typedef enum {
CAMEL_SESSION_ALERT_INFO,
CAMEL_SESSION_ALERT_WARNING,
CAMEL_SESSION_ALERT_ERROR
} CamelSessionAlertType;
</pre>
</div>
<hr>
<div class="refsect2">
<a name="camel-session-get-user-data-dir"></a><h3>camel_session_get_user_data_dir ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * camel_session_get_user_data_dir (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>);</pre>
<p>
Returns the base directory under which to store user-specific mail data.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
<td>a <a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the base directory for mail data</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-session-get-user-cache-dir"></a><h3>camel_session_get_user_cache_dir ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * camel_session_get_user_cache_dir (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>);</pre>
<p>
Returns the base directory under which to store user-specific mail cache.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
<td>a <a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the base directory for mail cache</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.4</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-session-get-socks-proxy"></a><h3>camel_session_get_socks_proxy ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_session_get_socks_proxy (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *for_host</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **host_ret</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *port_ret</code></em>);</pre>
<p>
Queries the SOCKS proxy that is configured for a <em class="parameter"><code>session</code></em>. This will
put <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> in <em class="parameter"><code>hosts_ret</code></em> if there is no proxy configured or when
the <em class="parameter"><code>for_host</code></em> is listed in proxy ignore list.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
<td>A <a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>for_host</code></em> :</span></p></td>
<td>Host name to which the connection will be requested</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>host_ret</code></em> :</span></p></td>
<td>Location to return the SOCKS proxy hostname</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>port_ret</code></em> :</span></p></td>
<td>Location to return the SOCKS proxy port</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.32</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-session-add-service"></a><h3>camel_session_add_service ()</h3>
<pre class="programlisting"><a class="link" href="CamelService.html" title="CamelService"><span class="returnvalue">CamelService</span></a> * camel_session_add_service (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uid</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *protocol</code></em>,
<em class="parameter"><code><a class="link" href="camel-camel-provider.html#CamelProviderType" title="enum CamelProviderType"><span class="type">CamelProviderType</span></a> type</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Instantiates a new <a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> for <em class="parameter"><code>session</code></em>. The <em class="parameter"><code>uid</code></em> identifies the
service for future lookup. The <em class="parameter"><code>protocol</code></em> indicates which <a class="link" href="camel-camel-provider.html#CamelProvider" title="CamelProvider"><span class="type">CamelProvider</span></a>
holds the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> of the <a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> subclass to instantiate. The <em class="parameter"><code>type</code></em>
explicitly designates the service as a <a class="link" href="CamelStore.html" title="CamelStore"><span class="type">CamelStore</span></a> or <a class="link" href="CamelTransport.html" title="CamelTransport"><span class="type">CamelTransport</span></a>.
</p>
<p>
If the given <em class="parameter"><code>uid</code></em> has already been added, the existing <a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a>
with that <em class="parameter"><code>uid</code></em> is returned regardless of whether it agrees with the
given <em class="parameter"><code>protocol</code></em> and <em class="parameter"><code>type</code></em>.
</p>
<p>
If no <a class="link" href="camel-camel-provider.html#CamelProvider" title="CamelProvider"><span class="type">CamelProvider</span></a> is available to handle the given <em class="parameter"><code>protocol</code></em>, or
if the <a class="link" href="camel-camel-provider.html#CamelProvider" title="CamelProvider"><span class="type">CamelProvider</span></a> does not specify a valid <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> for <em class="parameter"><code>type</code></em>, the
function sets <em class="parameter"><code>error</code></em> and returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
<td>a <a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>uid</code></em> :</span></p></td>
<td>a unique identifier string</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>protocol</code></em> :</span></p></td>
<td>the service protocol</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>the service type</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> instance, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-session-remove-service"></a><h3>camel_session_remove_service ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_session_remove_service (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>);</pre>
<p>
Removes a <a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> previously added by <a class="link" href="CamelSession.html#camel-session-add-service" title="camel_session_add_service ()"><code class="function">camel_session_add_service()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
<td>a <a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
<td>the <a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> to remove</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-session-get-service"></a><h3>camel_session_get_service ()</h3>
<pre class="programlisting"><a class="link" href="CamelService.html" title="CamelService"><span class="returnvalue">CamelService</span></a> * camel_session_get_service (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uid</code></em>);</pre>
<p>
Looks up a <a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> by its unique identifier string. The service
must have been previously added using <a class="link" href="CamelSession.html#camel-session-add-service" title="camel_session_add_service ()"><code class="function">camel_session_add_service()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
<td>a <a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>uid</code></em> :</span></p></td>
<td>a unique identifier string</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> instance, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-session-get-service-by-url"></a><h3>camel_session_get_service_by_url ()</h3>
<pre class="programlisting"><a class="link" href="CamelService.html" title="CamelService"><span class="returnvalue">CamelService</span></a> * camel_session_get_service_by_url (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</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><a class="link" href="camel-camel-provider.html#CamelProviderType" title="enum CamelProviderType"><span class="type">CamelProviderType</span></a> type</code></em>);</pre>
<p>
Looks up a <a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> by trying to match its <a class="link" href="camel-camel-url.html#CamelURL" title="struct CamelURL"><span class="type">CamelURL</span></a> against the
given <em class="parameter"><code>url</code></em> and then checking that the object is of the desired <em class="parameter"><code>type</code></em>.
The service must have been previously added using
<a class="link" href="CamelSession.html#camel-session-add-service" title="camel_session_add_service ()"><code class="function">camel_session_add_service()</code></a>.
</p>
<p>
Note this function is significantly slower than <a class="link" href="CamelSession.html#camel-session-get-service" title="camel_session_get_service ()"><code class="function">camel_session_get_service()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
<td>a <a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a>
</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>type</code></em> :</span></p></td>
<td>a <a class="link" href="camel-camel-provider.html#CamelProviderType" title="enum CamelProviderType"><span class="type">CamelProviderType</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> instance, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-session-list-services"></a><h3>camel_session_list_services ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * camel_session_list_services (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>);</pre>
<p>
Returns a list of all <a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> objects previously added using
<a class="link" href="CamelSession.html#camel-session-add-service" title="camel_session_add_service ()"><code class="function">camel_session_add_service()</code></a>. Free the returned list using <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#g-list-free"><code class="function">g_list_free()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
<td>a <a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an unsorted list of <a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> objects</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-session-remove-services"></a><h3>camel_session_remove_services ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_session_remove_services (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>);</pre>
<p>
Removes all <a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> instances added by <a class="link" href="CamelSession.html#camel-session-add-service" title="camel_session_add_service ()"><code class="function">camel_session_add_service()</code></a>.
</p>
<p>
This can be useful during application shutdown to ensure all <a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a>
instances are freed properly, especially since <a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> instances are
prone to reference cycles.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
<td>a <a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-session-get-password"></a><h3>camel_session_get_password ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * camel_session_get_password (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *prompt</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *item</code></em>,
<em class="parameter"><code><span class="type">guint32</span> flags</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
This function is used by a <a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> to ask the application and
the user for a password or other authentication data.
</p>
<p>
<em class="parameter"><code>service</code></em> and <em class="parameter"><code>item</code></em> together uniquely identify the piece of data the
caller is concerned with.
</p>
<p>
<em class="parameter"><code>prompt</code></em> is a question to ask the user (if the application doesn't
already have the answer cached). If <code class="literal">CAMEL_SESSION_PASSWORD_SECRET</code>
is set, the user's input will not be echoed back.
</p>
<p>
If <code class="literal">CAMEL_SESSION_PASSWORD_STATIC</code> is set, it means the password returned
will be stored statically by the caller automatically, for the current
session.
</p>
<p>
The authenticator should set <em class="parameter"><code>error</code></em> to <a href="http://library.gnome.org/devel/gio/unstable/gio-GIOError.html#G-IO-ERROR-CANCELLED:CAPS"><code class="literal">G_IO_ERROR_CANCELLED</code></a> if
the user did not provide the information. The caller must <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>
the information returned when it is done with it.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
<td>a <a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
<td>the <a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> this query is being made by</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>prompt</code></em> :</span></p></td>
<td>prompt to provide to user</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td>an identifier, unique within this service, for the information</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
<td>
<code class="literal">CAMEL_SESSION_PASSWORD_REPROMPT</code>, the prompt should force a reprompt
<code class="literal">CAMEL_SESSION_PASSWORD_SECRET</code>, whether the password is secret
<code class="literal">CAMEL_SESSION_PASSWORD_STATIC</code>, the password is remembered externally</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the authentication information or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-session-forget-password"></a><h3>camel_session_forget_password ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> camel_session_forget_password (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *item</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
This function is used by a <a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> to tell the application
that the authentication information it provided via
<a class="link" href="CamelSession.html#camel-session-get-password" title="camel_session_get_password ()"><code class="function">camel_session_get_password()</code></a> 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.
</p>
<p>
<em class="parameter"><code>service</code></em> and <em class="parameter"><code>item</code></em> identify the rejected authentication information,
as with <a class="link" href="CamelSession.html#camel-session-get-password" title="camel_session_get_password ()"><code class="function">camel_session_get_password()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
<td>a <a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
<td>the <a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> rejecting the password</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td>an identifier, unique within this service, for the information</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on failure</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-session-alert-user"></a><h3>camel_session_alert_user ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> camel_session_alert_user (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code><a class="link" href="CamelSession.html#CamelSessionAlertType" title="enum CamelSessionAlertType"><span class="type">CamelSessionAlertType</span></a> type</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *prompt</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *button_captions</code></em>);</pre>
<p>
Presents the given <em class="parameter"><code>prompt</code></em> to the user, in the style indicated by
<em class="parameter"><code>type</code></em>. If <em class="parameter"><code>cancel</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the user will be able to accept or
cancel. Otherwise, the message is purely informational.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
<td>a <a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>the type of alert (info, warning, or error)</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>prompt</code></em> :</span></p></td>
<td>the message for the user</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>button_captions</code></em> :</span></p></td>
<td>List of button captions to use. If NULL, only "Dismiss" button is shown.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Index of pressed button from <em class="parameter"><code>button_captions</code></em>, -1 if NULL.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-session-build-password-prompt"></a><h3>camel_session_build_password_prompt ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * camel_session_build_password_prompt (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *type</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *user</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *host</code></em>);</pre>
<p>
Constructs a localized password prompt from <em class="parameter"><code>type</code></em>, <em class="parameter"><code>user</code></em> and <em class="parameter"><code>host</code></em>,
suitable for passing to <a class="link" href="CamelSession.html#camel-session-get-password" title="camel_session_get_password ()"><code class="function">camel_session_get_password()</code></a>. The resulting
string contains markup tags. Use <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> to free it.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>account type (e.g. "IMAP")</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
<td>user name for the account</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>host</code></em> :</span></p></td>
<td>host name for the account</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a newly-allocated password prompt string</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.22</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-session-get-online"></a><h3>camel_session_get_online ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> camel_session_get_online (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
<td>a <a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>whether or not <em class="parameter"><code>session</code></em> is online</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-session-set-online"></a><h3>camel_session_set_online ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_session_set_online (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> online</code></em>);</pre>
<p>
Sets the online status of <em class="parameter"><code>session</code></em> to <em class="parameter"><code>online</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>session</code></em> :</span></p></td>
<td>a <a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>online</code></em> :</span></p></td>
<td>whether or not the session should be online</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-session-get-filter-driver"></a><h3>camel_session_get_filter_driver ()</h3>
<pre class="programlisting"><a class="link" href="CamelFilterDriver.html" title="CamelFilterDriver"><span class="returnvalue">CamelFilterDriver</span></a> * camel_session_get_filter_driver (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *type</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
<td>a <a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>the type of filter (eg, "incoming")</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a filter driver, loaded with applicable rules</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-session-get-check-junk"></a><h3>camel_session_get_check_junk ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> camel_session_get_check_junk (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>);</pre>
<p>
Do we have to check incoming messages to be junk?
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
<td>a <a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>whether or not we are checking incoming messages for junk</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-session-set-check-junk"></a><h3>camel_session_set_check_junk ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_session_set_check_junk (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> check_junk</code></em>);</pre>
<p>
Set check_junk flag, if set, incoming mail will be checked for being junk.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
<td>a <a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>check_junk</code></em> :</span></p></td>
<td>whether to check incoming messages for junk</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-session-get-junk-filter"></a><h3>camel_session_get_junk_filter ()</h3>
<pre class="programlisting"><a class="link" href="CamelJunkFilter.html" title="CamelJunkFilter"><span class="returnvalue">CamelJunkFilter</span></a> * camel_session_get_junk_filter (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>);</pre>
<p>
Returns the <a class="link" href="CamelJunkFilter.html" title="CamelJunkFilter"><span class="type">CamelJunkFilter</span></a> instance used to classify messages as
junk or not junk during filtering.
</p>
<p>
Note that <a class="link" href="CamelJunkFilter.html" title="CamelJunkFilter"><span class="type">CamelJunkFilter</span></a> itself is just an interface. The application
must implement the interface and install a <a class="link" href="CamelJunkFilter.html" title="CamelJunkFilter"><span class="type">CamelJunkFilter</span></a> instance for
junk filtering to take place.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
<td>a <a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <a class="link" href="CamelJunkFilter.html" title="CamelJunkFilter"><span class="type">CamelJunkFilter</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-session-set-junk-filter"></a><h3>camel_session_set_junk_filter ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_session_set_junk_filter (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code><a class="link" href="CamelJunkFilter.html" title="CamelJunkFilter"><span class="type">CamelJunkFilter</span></a> *junk_filter</code></em>);</pre>
<p>
Installs the <a class="link" href="CamelJunkFilter.html" title="CamelJunkFilter"><span class="type">CamelJunkFilter</span></a> instance used to classify messages as
junk or not junk during filtering.
</p>
<p>
Note that <a class="link" href="CamelJunkFilter.html" title="CamelJunkFilter"><span class="type">CamelJunkFilter</span></a> itself is just an interface. The application
must implement the interface and install a <a class="link" href="CamelJunkFilter.html" title="CamelJunkFilter"><span class="type">CamelJunkFilter</span></a> instance for
junk filtering to take place.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
<td>a <a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>junk_filter</code></em> :</span></p></td>
<td>a <a class="link" href="CamelJunkFilter.html" title="CamelJunkFilter"><span class="type">CamelJunkFilter</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="CamelSessionCallback"></a><h3>CamelSessionCallback ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*CamelSessionCallback) (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
This is the callback signature for jobs submitted to the CamelSession
via <a class="link" href="CamelSession.html#camel-session-submit-job" title="camel_session_submit_job ()"><code class="function">camel_session_submit_job()</code></a>. The <em class="parameter"><code>error</code></em> pointer is always non-<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>,
so it's safe to dereference to check if a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> has been set.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
<td>a <a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>a <a class="link" href="camel-camel-operation.html#CamelOperation" title="struct CamelOperation"><span class="type">CamelOperation</span></a> cast as a <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>data passed to <a class="link" href="CamelSession.html#camel-session-submit-job" title="camel_session_submit_job ()"><code class="function">camel_session_submit_job()</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-session-submit-job"></a><h3>camel_session_submit_job ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_session_submit_job (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code><a class="link" href="CamelSession.html#CamelSessionCallback" title="CamelSessionCallback ()"><span class="type">CamelSessionCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> notify</code></em>);</pre>
<p>
This function provides a simple mechanism for providers to initiate
low-priority background jobs. Jobs can be submitted from any thread,
but execution of the jobs is always as follows:
</p>
<p>
1) The <span class="type">"job-started"</span> signal is emitted from the thread
in which <em class="parameter"><code>session</code></em> was created. This is typically the same thread
that hosts the global default <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a>, or "main" thread.
</p>
<p>
2) The <em class="parameter"><code>callback</code></em> function is invoked from a different thread where
it's safe to call synchronous functions.
</p>
<p>
3) Once <em class="parameter"><code>callback</code></em> has returned, the <span class="type">"job-finished"</span> signal
is emitted from the same thread as <span class="type">"job-started"</span> was
emitted.
</p>
<p>
4) Finally if a <em class="parameter"><code>notify</code></em> function was provided, it is invoked and
passed <em class="parameter"><code>user_data</code></em> so that <em class="parameter"><code>user_data</code></em> can be freed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
<td>a <a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td>a <a class="link" href="CamelSession.html#CamelSessionCallback" title="CamelSessionCallback ()"><span class="type">CamelSessionCallback</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data passed to the callback</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>notify</code></em> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> function</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.2</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-session-get-network-available"></a><h3>camel_session_get_network_available ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> camel_session_get_network_available (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
<td>a <a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.32</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-session-set-network-available"></a><h3>camel_session_set_network_available ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_session_set_network_available (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> network_available</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
<td>a <a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>network_available</code></em> :</span></p></td>
<td>whether a network is available</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.32</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-session-get-junk-headers"></a><h3>camel_session_get_junk_headers ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> * camel_session_get_junk_headers (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>);</pre>
<p class="since">Since 2.22</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-session-set-junk-headers"></a><h3>camel_session_set_junk_headers ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_session_set_junk_headers (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **headers</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **values</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> len</code></em>);</pre>
<p class="since">Since 2.22</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-session-lookup-addressbook"></a><h3>camel_session_lookup_addressbook ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> camel_session_lookup_addressbook (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
<p class="since">Since 2.22</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-session-forward-to"></a><h3>camel_session_forward_to ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> camel_session_forward_to (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code><a class="link" href="CamelFolder.html" title="CamelFolder"><span class="type">CamelFolder</span></a> *folder</code></em>,
<em class="parameter"><code><a class="link" href="CamelMimeMessage.html" title="CamelMimeMessage"><span class="type">CamelMimeMessage</span></a> *message</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *address</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p class="since">Since 2.26</p>
</div>
<hr>
<div class="refsect2">
<a name="CamelSessionLock"></a><h3>enum CamelSessionLock</h3>
<pre class="programlisting">typedef enum {
CAMEL_SESSION_SESSION_LOCK,
CAMEL_SESSION_THREAD_LOCK
} CamelSessionLock;
</pre>
<p class="since">Since 2.32</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-session-lock"></a><h3>camel_session_lock ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_session_lock (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code><a class="link" href="CamelSession.html#CamelSessionLock" title="enum CamelSessionLock"><span class="type">CamelSessionLock</span></a> lock</code></em>);</pre>
<p>
Locks <em class="parameter"><code>session</code></em>'s <em class="parameter"><code>lock</code></em>. Unlock it with <a class="link" href="CamelSession.html#camel-session-unlock" title="camel_session_unlock ()"><code class="function">camel_session_unlock()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
<td>a <a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>lock</code></em> :</span></p></td>
<td>lock type to lock</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.32</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-session-unlock"></a><h3>camel_session_unlock ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_session_unlock (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code><a class="link" href="CamelSession.html#CamelSessionLock" title="enum CamelSessionLock"><span class="type">CamelSessionLock</span></a> lock</code></em>);</pre>
<p>
Unlocks <em class="parameter"><code>session</code></em>'s <em class="parameter"><code>lock</code></em>, previously locked with <a class="link" href="CamelSession.html#camel-session-lock" title="camel_session_lock ()"><code class="function">camel_session_lock()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
<td>a <a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>lock</code></em> :</span></p></td>
<td>lock type to unlock</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.32</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-session-authenticate-sync"></a><h3>camel_session_authenticate_sync ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> camel_session_authenticate_sync (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *mechanism</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Authenticates <em class="parameter"><code>service</code></em>, which may involve repeated calls to
<a class="link" href="CamelService.html#camel-service-authenticate" title="camel_service_authenticate ()"><code class="function">camel_service_authenticate()</code></a> or <a class="link" href="CamelService.html#camel-service-authenticate-sync" title="camel_service_authenticate_sync ()"><code class="function">camel_service_authenticate_sync()</code></a>.
A <a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> subclass is largely responsible for implementing this,
and should handle things like user prompts and secure password storage.
These issues are out-of-scope for Camel.
</p>
<p>
If an error occurs, or if authentication is aborted, the function sets
<em class="parameter"><code>error</code></em> and returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
<td>a <a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
<td>a <a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mechanism</code></em> :</span></p></td>
<td>a SASL mechanism name, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>optional <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> object, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on failure</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.4</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-session-authenticate"></a><h3>camel_session_authenticate ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_session_authenticate (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *mechanism</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> io_priority</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>
Asynchronously authenticates <em class="parameter"><code>service</code></em>, which may involve repeated calls
to <a class="link" href="CamelService.html#camel-service-authenticate" title="camel_service_authenticate ()"><code class="function">camel_service_authenticate()</code></a> or <a class="link" href="CamelService.html#camel-service-authenticate-sync" title="camel_service_authenticate_sync ()"><code class="function">camel_service_authenticate_sync()</code></a>.
A <a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> subclass is largely responsible for implementing this,
and should handle things like user prompts and secure password storage.
These issues are out-of-scope for Camel.
</p>
<p>
When the operation is finished, <em class="parameter"><code>callback</code></em> will be called. You can
then call <a class="link" href="CamelSession.html#camel-session-authenticate-finish" title="camel_session_authenticate_finish ()"><code class="function">camel_session_authenticate_finish()</code></a> to get the result of
the operation.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
<td>a <a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
<td>a <a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mechanism</code></em> :</span></p></td>
<td>a SASL mechanism name, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>io_priority</code></em> :</span></p></td>
<td>the I/O priority for the request</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>optional <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> object, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> to call when the request is satisfied</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>data to pass to the callback function</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.4</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-session-authenticate-finish"></a><h3>camel_session_authenticate_finish ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> camel_session_authenticate_finish (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *result</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Finishes the operation started with <a class="link" href="CamelSession.html#camel-session-authenticate" title="camel_session_authenticate ()"><code class="function">camel_session_authenticate()</code></a>.
</p>
<p>
If an error occurred, or if authentication was aborted, the function
sets <em class="parameter"><code>error</code></em> and returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
<td>a <a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on failure</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.4</p>
</div>
</div>
<div class="refsect1">
<a name="CamelSession.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="CamelSession--check-junk"></a><h3>The <code class="literal">"check-junk"</code> property</h3>
<pre class="programlisting"> "check-junk" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct</pre>
<p>Check incoming messages for junk.</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="CamelSession--junk-filter"></a><h3>The <code class="literal">"junk-filter"</code> property</h3>
<pre class="programlisting"> "junk-filter" <a class="link" href="CamelJunkFilter.html" title="CamelJunkFilter"><span class="type">CamelJunkFilter</span></a>* : Read / Write</pre>
<p>Classifies messages as junk or not junk.</p>
</div>
<hr>
<div class="refsect2">
<a name="CamelSession--network-available"></a><h3>The <code class="literal">"network-available"</code> property</h3>
<pre class="programlisting"> "network-available" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct</pre>
<p>Whether the network is available.</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="CamelSession--online"></a><h3>The <code class="literal">"online"</code> property</h3>
<pre class="programlisting"> "online" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct</pre>
<p>Whether the shell is online.</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="CamelSession--user-cache-dir"></a><h3>The <code class="literal">"user-cache-dir"</code> property</h3>
<pre class="programlisting"> "user-cache-dir" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct</pre>
<p>User-specific base directory for mail cache.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="CamelSession--user-data-dir"></a><h3>The <code class="literal">"user-data-dir"</code> property</h3>
<pre class="programlisting"> "user-data-dir" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct</pre>
<p>User-specific base directory for mail data.</p>
<p>Default value: NULL</p>
</div>
</div>
<div class="refsect1">
<a name="CamelSession.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="CamelSession-job-finished"></a><h3>The <code class="literal">"job-finished"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *camelsession,
<a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *arg1,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> arg2,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
</div>
<hr>
<div class="refsect2">
<a name="CamelSession-job-started"></a><h3>The <code class="literal">"job-started"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *camelsession,
<a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *arg1,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|
