← Back to branch summary

~ubuntu-branches/ubuntu/precise/evolution-data-server/precise

« back to all changes in this revision

Viewing changes to docs/reference/camel/html/CamelSession.html

  • Committer: Bazaar Package Importer
  • Author(s): Mathieu Trudel-Lapierre
  • Date: 2011-07-27 11:45:30 UTC
  • mfrom: (1.1.90 upstream)
  • Revision ID: james.westby@ubuntu.com-20110727114530-v4ntbu728os68b0b
Tags: 3.1.4-0ubuntu1
* New upstream version.
* debian/patches/999git_EDS_3_1_3_1_to_f94a069.patch: drop, included in
  the upstream 3.1.4 tarball.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/camel/html/CamelSession.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>CamelSession</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7
7
<link rel="home" href="index.html" title="Camel Reference Manual">
8
8
<link rel="up" href="Services.html" title="Services">
9
9
<link rel="prev" href="Services.html" title="Services">
10
10
<link rel="next" href="camel-camel-provider.html" title="camel-provider">
11
 
<meta name="generator" content="GTK-Doc V1.17.1 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
45
45
<a name="CamelSession.synopsis"></a><h2>Synopsis</h2>
46
46
<pre class="synopsis">struct              <a class="link" href="CamelSession.html#CamelSession-struct" title="struct CamelSession">CamelSession</a>;
47
47
enum                <a class="link" href="CamelSession.html#CamelSessionAlertType" title="enum CamelSessionAlertType">CamelSessionAlertType</a>;
48
 
const <span class="returnvalue">gchar</span> *       <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>);
 
48
const <span class="returnvalue">gchar</span> *        <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>);
49
49
<span class="returnvalue">void</span>                <a class="link" href="CamelSession.html#camel-session-set-socks-proxy" title="camel_session_set_socks_proxy ()">camel_session_set_socks_proxy</a>       (<em class="parameter"><code><a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> *session</code></em>,
50
50
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *socks_host</code></em>,
51
51
                                                         <em class="parameter"><code><span class="type">gint</span> socks_port</code></em>);
52
52
<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>,
53
53
                                                         <em class="parameter"><code><span class="type">gchar</span> **host_ret</code></em>,
54
54
                                                         <em class="parameter"><code><span class="type">gint</span> *port_ret</code></em>);
55
 
<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>,
 
55
<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>,
56
56
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *uid</code></em>,
57
57
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *uri_string</code></em>,
58
58
                                                         <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>,
59
59
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
60
 
<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>,
 
60
<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>,
61
61
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *uid</code></em>);
62
62
<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>,
63
63
                                                         <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>,
64
64
                                                         <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>);
65
 
<span class="returnvalue">GList</span> *             <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>);
66
 
<span class="returnvalue">gchar</span> *             <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>,
 
65
<span class="returnvalue">GList</span> *                           <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>);
 
66
<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>);
 
67
<span class="returnvalue">gchar</span> *                           <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>,
67
68
                                                         <em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>,
68
69
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *prompt</code></em>,
69
70
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *item</code></em>,
89
90
<span class="returnvalue">gboolean</span>            <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>);
90
91
<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>,
91
92
                                                         <em class="parameter"><code><span class="type">gboolean</span> check_junk</code></em>);
 
93
<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>);
 
94
<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>,
 
95
                                                         <em class="parameter"><code><a class="link" href="CamelJunkFilter.html" title="CamelJunkFilter"><span class="type">CamelJunkFilter</span></a> *junk_filter</code></em>);
92
96
<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>,
93
97
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
94
98
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
131
135
<a name="CamelSession.properties"></a><h2>Properties</h2>
132
136
<pre class="synopsis">
133
137
  "<a class="link" href="CamelSession.html#CamelSession--check-junk" title='The "check-junk" property'>check-junk</a>"               <span class="type">gboolean</span>              : Read / Write / Construct
 
138
  "<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
