/usr/share/gtk-doc/html/camel/CamelIMAPXNamespaceResponse.html is in evolution-data-server-doc 3.22.7-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 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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CamelIMAPXNamespaceResponse: Camel Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Camel Reference Manual">
<link rel="up" href="IMAP.html" title="IMAP Service">
<link rel="prev" href="CamelIMAPXNamespace.html" title="CamelIMAPXNamespace">
<link rel="next" href="CamelIMAPXSearch.html" title="CamelIMAPXSearch">
<meta name="generator" content="GTK-Doc V1.25 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#CamelIMAPXNamespaceResponse.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#CamelIMAPXNamespaceResponse.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="IMAP.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="CamelIMAPXNamespace.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="CamelIMAPXSearch.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="CamelIMAPXNamespaceResponse"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="CamelIMAPXNamespaceResponse.top_of_page"></a>CamelIMAPXNamespaceResponse</span></h2>
<p>CamelIMAPXNamespaceResponse — Stores an IMAP NAMESPACE response</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="CamelIMAPXNamespaceResponse.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="CamelIMAPXNamespaceResponse.html" title="CamelIMAPXNamespaceResponse"><span class="returnvalue">CamelIMAPXNamespaceResponse</span></a> *
</td>
<td class="function_name">
<a class="link" href="CamelIMAPXNamespaceResponse.html#camel-imapx-namespace-response-new" title="camel_imapx_namespace_response_new ()">camel_imapx_namespace_response_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="CamelIMAPXNamespaceResponse.html" title="CamelIMAPXNamespaceResponse"><span class="returnvalue">CamelIMAPXNamespaceResponse</span></a> *
</td>
<td class="function_name">
<a class="link" href="CamelIMAPXNamespaceResponse.html#camel-imapx-namespace-response-faux-new" title="camel_imapx_namespace_response_faux_new ()">camel_imapx_namespace_response_faux_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
</td>
<td class="function_name">
<a class="link" href="CamelIMAPXNamespaceResponse.html#camel-imapx-namespace-response-list" title="camel_imapx_namespace_response_list ()">camel_imapx_namespace_response_list</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="CamelIMAPXNamespaceResponse.html#camel-imapx-namespace-response-add" title="camel_imapx_namespace_response_add ()">camel_imapx_namespace_response_add</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="CamelIMAPXNamespaceResponse.html#camel-imapx-namespace-response-remove" title="camel_imapx_namespace_response_remove ()">camel_imapx_namespace_response_remove</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="CamelIMAPXNamespace.html" title="CamelIMAPXNamespace"><span class="returnvalue">CamelIMAPXNamespace</span></a> *
</td>
<td class="function_name">
<a class="link" href="CamelIMAPXNamespaceResponse.html#camel-imapx-namespace-response-lookup" title="camel_imapx_namespace_response_lookup ()">camel_imapx_namespace_response_lookup</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="CamelIMAPXNamespace.html" title="CamelIMAPXNamespace"><span class="returnvalue">CamelIMAPXNamespace</span></a> *
</td>
<td class="function_name">
<a class="link" href="CamelIMAPXNamespaceResponse.html#camel-imapx-namespace-response-lookup-for-path" title="camel_imapx_namespace_response_lookup_for_path ()">camel_imapx_namespace_response_lookup_for_path</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="CamelIMAPXNamespaceResponse.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="CamelIMAPXNamespaceResponse.html#CamelIMAPXNamespaceResponse-struct" title="struct CamelIMAPXNamespaceResponse">CamelIMAPXNamespaceResponse</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="CamelIMAPXNamespaceResponse.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> CamelIMAPXNamespaceResponse
</pre>
</div>
<div class="refsect1">
<a name="CamelIMAPXNamespaceResponse.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <camel/camel.h>
</pre>
</div>
<div class="refsect1">
<a name="CamelIMAPXNamespaceResponse.description"></a><h2>Description</h2>
<p><a class="link" href="CamelIMAPXNamespaceResponse.html" title="CamelIMAPXNamespaceResponse"><span class="type">CamelIMAPXNamespaceResponse</span></a> encapsulates an IMAP NAMESPACE response,
which consists of a set of <a class="link" href="CamelIMAPXNamespace.html" title="CamelIMAPXNamespace"><span class="type">CamelIMAPXNamespace</span></a> objects grouped by
<a class="link" href="CamelIMAPXNamespace.html#CamelIMAPXNamespaceCategory" title="enum CamelIMAPXNamespaceCategory"><span class="type">CamelIMAPXNamespaceCategory</span></a>.</p>
</div>
<div class="refsect1">
<a name="CamelIMAPXNamespaceResponse.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="camel-imapx-namespace-response-new"></a><h3>camel_imapx_namespace_response_new ()</h3>
<pre class="programlisting"><a class="link" href="CamelIMAPXNamespaceResponse.html" title="CamelIMAPXNamespaceResponse"><span class="returnvalue">CamelIMAPXNamespaceResponse</span></a> *
camel_imapx_namespace_response_new (<em class="parameter"><code><a class="link" href="CamelIMAPXInputStream.html" title="CamelIMAPXInputStream"><span class="type">CamelIMAPXInputStream</span></a> *stream</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Attempts to parse an IMAP NAMESPACE response from <em class="parameter"><code>stream</code></em>
and, if
successful, stores the response data in a new <a class="link" href="CamelIMAPXNamespaceResponse.html" title="CamelIMAPXNamespaceResponse"><span class="type">CamelIMAPXNamespaceResponse</span></a>.
If an error occurs, the function sets <em class="parameter"><code>error</code></em>
and returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
<div class="refsect3">
<a name="camel-imapx-namespace-response-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>stream</p></td>
<td class="parameter_description"><p>a <a class="link" href="CamelIMAPXInputStream.html" title="CamelIMAPXInputStream"><span class="type">CamelIMAPXInputStream</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>optional <a href="/usr/share/gtk-doc/html/gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> object, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="camel-imapx-namespace-response-new.returns"></a><h4>Returns</h4>
<p> a <a class="link" href="CamelIMAPXNamespaceResponse.html" title="CamelIMAPXNamespaceResponse"><span class="type">CamelIMAPXNamespaceResponse</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.12.html" title="Index of new symbols in 3.12">3.12</a></p>
</div>
<hr>
<div class="refsect2">
<a name="camel-imapx-namespace-response-faux-new"></a><h3>camel_imapx_namespace_response_faux_new ()</h3>
<pre class="programlisting"><a class="link" href="CamelIMAPXNamespaceResponse.html" title="CamelIMAPXNamespaceResponse"><span class="returnvalue">CamelIMAPXNamespaceResponse</span></a> *
camel_imapx_namespace_response_faux_new
(<em class="parameter"><code><a class="link" href="CamelIMAPXListResponse.html" title="CamelIMAPXListResponse"><span class="type">CamelIMAPXListResponse</span></a> *list_response</code></em>);</pre>
<p>Fabricates a new <a class="link" href="CamelIMAPXNamespaceResponse.html" title="CamelIMAPXNamespaceResponse"><span class="type">CamelIMAPXNamespaceResponse</span></a> from <em class="parameter"><code>list_response</code></em>
.
The returned <a class="link" href="CamelIMAPXNamespaceResponse.html" title="CamelIMAPXNamespaceResponse"><span class="type">CamelIMAPXNamespaceResponse</span></a> will consist of a single
personal <a class="link" href="CamelIMAPXNamespace.html" title="CamelIMAPXNamespace"><span class="type">CamelIMAPXNamespace</span></a> with an empty mailbox prefix string,
and a mailbox separator character taken from <em class="parameter"><code>list_response</code></em>
.</p>
<p>Use this function when the IMAP server does not list the "NAMESPACE"
keyword in its CAPABILITY response.</p>
<div class="refsect3">
<a name="camel-imapx-namespace-response-faux-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>list_response</p></td>
<td class="parameter_description"><p>a <a class="link" href="CamelIMAPXListResponse.html" title="CamelIMAPXListResponse"><span class="type">CamelIMAPXListResponse</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="camel-imapx-namespace-response-faux-new.returns"></a><h4>Returns</h4>
<p> a <a class="link" href="CamelIMAPXNamespaceResponse.html" title="CamelIMAPXNamespaceResponse"><span class="type">CamelIMAPXNamespaceResponse</span></a></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.12.html" title="Index of new symbols in 3.12">3.12</a></p>
</div>
<hr>
<div class="refsect2">
<a name="camel-imapx-namespace-response-list"></a><h3>camel_imapx_namespace_response_list ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
camel_imapx_namespace_response_list (<em class="parameter"><code><a class="link" href="CamelIMAPXNamespaceResponse.html" title="CamelIMAPXNamespaceResponse"><span class="type">CamelIMAPXNamespaceResponse</span></a> *response</code></em>);</pre>
<p>Returns a list of IMAP namespaces in the order received from the IMAP
server, which means they are grouped by <a class="link" href="CamelIMAPXNamespace.html#CamelIMAPXNamespaceCategory" title="enum CamelIMAPXNamespaceCategory"><span class="type">CamelIMAPXNamespaceCategory</span></a>.</p>
<p>The namespaces returned in the list are referenced for thread-safety.
They must each be unreferenced with <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when finished with
them. Free the returned list itself with <a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#g-list-free"><code class="function">g_list_free()</code></a>.</p>
<p>An easy way to free the list properly in one step is as follows:</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="function"><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#g-list-free-full">g_list_free_full</a></span> <span class="gtkdoc opt">(</span>list<span class="gtkdoc opt">,</span> g_object_unref<span class="gtkdoc opt">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
<div class="refsect3">
<a name="camel-imapx-namespace-response-list.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>response</p></td>
<td class="parameter_description"><p>a <a class="link" href="CamelIMAPXNamespaceResponse.html" title="CamelIMAPXNamespaceResponse"><span class="type">CamelIMAPXNamespaceResponse</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="camel-imapx-namespace-response-list.returns"></a><h4>Returns</h4>
<p> a list of <a class="link" href="CamelIMAPXNamespace.html" title="CamelIMAPXNamespace"><span class="type">CamelIMAPXNamespace</span></a> instances</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.12.html" title="Index of new symbols in 3.12">3.12</a></p>
</div>
<hr>
<div class="refsect2">
<a name="camel-imapx-namespace-response-add"></a><h3>camel_imapx_namespace_response_add ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
camel_imapx_namespace_response_add (<em class="parameter"><code><a class="link" href="CamelIMAPXNamespaceResponse.html" title="CamelIMAPXNamespaceResponse"><span class="type">CamelIMAPXNamespaceResponse</span></a> *response</code></em>,
<em class="parameter"><code><a class="link" href="CamelIMAPXNamespace.html" title="CamelIMAPXNamespace"><span class="type">CamelIMAPXNamespace</span></a> *namespace</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="camel-imapx-namespace-response-remove"></a><h3>camel_imapx_namespace_response_remove ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
camel_imapx_namespace_response_remove (<em class="parameter"><code><a class="link" href="CamelIMAPXNamespaceResponse.html" title="CamelIMAPXNamespaceResponse"><span class="type">CamelIMAPXNamespaceResponse</span></a> *response</code></em>,
<em class="parameter"><code><a class="link" href="CamelIMAPXNamespace.html" title="CamelIMAPXNamespace"><span class="type">CamelIMAPXNamespace</span></a> *namespace</code></em>);</pre>
<p>Removes <em class="parameter"><code>namespace</code></em>
from the list of namespaces in the <em class="parameter"><code>response</code></em>
.
If no such namespace exists then does nothing.</p>
<div class="refsect3">
<a name="camel-imapx-namespace-response-remove.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>response</p></td>
<td class="parameter_description"><p>a <a class="link" href="CamelIMAPXNamespaceResponse.html" title="CamelIMAPXNamespaceResponse"><span class="type">CamelIMAPXNamespaceResponse</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>namespace</p></td>
<td class="parameter_description"><p>a <a class="link" href="CamelIMAPXNamespace.html" title="CamelIMAPXNamespace"><span class="type">CamelIMAPXNamespace</span></a> to remove</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3.16.html" title="Index of new symbols in 3.16">3.16</a></p>
</div>
<hr>
<div class="refsect2">
<a name="camel-imapx-namespace-response-lookup"></a><h3>camel_imapx_namespace_response_lookup ()</h3>
<pre class="programlisting"><a class="link" href="CamelIMAPXNamespace.html" title="CamelIMAPXNamespace"><span class="returnvalue">CamelIMAPXNamespace</span></a> *
camel_imapx_namespace_response_lookup (<em class="parameter"><code><a class="link" href="CamelIMAPXNamespaceResponse.html" title="CamelIMAPXNamespaceResponse"><span class="type">CamelIMAPXNamespaceResponse</span></a> *response</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *mailbox_name</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> separator</code></em>);</pre>
<p>Attempts to match <em class="parameter"><code>mailbox_name</code></em>
and <em class="parameter"><code>separator</code></em>
to a known IMAP namespace
and returns a <a class="link" href="CamelIMAPXNamespace.html" title="CamelIMAPXNamespace"><span class="type">CamelIMAPXNamespace</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no match was found.</p>
<p>The returned <a class="link" href="CamelIMAPXNamespace.html" title="CamelIMAPXNamespace"><span class="type">CamelIMAPXNamespace</span></a> is referenced for thread-safety and
should be unreferenced with <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when finished with it.</p>
<div class="refsect3">
<a name="camel-imapx-namespace-response-lookup.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>response</p></td>
<td class="parameter_description"><p>a <a class="link" href="CamelIMAPXNamespaceResponse.html" title="CamelIMAPXNamespaceResponse"><span class="type">CamelIMAPXNamespaceResponse</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>mailbox_name</p></td>
<td class="parameter_description"><p>a mailbox name</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>separator</p></td>
<td class="parameter_description"><p>a mailbox path separator character</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="camel-imapx-namespace-response-lookup.returns"></a><h4>Returns</h4>
<p> a <a class="link" href="CamelIMAPXNamespace.html" title="CamelIMAPXNamespace"><span class="type">CamelIMAPXNamespace</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.12.html" title="Index of new symbols in 3.12">3.12</a></p>
</div>
<hr>
<div class="refsect2">
<a name="camel-imapx-namespace-response-lookup-for-path"></a><h3>camel_imapx_namespace_response_lookup_for_path ()</h3>
<pre class="programlisting"><a class="link" href="CamelIMAPXNamespace.html" title="CamelIMAPXNamespace"><span class="returnvalue">CamelIMAPXNamespace</span></a> *
camel_imapx_namespace_response_lookup_for_path
(<em class="parameter"><code><a class="link" href="CamelIMAPXNamespaceResponse.html" title="CamelIMAPXNamespaceResponse"><span class="type">CamelIMAPXNamespaceResponse</span></a> *response</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *folder_path</code></em>);</pre>
<p>Attempts to match <em class="parameter"><code>folder_path</code></em>
to a known IMAP namespace and returns a
<a class="link" href="CamelIMAPXNamespace.html" title="CamelIMAPXNamespace"><span class="type">CamelIMAPXNamespace</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no match was found.</p>
<p>If the result is ambiguous, meaning <em class="parameter"><code>folder_path</code></em>
could belong to one of
several IMAP namespaces, the namespace with the longest matching prefix
string is preferred. This has the effect of giving a namespace with an
empty prefix the lowest priority.</p>
<p>The returned <a class="link" href="CamelIMAPXNamespace.html" title="CamelIMAPXNamespace"><span class="type">CamelIMAPXNamespace</span></a> is referenced for thread-safety and
should be unreferenced with <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when finished with it.</p>
<div class="refsect3">
<a name="camel-imapx-namespace-response-lookup-for-path.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>response</p></td>
<td class="parameter_description"><p>a <a class="link" href="CamelIMAPXNamespaceResponse.html" title="CamelIMAPXNamespaceResponse"><span class="type">CamelIMAPXNamespaceResponse</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>folder_path</p></td>
<td class="parameter_description"><p>a Camel folder path</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="camel-imapx-namespace-response-lookup-for-path.returns"></a><h4>Returns</h4>
<p> a <a class="link" href="CamelIMAPXNamespace.html" title="CamelIMAPXNamespace"><span class="type">CamelIMAPXNamespace</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.12.html" title="Index of new symbols in 3.12">3.12</a></p>
</div>
</div>
<div class="refsect1">
<a name="CamelIMAPXNamespaceResponse.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="CamelIMAPXNamespaceResponse-struct"></a><h3>struct CamelIMAPXNamespaceResponse</h3>
<pre class="programlisting">struct CamelIMAPXNamespaceResponse;</pre>
<p>Contains only private data that should be read and manipulated using the
functions below.</p>
<p class="since">Since: <a class="link" href="api-index-3.12.html" title="Index of new symbols in 3.12">3.12</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|