/usr/share/gtk-doc/html/camel/CamelDiscoFolder.html is in libcamel1.2-dev 3.2.3-0ubuntu7.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CamelDiscoFolder</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="Deprecated.html" title="Deprecated Objects">
<link rel="prev" href="CamelDiscoDiary.html" title="CamelDiscoDiary">
<link rel="next" href="CamelDiscoStore.html" title="CamelDiscoStore">
<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="CamelDiscoDiary.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="Deprecated.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="CamelDiscoStore.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#CamelDiscoFolder.synopsis" class="shortcut">Top</a>
|
<a href="#CamelDiscoFolder.description" class="shortcut">Description</a>
|
<a href="#CamelDiscoFolder.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="CamelDiscoFolder"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="CamelDiscoFolder.top_of_page"></a>CamelDiscoFolder</span></h2>
<p>CamelDiscoFolder</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="CamelDiscoFolder.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="CamelDiscoFolder.html#CamelDiscoFolder-struct" title="struct CamelDiscoFolder">CamelDiscoFolder</a>;
<span class="returnvalue">gboolean</span> <a class="link" href="CamelDiscoFolder.html#camel-disco-folder-get-offline-sync" title="camel_disco_folder_get_offline_sync ()">camel_disco_folder_get_offline_sync</a> (<em class="parameter"><code><a class="link" href="CamelDiscoFolder.html" title="CamelDiscoFolder"><span class="type">CamelDiscoFolder</span></a> *disco_folder</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelDiscoFolder.html#camel-disco-folder-set-offline-sync" title="camel_disco_folder_set_offline_sync ()">camel_disco_folder_set_offline_sync</a> (<em class="parameter"><code><a class="link" href="CamelDiscoFolder.html" title="CamelDiscoFolder"><span class="type">CamelDiscoFolder</span></a> *disco_folder</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> offline_sync</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="CamelDiscoFolder.html#camel-disco-folder-expunge-uids" title="camel_disco_folder_expunge_uids ()">camel_disco_folder_expunge_uids</a> (<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><span class="type">GPtrArray</span> *uids</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="CamelDiscoFolder.html#camel-disco-folder-cache-message" title="camel_disco_folder_cache_message ()">camel_disco_folder_cache_message</a> (<em class="parameter"><code><a class="link" href="CamelDiscoFolder.html" title="CamelDiscoFolder"><span class="type">CamelDiscoFolder</span></a> *disco_folder</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *uid</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="CamelDiscoFolder.html#camel-disco-folder-prepare-for-offline" title="camel_disco_folder_prepare_for_offline ()">camel_disco_folder_prepare_for_offline</a>
(<em class="parameter"><code><a class="link" href="CamelDiscoFolder.html" title="CamelDiscoFolder"><span class="type">CamelDiscoFolder</span></a> *disco_folder</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *expression</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="CamelDiscoFolder.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----<a class="link" href="CamelObject.html" title="CamelObject">CamelObject</a>
+----<a class="link" href="CamelFolder.html" title="CamelFolder">CamelFolder</a>
+----CamelDiscoFolder
</pre>
</div>
<div class="refsect1">
<a name="CamelDiscoFolder.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="CamelDiscoFolder.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="CamelDiscoFolder-struct"></a><h3>struct CamelDiscoFolder</h3>
<pre class="programlisting">struct CamelDiscoFolder;</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">CamelDiscoFolder</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-disco-folder-get-offline-sync"></a><h3>camel_disco_folder_get_offline_sync ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> camel_disco_folder_get_offline_sync (<em class="parameter"><code><a class="link" href="CamelDiscoFolder.html" title="CamelDiscoFolder"><span class="type">CamelDiscoFolder</span></a> *disco_folder</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">camel_disco_folder_get_offline_sync</code> is deprecated and should not be used in newly-written code.</p>
</div>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>disco_folder</code></em> :</span></p></td>
<td>a <a class="link" href="CamelDiscoFolder.html" title="CamelDiscoFolder"><span class="type">CamelDiscoFolder</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.32</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-disco-folder-set-offline-sync"></a><h3>camel_disco_folder_set_offline_sync ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_disco_folder_set_offline_sync (<em class="parameter"><code><a class="link" href="CamelDiscoFolder.html" title="CamelDiscoFolder"><span class="type">CamelDiscoFolder</span></a> *disco_folder</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> offline_sync</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">camel_disco_folder_set_offline_sync</code> is deprecated and should not be used in newly-written code.</p>
</div>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>disco_folder</code></em> :</span></p></td>
<td>a <a class="link" href="CamelDiscoFolder.html" title="CamelDiscoFolder"><span class="type">CamelDiscoFolder</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>offline_sync</code></em> :</span></p></td>
<td>whether to synchronize for offline use</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.32</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-disco-folder-expunge-uids"></a><h3>camel_disco_folder_expunge_uids ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> camel_disco_folder_expunge_uids (<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><span class="type">GPtrArray</span> *uids</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">camel_disco_folder_expunge_uids</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
This expunges the messages in <em class="parameter"><code>uids</code></em> from <em class="parameter"><code>folder</code></em>. It should take
whatever steps are needed to avoid expunging any other messages,
although in some cases it may not be possible to avoid expunging
messages that are marked deleted by another client at the same time
as the expunge_uids call is running.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>folder</code></em> :</span></p></td>
<td>a (disconnectable) folder</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>uids</code></em> :</span></p></td>
<td>array of UIDs to expunge</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>optional <span class="type">GCancellable</span> object, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> on failure</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-disco-folder-cache-message"></a><h3>camel_disco_folder_cache_message ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> camel_disco_folder_cache_message (<em class="parameter"><code><a class="link" href="CamelDiscoFolder.html" title="CamelDiscoFolder"><span class="type">CamelDiscoFolder</span></a> *disco_folder</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *uid</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">camel_disco_folder_cache_message</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Requests that <em class="parameter"><code>disco_folder</code></em> cache message <em class="parameter"><code>uid</code></em> to disk.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>disco_folder</code></em> :</span></p></td>
<td>the folder</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>uid</code></em> :</span></p></td>
<td>the UID of the message to cache</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>optional <span class="type">GCancellable</span> object, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> on failure</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-disco-folder-prepare-for-offline"></a><h3>camel_disco_folder_prepare_for_offline ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> camel_disco_folder_prepare_for_offline
(<em class="parameter"><code><a class="link" href="CamelDiscoFolder.html" title="CamelDiscoFolder"><span class="type">CamelDiscoFolder</span></a> *disco_folder</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *expression</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">camel_disco_folder_prepare_for_offline</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
This prepares <em class="parameter"><code>disco_folder</code></em> for offline operation, by downloading
the bodies of all messages described by <em class="parameter"><code>expression</code></em> (using the
same syntax as <a class="link" href="CamelFolder.html#camel-folder-search-by-expression" title="camel_folder_search_by_expression ()"><code class="function">camel_folder_search_by_expression()</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>disco_folder</code></em> :</span></p></td>
<td>the folder</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>expression</code></em> :</span></p></td>
<td>an expression describing messages to synchronize, or <code class="literal">NULL</code>
if all messages should be sync'ed.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>optional <span class="type">GCancellable</span> object, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> on failure</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|