134
139
  "<a class="link" href="CamelSession.html#CamelSession--network-available" title='The "network-available" property'>network-available</a>"        <span class="type">gboolean</span>              : Read / Write / Construct
135
140
  "<a class="link" href="CamelSession.html#CamelSession--online" title='The "online" property'>online</a>"                   <span class="type">gboolean</span>              : Read / Write / Construct
136
141
  "<a class="link" href="CamelSession.html#CamelSession--user-data-dir" title='The "user-data-dir" property'>user-data-dir</a>"            <span class="type">gchar</span>*                : Read / Write / Construct
171
176
<hr>
172
177
<div class="refsect2">
173
178
<a name="camel-session-get-user-data-dir"></a><h3>camel_session_get_user_data_dir ()</h3>
174
 
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       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>
 
179
<pre class="programlisting">const <span class="returnvalue">gchar</span> *            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>
175
180
<p>
176
181
Returns the base directory under which to store user-specific mail data.
177
182
</p>
211
216
</tr>
212
217
<tr>
213
218
<td><p><span class="term"><em class="parameter"><code>socks_host</code></em> :</span></p></td>
214
 
<td>Hostname of the SOCKS proxy, or <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> for none.</td>
 
219
<td>Hostname of the SOCKS proxy, or <code class="literal">NULL</code> for none.</td>
215
220
</tr>
216
221
<tr>
217
222
<td><p><span class="term"><em class="parameter"><code>socks_port</code></em> :</span></p></td>
229
234
                                                         <em class="parameter"><code><span class="type">gint</span> *port_ret</code></em>);</pre>
230
235
<p>
231
236
Queries the SOCKS proxy that is configured for a <em class="parameter"><code>session</code></em>.  This will
232
 
put <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> in <em class="parameter"><code>hosts_ret</code></em> if there is no proxy configured.
 
237
put <code class="literal">NULL</code> in <em class="parameter"><code>hosts_ret</code></em> if there is no proxy configured.
233
238
</p>
234
239
<div class="variablelist"><table border="0">
235
240
<col align="left" valign="top">
254
259
<hr>
255
260
<div class="refsect2">
256
261
<a name="camel-session-add-service"></a><h3>camel_session_add_service ()</h3>
257
 
<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>,
 
262
<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>,
258
263
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *uid</code></em>,
259
264
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *uri_string</code></em>,
260
265
                                                         <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>,
272
277
</p>
273
278
<p>
274
279
If the <em class="parameter"><code>uri_string</code></em> is invalid or no <a class="link" href="camel-camel-provider.html#CamelProvider" title="CamelProvider"><span class="type">CamelProvider</span></a> is available to
275
 
handle the <em class="parameter"><code>uri_string</code></em>, the function sets <em class="parameter"><code>error</code></em> and returns <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>.
 
280
handle the <em class="parameter"><code>uri_string</code></em>, the function sets <em class="parameter"><code>error</code></em> and returns <code class="literal">NULL</code>.
276
281
</p>
277
282
<div class="variablelist"><table border="0">
278
283
<col align="left" valign="top">
298
303
</tr>
299
304
<tr>
300
305
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
301
 
<td>return location for a <span class="type">GError</span>, or <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
 
306
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
302
307
</td>
303
308
</tr>
304
309
<tr>
305
310
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
306
 
<td>a <a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> instance, or <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
 
311
<td>a <a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> instance, or <code class="literal">NULL</code>
307
312
</td>
308
313
</tr>
309
314
</tbody>
313
318
<hr>
314
319
<div class="refsect2">
315
320
<a name="camel-session-get-service"></a><h3>camel_session_get_service ()</h3>
316
 
<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>,
 
321
<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>,
317
322
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *uid</code></em>);</pre>
318
323
<p>
319
324
Looks up a <a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> by its unique identifier string.  The service
333
338
</tr>
334
339
<tr>
335
340
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
336
 
<td>a <a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> instance, or <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
 
