4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>CamelOfflineFolder</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
7
<link rel="home" href="index.html" title="Camel Reference Manual">
8
8
<link rel="up" href="Folders.html" title="Folders">
9
9
<link rel="prev" href="camel-camel-folder-thread.html" title="camel-folder-thread">
10
10
<link rel="next" href="CamelOfflineJournal.html" title="CamelOfflineJournal">
11
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
42
42
<div class="refsynopsisdiv">
43
43
<a name="CamelOfflineFolder.synopsis"></a><h2>Synopsis</h2>
44
44
<pre class="synopsis">struct <a class="link" href="CamelOfflineFolder.html#CamelOfflineFolder-struct" title="struct CamelOfflineFolder">CamelOfflineFolder</a>;
45
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="CamelOfflineFolder.html#camel-offline-folder-get-offline-sync" title="camel_offline_folder_get_offline_sync ()">camel_offline_folder_get_offline_sync</a>
45
<span class="returnvalue">gboolean</span> <a class="link" href="CamelOfflineFolder.html#camel-offline-folder-get-offline-sync" title="camel_offline_folder_get_offline_sync ()">camel_offline_folder_get_offline_sync</a>
46
46
(<em class="parameter"><code><a class="link" href="CamelOfflineFolder.html" title="CamelOfflineFolder"><span class="type">CamelOfflineFolder</span></a> *folder</code></em>);
47
47
<span class="returnvalue">void</span> <a class="link" href="CamelOfflineFolder.html#camel-offline-folder-set-offline-sync" title="camel_offline_folder_set_offline_sync ()">camel_offline_folder_set_offline_sync</a>
48
48
(<em class="parameter"><code><a class="link" href="CamelOfflineFolder.html" title="CamelOfflineFolder"><span class="type">CamelOfflineFolder</span></a> *folder</code></em>,
49
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> offline_sync</code></em>);
50
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="CamelOfflineFolder.html#camel-offline-folder-downsync-sync" title="camel_offline_folder_downsync_sync ()">camel_offline_folder_downsync_sync</a> (<em class="parameter"><code><a class="link" href="CamelOfflineFolder.html" title="CamelOfflineFolder"><span class="type">CamelOfflineFolder</span></a> *folder</code></em>,
51
<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> *expression</code></em>,
52
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
53
<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>);
49
<em class="parameter"><code><span class="type">gboolean</span> offline_sync</code></em>);
50
<span class="returnvalue">gboolean</span> <a class="link" href="CamelOfflineFolder.html#camel-offline-folder-downsync-sync" title="camel_offline_folder_downsync_sync ()">camel_offline_folder_downsync_sync</a> (<em class="parameter"><code><a class="link" href="CamelOfflineFolder.html" title="CamelOfflineFolder"><span class="type">CamelOfflineFolder</span></a> *folder</code></em>,
51
<em class="parameter"><code>const <span class="type">gchar</span> *expression</code></em>,
52
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
53
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
54
54
<span class="returnvalue">void</span> <a class="link" href="CamelOfflineFolder.html#camel-offline-folder-downsync" title="camel_offline_folder_downsync ()">camel_offline_folder_downsync</a> (<em class="parameter"><code><a class="link" href="CamelOfflineFolder.html" title="CamelOfflineFolder"><span class="type">CamelOfflineFolder</span></a> *folder</code></em>,
55
<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> *expression</code></em>,
56
<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>,
57
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
58
<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>,
59
<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>);
60
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="CamelOfflineFolder.html#camel-offline-folder-downsync-finish" title="camel_offline_folder_downsync_finish ()">camel_offline_folder_downsync_finish</a>
55
<em class="parameter"><code>const <span class="type">gchar</span> *expression</code></em>,
56
<em class="parameter"><code><span class="type">gint</span> io_priority</code></em>,
57
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
58
<em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
59
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
60
<span class="returnvalue">gboolean</span> <a class="link" href="CamelOfflineFolder.html#camel-offline-folder-downsync-finish" title="camel_offline_folder_downsync_finish ()">camel_offline_folder_downsync_finish</a>
61
61
(<em class="parameter"><code><a class="link" href="CamelOfflineFolder.html" title="CamelOfflineFolder"><span class="type">CamelOfflineFolder</span></a> *folder</code></em>,
62
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *result</code></em>,
63
<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>);
62
<em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
63
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
66
66
<div class="refsect1">
67
67
<a name="CamelOfflineFolder.object-hierarchy"></a><h2>Object Hierarchy</h2>
68
68
<pre class="synopsis">
69
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
70
70
+----<a class="link" href="CamelObject.html" title="CamelObject">CamelObject</a>
71
71
+----<a class="link" href="CamelFolder.html" title="CamelFolder">CamelFolder</a>
72
72
+----CamelOfflineFolder
132
132
<div class="refsect2">
133
133
<a name="camel-offline-folder-downsync-sync"></a><h3>camel_offline_folder_downsync_sync ()</h3>
134
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> camel_offline_folder_downsync_sync (<em class="parameter"><code><a class="link" href="CamelOfflineFolder.html" title="CamelOfflineFolder"><span class="type">CamelOfflineFolder</span></a> *folder</code></em>,
135
<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> *expression</code></em>,
136
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
137
<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>
134
<pre class="programlisting"><span class="returnvalue">gboolean</span> camel_offline_folder_downsync_sync (<em class="parameter"><code><a class="link" href="CamelOfflineFolder.html" title="CamelOfflineFolder"><span class="type">CamelOfflineFolder</span></a> *folder</code></em>,
135
<em class="parameter"><code>const <span class="type">gchar</span> *expression</code></em>,
136
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
137
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
139
139
Synchronizes messages in <em class="parameter"><code>folder</code></em> described by the search <em class="parameter"><code>expression</code></em> to
140
140
the local machine for offline availability.
151
151
<td><p><span class="term"><em class="parameter"><code>expression</code></em> :</span></p></td>
152
152
<td>search expression describing which set of messages
153
to downsync (<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for all)</td>
153
to downsync (<a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> for all)</td>
156
156
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
157
<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>
157
<td>optional <span class="type">GCancellable</span> object, or <a href="/home/chen/opt-unstable/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
161
161
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
162
<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>
162
<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>
166
166
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
168
<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 error</td>
168
<code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> on error</td>
175
175
<div class="refsect2">
176
176
<a name="camel-offline-folder-downsync"></a><h3>camel_offline_folder_downsync ()</h3>
177
177
<pre class="programlisting"><span class="returnvalue">void</span> camel_offline_folder_downsync (<em class="parameter"><code><a class="link" href="CamelOfflineFolder.html" title="CamelOfflineFolder"><span class="type">CamelOfflineFolder</span></a> *folder</code></em>,
178
<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> *expression</code></em>,
179
<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>,
180
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
181
<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>,
182
<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>
178
<em class="parameter"><code>const <span class="type">gchar</span> *expression</code></em>,
179
<em class="parameter"><code><span class="type">gint</span> io_priority</code></em>,
180
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
181
<em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
182
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
184
184
Synchronizes messages in <em class="parameter"><code>folder</code></em> described by the search <em class="parameter"><code>expression</code></em> to
185
185
the local machine asynchronously for offline availability.
210
210
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
211
<td>optional <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> object, or <code class="literal">NULl</code>
211
<td>optional <span class="type">GCancellable</span> object, or <code class="literal">NULl</code>
215
215
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
216
<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>
216
<td>a <span class="type">GAsyncReadyCallback</span> to call when the request is satisfied</td>
219
219
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
227
227
<div class="refsect2">
228
228
<a name="camel-offline-folder-downsync-finish"></a><h3>camel_offline_folder_downsync_finish ()</h3>
229
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> camel_offline_folder_downsync_finish
229
<pre class="programlisting"><span class="returnvalue">gboolean</span> camel_offline_folder_downsync_finish
230
230
(<em class="parameter"><code><a class="link" href="CamelOfflineFolder.html" title="CamelOfflineFolder"><span class="type">CamelOfflineFolder</span></a> *folder</code></em>,
231
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *result</code></em>,
232
<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>
231
<em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
232
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
234
234
Finishes the operation started with <a class="link" href="CamelOfflineFolder.html#camel-offline-folder-downsync" title="camel_offline_folder_downsync ()"><code class="function">camel_offline_folder_downsync()</code></a>.
245
245
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
246
<td>a <a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a>
246
<td>a <span class="type">GAsyncResult</span>
250
250
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
251
<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>
251
<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>
255
255
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
257
<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 error</td>
257
<code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> on error</td>