341
<td>a <a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> instance, or <code class="literal">NULL</code>
337
342
</td>
338
343
</tr>
339
344
</tbody>
374
379
</tr>
375
380
<tr>
376
381
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
377
 
<td>a <a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> instance, or <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
 
382
<td>a <a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> instance, or <code class="literal">NULL</code>
378
383
</td>
379
384
</tr>
380
385
</tbody>
384
389
<hr>
385
390
<div class="refsect2">
386
391
<a name="camel-session-list-services"></a><h3>camel_session_list_services ()</h3>
387
 
<pre class="programlisting"><span class="returnvalue">GList</span> *             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>
 
392
<pre class="programlisting"><span class="returnvalue">GList</span> *                       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>
388
393
<p>
389
394
Returns a list of all <a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> objects previously added using
390
395
<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 <code class="function">g_list_free()</code>.
406
411
</div>
407
412
<hr>
408
413
<div class="refsect2">
 
414
<a name="camel-session-remove-services"></a><h3>camel_session_remove_services ()</h3>
 
415
<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>
 
416
<p>
 
417
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>.
 
418
</p>
 
419
<p>
 
420
This can be useful during application shutdown to ensure all <a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a>
 
421
instances are freed properly, especially since <a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a> instances are
 
422
prone to reference cycles.
 
423
</p>
 
424
<div class="variablelist"><table border="0">
 
425
<col align="left" valign="top">
 
426
<tbody><tr>
 
427
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
 
428
<td>a <a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a>
 
429
</td>
 
430
</tr></tbody>
 
431
</table></div>
 
432
<p class="since">Since 3.2</p>
 
433
</div>
 
434
<hr>
 
435
<div class="refsect2">
409
436
<a name="camel-session-get-password"></a><h3>camel_session_get_password ()</h3>
410
 
<pre class="programlisting"><span class="returnvalue">gchar</span> *             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>,
 
437
<pre class="programlisting"><span class="returnvalue">gchar</span> *                       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>,
411
438
                                                         <em class="parameter"><code><a class="link" href="CamelService.html" title="CamelService"><span class="type">CamelService</span></a> *service</code></em>,
412
439
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *prompt</code></em>,
413
440
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *item</code></em>,
465
492
</tr>
466
493
<tr>
467
494
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
468
 
<td>return location for a <span class="type">GError</span>, or <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
 
495
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
469
496
</td>
470
497
</tr>
471
498
<tr>
472
499
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
473
 
<td>the authentication information or <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
 
500
<td>the authentication information or <code class="literal">NULL</code>
474
501
</td>
475
502
</tr>
476
503
</tbody>
512
539
</tr>
513
540
<tr>
514
541
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
515
 
<td>return location for a <span class="type">GError</span>, or <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
 
542
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
516
543
</td>
517
544
</tr>
518
545
<tr>
660
687
</tr>
661
688
<tr>
662
689
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
663
 
<td>return location for a <span class="type">GError</span>, or <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
 
690
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
664
691
</td>
665
692
</tr>
666
693
<tr>
717
744
</div>
718
745
<hr>
719
746
<div class="refsect2">
 
747
<a name="camel-session-get-junk-filter"></a><h3>camel_session_get_junk_filter ()</h3>
 
748
<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>
 
749
<p>
 
750
Returns the <a class="link" href="CamelJunkFilter.html" title="CamelJunkFilter"><span class="type">CamelJunkFilter</span></a> instance used to classify messages as
 
751
junk or not junk during filtering.
 
752
</p>
 
753
<p>
 
754
Note that <a class="link" href="CamelJunkFilter.html" title="CamelJunkFilter"><span class="type">CamelJunkFilter</span></a> itself is just an interface.  The application
 
755
must implement the interface and install a <a class="link" href="CamelJunkFilter.html" title="CamelJunkFilter"><span class="type">CamelJunkFilter</span></a> instance for
 
756
junk filtering to take place.
 
757
</p>
 
758
<div class="variablelist"><table border="0">
 
759
<col align="left" valign="top">
 
760
<tbody>
 
761
<tr>
 
762
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
 
763
<td>a <a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a>
 
764
</td>
 
765
</tr>
 
766
<tr>
 
767
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
768
<td>a <a class="link" href="CamelJunkFilter.html" title="CamelJunkFilter"><span class="type">CamelJunkFilter</span></a>, or <code class="literal">NULL</code>
 
769
</td>
 
770
</tr>
 
771
</tbody>
 
772
</table></div>
 
773
<p class="since">Since 3.2</p>
 
774
</div>
 
775
<hr>
 
776
<div class="refsect2">
 
777
<a name="camel-session-set-junk-filter"></a><h3>camel_session_set_junk_filter ()</h3>
 
778
<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>,
 
779
                                                         <em class="parameter"><code><a class="link" href="CamelJunkFilter.html" title="CamelJunkFilter"><span class="type">CamelJunkFilter</span></a> *junk_filter</code></em>);</pre>
 
780
<p>
 
781
Installs the <a class="link" href="CamelJunkFilter.html" title="CamelJunkFilter"><span class="type">CamelJunkFilter</span></a> instance used to classify messages as
 
782
junk or not junk during filtering.
 
783
</p>
 
784
<p>
 
785
Note that <a class="link" href="CamelJunkFilter.html" title="CamelJunkFilter"><span class="type">CamelJunkFilter</span></a> itself is just an interface.  The application
 
786
must implement the interface and install a <a class="link" href="CamelJunkFilter.html" title="CamelJunkFilter"><span class="type">CamelJunkFilter</span></a> instance for
 
787
junk filtering to take place.
 
788
</p>
 
789
<div class="variablelist"><table border="0">
 
790
<col align="left" valign="top">
 
791
<tbody><tr>
 
792
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
 
793
<td>a <a class="link" href="CamelSession.html" title="CamelSession"><span class="type">CamelSession</span></a>
 
794
</td>
 
795
</tr></tbody>
 
796
</table></div>
 
797
<p class="since">Since 3.2</p>
 
798
</div>
 
799
<hr>
 
800
<div class="refsect2">
720
801
<a name="CamelSessionCallback"></a><h3>CamelSessionCallback ()</h3>
721
802
<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>,
722
803
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
724
805
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
725
806
<p>
726
807
This is the callback signature for jobs submitted to the CamelSession
727
 
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="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>,
 
808
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-<code class="literal">NULL</code>,
728
809
so it's safe to dereference to check if a <span class="type">GError</span> has been set.
729
810
</p>
730
811
<div class="variablelist"><table border="0">
939
1020
</div>
940
1021
<hr>
941
1022
<div class="refsect2">
 
1023
<a name="CamelSession--junk-filter"></a><h3>The <code class="literal">"junk-filter"</code> property</h3>
 
1024
<pre class="programlisting">  "junk-filter"              <a class="link" href="CamelJunkFilter.html" title="CamelJunkFilter"><span class="type">CamelJunkFilter</span></a>*      : Read / Write</pre>
 
1025
<p>Classifies messages as junk or not junk.</p>
 
1026
</div>
 
1027
<hr>
 
1028
<div class="refsect2">
942
1029
<a name="CamelSession--network-available"></a><h3>The <code class="literal">"network-available"</code> property</h3>
943
1030
<pre class="programlisting">  "network-available"        <span class="type">gboolean</span>              : Read / Write / Construct</pre>
944
1031
<p>Whether the network is available.</p>
1009
1096
</div>
1010
1097
<div class="footer">
1011
1098
<hr>
1012
 
          Generated by GTK-Doc V1.17.1</div>
 
1099
          Generated by GTK-Doc V1.17</div>
1013
1100
</body>
1014
1101
</html>
 
 
b'\\ No newline at end of file'