← Back to branch summary

~ubuntu-branches/ubuntu/utopic/evolution-data-server/utopic-proposed

« back to all changes in this revision

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

  • Committer: Package Import Robot
  • Author(s): Iain Lane
  • Date: 2014-06-13 12:02:14 UTC
  • mfrom: (1.1.116) (1.2.35 sid)
  • Revision ID: package-import@ubuntu.com-20140613120214-1zx93d8jxwt093aw
Tags: 3.12.2-1ubuntu1
* Merge with Debian, remaining changes:
  - debian/control: build depend on hardening-wrapper
  - Add build-depends and pass configure flag to enable Ubuntu Online
    Accounts support.
  - Filter out -Bsymbolic-functions from LDFLAGS (for future people
    wondering about this change, see e.g. BGO #594473 and duplicates).
  - Enable Ubuntu Online Accounts and split it and GOA into a separate
    package

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/camel/html/CamelIMAPXMailbox.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>CamelIMAPXMailbox</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
 
7
<link rel="home" href="index.html" title="Camel Reference Manual">
 
8
<link rel="up" href="IMAP.html" title="IMAP Service">
 
9
<link rel="prev" href="CamelIMAPXLogger.html" title="CamelIMAPXLogger">
 
10
<link rel="next" href="CamelIMAPXNamespace.html" title="CamelIMAPXNamespace">
 
11
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
</head>
 
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
16
<tr valign="middle">
 
17
<td><a accesskey="p" href="CamelIMAPXLogger.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="IMAP.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
20
<th width="100%" align="center">Camel Reference Manual</th>
 
21
<td><a accesskey="n" href="CamelIMAPXNamespace.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
22
</tr>
 
23
<tr><td colspan="5" class="shortcuts">
 
24
<a href="#CamelIMAPXMailbox.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#CamelIMAPXMailbox.description" class="shortcut">Description</a>
 
27
                   | 
 
28
                  <a href="#CamelIMAPXMailbox.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
</td></tr>
 
30
</table>
 
31
<div class="refentry">
 
32
<a name="CamelIMAPXMailbox"></a><div class="titlepage"></div>
 
33
<div class="refnamediv"><table width="100%"><tr>
 
34
<td valign="top">
 
35
<h2><span class="refentrytitle"><a name="CamelIMAPXMailbox.top_of_page"></a>CamelIMAPXMailbox</span></h2>
 
36
<p>CamelIMAPXMailbox — Stores the state of an IMAP mailbox</p>
 
37
</td>
 
38
<td valign="top" align="right"></td>
 
39
</tr></table></div>
 
40
<div class="refsynopsisdiv">
 
41
<a name="CamelIMAPXMailbox.synopsis"></a><h2>Synopsis</h2>
 
42
<pre class="synopsis">
 
43
#include &lt;camel/camel.h&gt;
 
44
 
 
45
struct              <a class="link" href="CamelIMAPXMailbox.html#CamelIMAPXMailbox-struct" title="struct CamelIMAPXMailbox">CamelIMAPXMailbox</a>;
 
46
<a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="returnvalue">CamelIMAPXMailbox</span></a> * <a class="link" href="CamelIMAPXMailbox.html#camel-imapx-mailbox-new" title="camel_imapx_mailbox_new ()">camel_imapx_mailbox_new</a>             (<em class="parameter"><code><a class="link" href="CamelIMAPXListResponse.html" title="CamelIMAPXListResponse"><span class="type">CamelIMAPXListResponse</span></a> *response</code></em>,
 
47
                                                         <em class="parameter"><code><a class="link" href="CamelIMAPXNamespace.html" title="CamelIMAPXNamespace"><span class="type">CamelIMAPXNamespace</span></a> *namespace_</code></em>);
 
48
<a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="returnvalue">CamelIMAPXMailbox</span></a> * <a class="link" href="CamelIMAPXMailbox.html#camel-imapx-mailbox-clone" title="camel_imapx_mailbox_clone ()">camel_imapx_mailbox_clone</a>           (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>,
 
49
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *new_mailbox_name</code></em>);
 
50
<span class="returnvalue">gboolean</span>            <a class="link" href="CamelIMAPXMailbox.html#camel-imapx-mailbox-exists" title="camel_imapx_mailbox_exists ()">camel_imapx_mailbox_exists</a>          (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>);
 
51
<span class="returnvalue">gint</span>                <a class="link" href="CamelIMAPXMailbox.html#camel-imapx-mailbox-compare" title="camel_imapx_mailbox_compare ()">camel_imapx_mailbox_compare</a>         (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox_a</code></em>,
 
52
                                                         <em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox_b</code></em>);
 
53
<span class="returnvalue">gboolean</span>            <a class="link" href="CamelIMAPXMailbox.html#camel-imapx-mailbox-matches" title="camel_imapx_mailbox_matches ()">camel_imapx_mailbox_matches</a>         (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>,
 
54
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *pattern</code></em>);
 
55
const <span class="returnvalue">gchar</span> *       <a class="link" href="CamelIMAPXMailbox.html#camel-imapx-mailbox-get-name" title="camel_imapx_mailbox_get_name ()">camel_imapx_mailbox_get_name</a>        (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>);
 
56
<span class="returnvalue">gchar</span>               <a class="link" href="CamelIMAPXMailbox.html#camel-imapx-mailbox-get-separator" title="camel_imapx_mailbox_get_separator ()">camel_imapx_mailbox_get_separator</a>   (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>);
 
57
<a class="link" href="CamelIMAPXNamespace.html" title="CamelIMAPXNamespace"><span class="returnvalue">CamelIMAPXNamespace</span></a> * <a class="link" href="CamelIMAPXMailbox.html#camel-imapx-mailbox-get-namespace" title="camel_imapx_mailbox_get_namespace ()">camel_imapx_mailbox_get_namespace</a> (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>);
 
58
<span class="returnvalue">guint32</span>             <a class="link" href="CamelIMAPXMailbox.html#camel-imapx-mailbox-get-messages" title="camel_imapx_mailbox_get_messages ()">camel_imapx_mailbox_get_messages</a>    (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>);
 
59
<span class="returnvalue">void</span>                <a class="link" href="CamelIMAPXMailbox.html#camel-imapx-mailbox-set-messages" title="camel_imapx_mailbox_set_messages ()">camel_imapx_mailbox_set_messages</a>    (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>,
 
60
                                                         <em class="parameter"><code><span class="type">guint32</span> messages</code></em>);
 
61
<span class="returnvalue">guint32</span>             <a class="link" href="CamelIMAPXMailbox.html#camel-imapx-mailbox-get-recent" title="camel_imapx_mailbox_get_recent ()">camel_imapx_mailbox_get_recent</a>      (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>);
 
62
<span class="returnvalue">void</span>                <a class="link" href="CamelIMAPXMailbox.html#camel-imapx-mailbox-set-recent" title="camel_imapx_mailbox_set_recent ()">camel_imapx_mailbox_set_recent</a>      (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>,
 
63
                                                         <em class="parameter"><code><span class="type">guint32</span> recent</code></em>);
 
64
<span class="returnvalue">guint32</span>             <a class="link" href="CamelIMAPXMailbox.html#camel-imapx-mailbox-get-unseen" title="camel_imapx_mailbox_get_unseen ()">camel_imapx_mailbox_get_unseen</a>      (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>);
 
65
<span class="returnvalue">void</span>                <a class="link" href="CamelIMAPXMailbox.html#camel-imapx-mailbox-set-unseen" title="camel_imapx_mailbox_set_unseen ()">camel_imapx_mailbox_set_unseen</a>      (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>,
 
66
                                                         <em class="parameter"><code><span class="type">guint32</span> unseen</code></em>);
 
67
<span class="returnvalue">guint32</span>             <a class="link" href="CamelIMAPXMailbox.html#camel-imapx-mailbox-get-uidnext" title="camel_imapx_mailbox_get_uidnext ()">camel_imapx_mailbox_get_uidnext</a>     (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>);
 
68
<span class="returnvalue">void</span>                <a class="link" href="CamelIMAPXMailbox.html#camel-imapx-mailbox-set-uidnext" title="camel_imapx_mailbox_set_uidnext ()">camel_imapx_mailbox_set_uidnext</a>     (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>,
 
69
                                                         <em class="parameter"><code><span class="type">guint32</span> uidnext</code></em>);
 
70
<span class="returnvalue">guint32</span>             <a class="link" href="CamelIMAPXMailbox.html#camel-imapx-mailbox-get-uidvalidity" title="camel_imapx_mailbox_get_uidvalidity ()">camel_imapx_mailbox_get_uidvalidity</a> (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>);
 
71
<span class="returnvalue">void</span>                <a class="link" href="CamelIMAPXMailbox.html#camel-imapx-mailbox-set-uidvalidity" title="camel_imapx_mailbox_set_uidvalidity ()">camel_imapx_mailbox_set_uidvalidity</a> (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>,
 
72
                                                         <em class="parameter"><code><span class="type">guint32</span> uidvalidity</code></em>);
 
73
<span class="returnvalue">guint64</span>             <a class="link" href="CamelIMAPXMailbox.html#camel-imapx-mailbox-get-highestmodseq" title="camel_imapx_mailbox_get_highestmodseq ()">camel_imapx_mailbox_get_highestmodseq</a>
 
74
                                                        (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>);
 
75
<span class="returnvalue">void</span>                <a class="link" href="CamelIMAPXMailbox.html#camel-imapx-mailbox-set-highestmodseq" title="camel_imapx_mailbox_set_highestmodseq ()">camel_imapx_mailbox_set_highestmodseq</a>
 
76
                                                        (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>,
 
77
                                                         <em class="parameter"><code><span class="type">guint64</span> highestmodseq</code></em>);
 
78
<span class="returnvalue">gchar</span> **            <a class="link" href="CamelIMAPXMailbox.html#camel-imapx-mailbox-dup-quota-roots" title="camel_imapx_mailbox_dup_quota_roots ()">camel_imapx_mailbox_dup_quota_roots</a> (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>);
 
79
<span class="returnvalue">void</span>                <a class="link" href="CamelIMAPXMailbox.html#camel-imapx-mailbox-set-quota-roots" title="camel_imapx_mailbox_set_quota_roots ()">camel_imapx_mailbox_set_quota_roots</a> (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>,
 
80
                                                         <em class="parameter"><code>const <span class="type">gchar</span> **quota_roots</code></em>);
 
81
<span class="returnvalue">GSequence</span> *         <a class="link" href="CamelIMAPXMailbox.html#camel-imapx-mailbox-copy-message-map" title="camel_imapx_mailbox_copy_message_map ()">camel_imapx_mailbox_copy_message_map</a>
 
82
                                                        (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>);
 
83
<span class="returnvalue">void</span>                <a class="link" href="CamelIMAPXMailbox.html#camel-imapx-mailbox-take-message-map" title="camel_imapx_mailbox_take_message_map ()">camel_imapx_mailbox_take_message_map</a>
 
84
                                                        (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>,
 
85
                                                         <em class="parameter"><code><span class="type">GSequence</span> *message_map</code></em>);
 
86
<span class="returnvalue">gboolean</span>            <a class="link" href="CamelIMAPXMailbox.html#camel-imapx-mailbox-get-msn-for-uid" title="camel_imapx_mailbox_get_msn_for_uid ()">camel_imapx_mailbox_get_msn_for_uid</a> (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>,
 
87
                                                         <em class="parameter"><code><span class="type">guint32</span> uid</code></em>,
 
88
                                                         <em class="parameter"><code><span class="type">guint32</span> *out_msn</code></em>);
 
89
<span class="returnvalue">gboolean</span>            <a class="link" href="CamelIMAPXMailbox.html#camel-imapx-mailbox-get-uid-for-msn" title="camel_imapx_mailbox_get_uid_for_msn ()">camel_imapx_mailbox_get_uid_for_msn</a> (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>,
 
90
                                                         <em class="parameter"><code><span class="type">guint32</span> msn</code></em>,
 
91
                                                         <em class="parameter"><code><span class="type">guint32</span> *out_uid</code></em>);
 
92
<span class="returnvalue">void</span>                <a class="link" href="CamelIMAPXMailbox.html#camel-imapx-mailbox-deleted" title="camel_imapx_mailbox_deleted ()">camel_imapx_mailbox_deleted</a>         (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>);
 
93
<span class="returnvalue">void</span>                <a class="link" href="CamelIMAPXMailbox.html#camel-imapx-mailbox-subscribed" title="camel_imapx_mailbox_subscribed ()">camel_imapx_mailbox_subscribed</a>      (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>);
 
94
<span class="returnvalue">void</span>                <a class="link" href="CamelIMAPXMailbox.html#camel-imapx-mailbox-unsubscribed" title="camel_imapx_mailbox_unsubscribed ()">camel_imapx_mailbox_unsubscribed</a>    (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>);
 
95
<span class="returnvalue">gboolean</span>            <a class="link" href="CamelIMAPXMailbox.html#camel-imapx-mailbox-has-attribute" title="camel_imapx_mailbox_has_attribute ()">camel_imapx_mailbox_has_attribute</a>   (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>,
 
96
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *attribute</code></em>);
 
97
<span class="returnvalue">void</span>                <a class="link" href="CamelIMAPXMailbox.html#camel-imapx-mailbox-handle-list-response" title="camel_imapx_mailbox_handle_list_response ()">camel_imapx_mailbox_handle_list_response</a>
 
98
                                                        (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>,
 
99
                                                         <em class="parameter"><code><a class="link" href="CamelIMAPXListResponse.html" title="CamelIMAPXListResponse"><span class="type">CamelIMAPXListResponse</span></a> *response</code></em>);
 
100
<span class="returnvalue">void</span>                <a class="link" href="CamelIMAPXMailbox.html#camel-imapx-mailbox-handle-lsub-response" title="camel_imapx_mailbox_handle_lsub_response ()">camel_imapx_mailbox_handle_lsub_response</a>
 
101
                                                        (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>,
 
102
                                                         <em class="parameter"><code><a class="link" href="CamelIMAPXListResponse.html" title="CamelIMAPXListResponse"><span class="type">CamelIMAPXListResponse</span></a> *response</code></em>);
 
103
<span class="returnvalue">void</span>                <a class="link" href="CamelIMAPXMailbox.html#camel-imapx-mailbox-handle-status-response" title="camel_imapx_mailbox_handle_status_response ()">camel_imapx_mailbox_handle_status_response</a>
 
104
                                                        (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>,
 
105
                                                         <em class="parameter"><code><a class="link" href="CamelIMAPXStatusResponse.html" title="CamelIMAPXStatusResponse"><span class="type">CamelIMAPXStatusResponse</span></a> *response</code></em>);
 
106
</pre>
 
107
</div>
 
108
<div class="refsect1">
 
109
<a name="CamelIMAPXMailbox.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
110
<pre class="synopsis">
 
111
  GObject
 
112
   +----CamelIMAPXMailbox
 
113
</pre>
 
114
</div>
 
115
<div class="refsect1">
 
116
<a name="CamelIMAPXMailbox.description"></a><h2>Description</h2>
 
117
<p>
 
118
<a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> models the current state of an IMAP mailbox as
 
119
accumulated from untagged IMAP server responses in the current session.
 
120
</p>
 
121
<p>
 
122
In particular, a <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> should <span class="emphasis"><em>not</em></span> be
 
123
populated with locally cached information from the previous session.
 
124
This is why instantiation requires a <a class="link" href="CamelIMAPXListResponse.html" title="CamelIMAPXListResponse"><span class="type">CamelIMAPXListResponse</span></a>.
 
125
</p>
 
126
</div>
 
127
<div class="refsect1">
 
128
<a name="CamelIMAPXMailbox.details"></a><h2>Details</h2>
 
129
<div class="refsect2">
 
130
<a name="CamelIMAPXMailbox-struct"></a><h3>struct CamelIMAPXMailbox</h3>
 
131
<pre class="programlisting">struct CamelIMAPXMailbox;</pre>
 
132
<p>
 
133
Contains only private data that should be read and manipulated using the
 
134
functions below.
 
135
</p>
 
136
<p class="since">Since 3.12</p>
 
137
</div>
 
138
<hr>
 
139
<div class="refsect2">
 
140
<a name="camel-imapx-mailbox-new"></a><h3>camel_imapx_mailbox_new ()</h3>
 
141
<pre class="programlisting"><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="returnvalue">CamelIMAPXMailbox</span></a> * camel_imapx_mailbox_new             (<em class="parameter"><code><a class="link" href="CamelIMAPXListResponse.html" title="CamelIMAPXListResponse"><span class="type">CamelIMAPXListResponse</span></a> *response</code></em>,
 
142
                                                         <em class="parameter"><code><a class="link" href="CamelIMAPXNamespace.html" title="CamelIMAPXNamespace"><span class="type">CamelIMAPXNamespace</span></a> *namespace_</code></em>);</pre>
 
143
<p>
 
144
Creates a new <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> from <em class="parameter"><code>response</code></em> and <em class="parameter"><code>namespace</code></em>.
 
145
</p>
 
146
<p>
 
147
The mailbox's name, path separator character, and attribute set are
 
148
initialized from the <a class="link" href="CamelIMAPXListResponse.html" title="CamelIMAPXListResponse"><span class="type">CamelIMAPXListResponse</span></a>.
 
149
</p>
 
150
<div class="variablelist"><table border="0">
 
151
<col align="left" valign="top">
 
152
<tbody>
 
153
<tr>
 
154
<td><p><span class="term"><em class="parameter"><code>response</code></em> :</span></p></td>
 
155
<td>a <a class="link" href="CamelIMAPXListResponse.html" title="CamelIMAPXListResponse"><span class="type">CamelIMAPXListResponse</span></a>
 
156
</td>
 
157
</tr>
 
158
<tr>
 
159
<td><p><span class="term"><em class="parameter"><code>namespace_</code></em> :</span></p></td>
 
160
<td>a <a class="link" href="CamelIMAPXNamespace.html" title="CamelIMAPXNamespace"><span class="type">CamelIMAPXNamespace</span></a>
 
161
</td>
 
162
</tr>
 
163
<tr>
 
164
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
165
<td>a <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a>
 
166
</td>
 
167
</tr>
 
168
</tbody>
 
169
</table></div>
 
170
<p class="since">Since 3.12</p>
 
171
</div>
 
172
<hr>
 
173
<div class="refsect2">
 
174
<a name="camel-imapx-mailbox-clone"></a><h3>camel_imapx_mailbox_clone ()</h3>
 
175
<pre class="programlisting"><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="returnvalue">CamelIMAPXMailbox</span></a> * camel_imapx_mailbox_clone           (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>,
 
176
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *new_mailbox_name</code></em>);</pre>
 
177
<p>
 
178
Creates an identical copy of <em class="parameter"><code>mailbox</code></em>, except for the mailbox name.
 
179
The copied <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> is given the name <em class="parameter"><code>new_mailbox_name</code></em>.
 
180
</p>
 
181
<p>
 
182
The <em class="parameter"><code>new_mailbox_name</code></em> must be in the same IMAP namespace as <em class="parameter"><code>mailbox</code></em>.
 
183
</p>
 
184
<p>
 
185
This is primarily useful for handling mailbox renames.  It is safer to
 
186
create a new <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> instance with the new name than to try
 
187
and rename an existing <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a>, which could disrupt mailbox
 
188
operations in progress as well as data structures that track mailboxes
 
189
by name.
 
190
</p>
 
191
<div class="variablelist"><table border="0">
 
192
<col align="left" valign="top">
 
193
<tbody>
 
194
<tr>
 
195
<td><p><span class="term"><em class="parameter"><code>mailbox</code></em> :</span></p></td>
 
196
<td>a <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a>
 
197
</td>
 
198
</tr>
 
199
<tr>
 
200
<td><p><span class="term"><em class="parameter"><code>new_mailbox_name</code></em> :</span></p></td>
 
201
<td>new name for the cloned mailbox</td>
 
202
</tr>
 
203
<tr>
 
204
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
205
<td>a copy of <em class="parameter"><code>mailbox</code></em>, named <em class="parameter"><code>new_mailbox_name</code></em>
 
206
</td>
 
207
</tr>
 
208
</tbody>
 
209
</table></div>
 
210
<p class="since">Since 3.12</p>
 
211
</div>
 
212
<hr>
 
213
<div class="refsect2">
 
214
<a name="camel-imapx-mailbox-exists"></a><h3>camel_imapx_mailbox_exists ()</h3>
 
215
<pre class="programlisting"><span class="returnvalue">gboolean</span>            camel_imapx_mailbox_exists          (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>);</pre>
 
216
<p>
 
217
Convenience function returns whether <em class="parameter"><code>mailbox</code></em> exists; that is, whether it
 
218
<span class="emphasis"><em>lacks</em></span> a <a class="link" href="CamelIMAPXListResponse.html#CAMEL-IMAPX-LIST-ATTR-NONEXISTENT:CAPS" title="CAMEL_IMAPX_LIST_ATTR_NONEXISTENT"><span class="type">CAMEL_IMAPX_LIST_ATTR_NONEXISTENT</span></a> attribute.
 
219
</p>
 
220
<p>
 
221
Non-existent mailboxes should generally be disregarded.
 
222
</p>
 
223
<div class="variablelist"><table border="0">
 
224
<col align="left" valign="top">
 
225
<tbody>
 
226
<tr>
 
227
<td><p><span class="term"><em class="parameter"><code>mailbox</code></em> :</span></p></td>
 
228
<td>a <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a>
 
229
</td>
 
230
</tr>
 
231
<tr>
 
232
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
233
<td>whether <em class="parameter"><code>mailbox</code></em> exists</td>
 
234
</tr>
 
235
</tbody>
 
236
</table></div>
 
237
<p class="since">Since 3.12</p>
 
238
</div>
 
239
<hr>
 
240
<div class="refsect2">
 
241
<a name="camel-imapx-mailbox-compare"></a><h3>camel_imapx_mailbox_compare ()</h3>
 
242
<pre class="programlisting"><span class="returnvalue">gint</span>                camel_imapx_mailbox_compare         (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox_a</code></em>,
 
243
                                                         <em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox_b</code></em>);</pre>
 
244
<p>
 
245
Compares two <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> instances by their mailbox names.
 
246
</p>
 
247
<div class="variablelist"><table border="0">
 
248
<col align="left" valign="top">
 
249
<tbody>
 
250
<tr>
 
251
<td><p><span class="term"><em class="parameter"><code>mailbox_a</code></em> :</span></p></td>
 
252
<td>the first <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a>
 
253
</td>
 
254
</tr>
 
255
<tr>
 
256
<td><p><span class="term"><em class="parameter"><code>mailbox_b</code></em> :</span></p></td>
 
257
<td>the second <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a>
 
258
</td>
 
259
</tr>
 
260
<tr>
 
261
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
262
<td>a negative value if <em class="parameter"><code>mailbox_a</code></em> compares before <em class="parameter"><code>mailbox_b</code></em>,
 
263
zero if they compare equal, or a positive value if <em class="parameter"><code>mailbox_a</code></em>
 
264
compares after <em class="parameter"><code>mailbox_b</code></em>
 
265
</td>
 
266
</tr>
 
267
</tbody>
 
268
</table></div>
 
269
<p class="since">Since 3.12</p>
 
270
</div>
 
271
<hr>
 
272
<div class="refsect2">
 
273
<a name="camel-imapx-mailbox-matches"></a><h3>camel_imapx_mailbox_matches ()</h3>
 
274
<pre class="programlisting"><span class="returnvalue">gboolean</span>            camel_imapx_mailbox_matches         (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>,
 
275
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *pattern</code></em>);</pre>
 
276
<p>
 
277
Returns <code class="literal">TRUE</code> if <em class="parameter"><code>mailbox</code></em>'s name matches <em class="parameter"><code>pattern</code></em>.  The <em class="parameter"><code>pattern</code></em> may
 
278
contain wildcard characters '*' and '%', which are interpreted similar
 
279
to the IMAP LIST command.
 
280
</p>
 
281
<div class="variablelist"><table border="0">
 
282
<col align="left" valign="top">
 
283
<tbody>
 
284
<tr>
 
285
<td><p><span class="term"><em class="parameter"><code>mailbox</code></em> :</span></p></td>
 
286
<td>a <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a>
 
287
</td>
 
288
</tr>
 
289
<tr>
 
290
<td><p><span class="term"><em class="parameter"><code>pattern</code></em> :</span></p></td>
 
291
<td>mailbox name with possible wildcards</td>
 
292
</tr>
 
293
<tr>
 
294
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
295
<td>
 
296
<code class="literal">TRUE</code> if <em class="parameter"><code>mailbox</code></em>'s name matches <em class="parameter"><code>pattern</code></em>, <code class="literal">FALSE</code> otherwise</td>
 
297
</tr>
 
298
</tbody>
 
299
</table></div>
 
300
<p class="since">Since 3.12</p>
 
301
</div>
 
302
<hr>
 
303
<div class="refsect2">
 
304
<a name="camel-imapx-mailbox-get-name"></a><h3>camel_imapx_mailbox_get_name ()</h3>
 
305
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       camel_imapx_mailbox_get_name        (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>);</pre>
 
306
<p>
 
307
Returns the mailbox name for <em class="parameter"><code>mailbox</code></em>.
 
308
</p>
 
309
<div class="variablelist"><table border="0">
 
310
<col align="left" valign="top">
 
311
<tbody>
 
312
<tr>
 
313
<td><p><span class="term"><em class="parameter"><code>mailbox</code></em> :</span></p></td>
 
314
<td>a <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a>
 
315
</td>
 
316
</tr>
 
317
<tr>
 
318
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
319
<td>the mailbox name</td>
 
320
</tr>
 
321
</tbody>
 
322
</table></div>
 
323
<p class="since">Since 3.12</p>
 
324
</div>
 
325
<hr>
 
326
<div class="refsect2">
 
327
<a name="camel-imapx-mailbox-get-separator"></a><h3>camel_imapx_mailbox_get_separator ()</h3>
 
328
<pre class="programlisting"><span class="returnvalue">gchar</span>               camel_imapx_mailbox_get_separator   (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>);</pre>
 
329
<p>
 
330
Returns the path separator character for <em class="parameter"><code>mailbox</code></em>.
 
331
</p>
 
332
<div class="variablelist"><table border="0">
 
333
<col align="left" valign="top">
 
334
<tbody>
 
335
<tr>
 
336
<td><p><span class="term"><em class="parameter"><code>mailbox</code></em> :</span></p></td>
 
337
<td>a <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a>
 
338
</td>
 
339
</tr>
 
340
<tr>
 
341
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
342
<td>the mailbox path separator character</td>
 
343
</tr>
 
344
</tbody>
 
345
</table></div>
 
346
<p class="since">Since 3.12</p>
 
347
</div>
 
348
<hr>
 
349
<div class="refsect2">
 
350
<a name="camel-imapx-mailbox-get-namespace"></a><h3>camel_imapx_mailbox_get_namespace ()</h3>
 
351
<pre class="programlisting"><a class="link" href="CamelIMAPXNamespace.html" title="CamelIMAPXNamespace"><span class="returnvalue">CamelIMAPXNamespace</span></a> * camel_imapx_mailbox_get_namespace (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>);</pre>
 
352
<p>
 
353
Returns the <a class="link" href="CamelIMAPXNamespace.html" title="CamelIMAPXNamespace"><span class="type">CamelIMAPXNamespace</span></a> representing the IMAP server namespace
 
354
to which <em class="parameter"><code>mailbox</code></em> belongs.
 
355
</p>
 
356
<div class="variablelist"><table border="0">
 
357
<col align="left" valign="top">
 
358
<tbody>
 
359
<tr>
 
360
<td><p><span class="term"><em class="parameter"><code>mailbox</code></em> :</span></p></td>
 
361
<td>a <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a>
 
362
</td>
 
363
</tr>
 
364
<tr>
 
365
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
366
<td>a <a class="link" href="CamelIMAPXNamespace.html" title="CamelIMAPXNamespace"><span class="type">CamelIMAPXNamespace</span></a>
 
367
</td>
 
368
</tr>
 
369
</tbody>
 
370
</table></div>
 
371
<p class="since">Since 3.12</p>
 
372
</div>
 
373
<hr>
 
374
<div class="refsect2">
 
375
<a name="camel-imapx-mailbox-get-messages"></a><h3>camel_imapx_mailbox_get_messages ()</h3>
 
376
<pre class="programlisting"><span class="returnvalue">guint32</span>             camel_imapx_mailbox_get_messages    (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>);</pre>
 
377
<p>
 
378
Returns the last known number of messages in the mailbox.
 
379
</p>
 
380
<p>
 
381
This value should reflect the present state of the IMAP server as
 
382
reported through untagged server responses in the current session.
 
383
</p>
 
384
<div class="variablelist"><table border="0">
 
385
<col align="left" valign="top">
 
386
<tbody>
 
387
<tr>
 
388
<td><p><span class="term"><em class="parameter"><code>mailbox</code></em> :</span></p></td>
 
389
<td>a <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a>
 
390
</td>
 
391
</tr>
 
392
<tr>
 
393
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
394
<td>the last known "MESSAGES" value</td>
 
395
</tr>
 
396
</tbody>
 
397
</table></div>
 
398
<p class="since">Since 3.12</p>
 
399
</div>
 
400
<hr>
 
401
<div class="refsect2">
 
402
<a name="camel-imapx-mailbox-set-messages"></a><h3>camel_imapx_mailbox_set_messages ()</h3>
 
403
<pre class="programlisting"><span class="returnvalue">void</span>                camel_imapx_mailbox_set_messages    (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>,
 
404
                                                         <em class="parameter"><code><span class="type">guint32</span> messages</code></em>);</pre>
 
405
<p>
 
406
Updates the last known number of messages in the mailbox.
 
407
</p>
 
408
<p>
 
409
This value should reflect the present state of the IMAP server as
 
410
reported through untagged server responses in the current session.
 
411
</p>
 
412
<div class="variablelist"><table border="0">
 
413
<col align="left" valign="top">
 
414
<tbody>
 
415
<tr>
 
416
<td><p><span class="term"><em class="parameter"><code>mailbox</code></em> :</span></p></td>
 
417
<td>a <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a>
 
418
</td>
 
419
</tr>
 
420
<tr>
 
421
<td><p><span class="term"><em class="parameter"><code>messages</code></em> :</span></p></td>
 
422
<td>a newly-reported "MESSAGES" value</td>
 
423
</tr>
 
424
</tbody>
 
425
</table></div>
 
426
<p class="since">Since 3.12</p>
 
427
</div>
 
428
<hr>
 
429
<div class="refsect2">
 
430
<a name="camel-imapx-mailbox-get-recent"></a><h3>camel_imapx_mailbox_get_recent ()</h3>
 
431
<pre class="programlisting"><span class="returnvalue">guint32</span>             camel_imapx_mailbox_get_recent      (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>);</pre>
 
432
<p>
 
433
Returns the last known number of messages with the \Recent flag set.
 
434
</p>
 
435
<p>
 
436
This value should reflect the present state of the IMAP server as
 
437
reported through untagged server responses in the current session.
 
438
</p>
 
439
<div class="variablelist"><table border="0">
 
440
<col align="left" valign="top">
 
441
<tbody>
 
442
<tr>
 
443
<td><p><span class="term"><em class="parameter"><code>mailbox</code></em> :</span></p></td>
 
444
<td>a <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a>
 
445
</td>
 
446
</tr>
 
447
<tr>
 
448
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
449
<td>the last known "RECENT" value</td>
 
450
</tr>
 
451
</tbody>
 
452
</table></div>
 
453
<p class="since">Since 3.12</p>
 
454
</div>
 
455
<hr>
 
456
<div class="refsect2">
 
457
<a name="camel-imapx-mailbox-set-recent"></a><h3>camel_imapx_mailbox_set_recent ()</h3>
 
458
<pre class="programlisting"><span class="returnvalue">void</span>                camel_imapx_mailbox_set_recent      (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>,
 
459
                                                         <em class="parameter"><code><span class="type">guint32</span> recent</code></em>);</pre>
 
460
<p>
 
461
Updates the last known number of messages with the \Recent flag set.
 
462
</p>
 
463
<p>
 
464
This value should reflect the present state of the IMAP server as
 
465
reported through untagged server responses in the current session.
 
466
</p>
 
467
<div class="variablelist"><table border="0">
 
468
<col align="left" valign="top">
 
469
<tbody>
 
470
<tr>
 
471
<td><p><span class="term"><em class="parameter"><code>mailbox</code></em> :</span></p></td>
 
472
<td>a <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a>
 
473
</td>
 
474
</tr>
 
475
<tr>
 
476
<td><p><span class="term"><em class="parameter"><code>recent</code></em> :</span></p></td>
 
477
<td>a newly-reported "RECENT" value</td>
 
478
</tr>
 
479
</tbody>
 
480
</table></div>
 
481
<p class="since">Since 3.12</p>
 
482
</div>
 
483
<hr>
 
484
<div class="refsect2">
 
485
<a name="camel-imapx-mailbox-get-unseen"></a><h3>camel_imapx_mailbox_get_unseen ()</h3>
 
486
<pre class="programlisting"><span class="returnvalue">guint32</span>             camel_imapx_mailbox_get_unseen      (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>);</pre>
 
487
<p>
 
488
Returns the last known number of messages which do not have the \Seen
 
489
flag set.
 
490
</p>
 
491
<p>
 
492
This value should reflect the present state of the IMAP server as
 
493
reported through untagged server responses in the current session.
 
494
</p>
 
495
<div class="variablelist"><table border="0">
 
496
<col align="left" valign="top">
 
497
<tbody>
 
498
<tr>
 
499
<td><p><span class="term"><em class="parameter"><code>mailbox</code></em> :</span></p></td>
 
500
<td>a <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a>
 
501
</td>
 
502
</tr>
 
503
<tr>
 
504
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
505
<td>the last known "UNSEEN" value</td>
 
506
</tr>
 
507
</tbody>
 
508
</table></div>
 
509
<p class="since">Since 3.12</p>
 
510
</div>
 
511
<hr>
 
512
<div class="refsect2">
 
513
<a name="camel-imapx-mailbox-set-unseen"></a><h3>camel_imapx_mailbox_set_unseen ()</h3>
 
514
<pre class="programlisting"><span class="returnvalue">void</span>                camel_imapx_mailbox_set_unseen      (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>,
 
515
                                                         <em class="parameter"><code><span class="type">guint32</span> unseen</code></em>);</pre>
 
516
<p>
 
517
Updates the last known number of messages which do not have the \Seen
 
518
flag set.
 
519
</p>
 
520
<p>
 
521
This value should reflect the present state of the IMAP server as
 
522
reported through untagged server responses in the current session.
 
523
</p>
 
524
<div class="variablelist"><table border="0">
 
525
<col align="left" valign="top">
 
526
<tbody>
 
527
<tr>
 
528
<td><p><span class="term"><em class="parameter"><code>mailbox</code></em> :</span></p></td>
 
529
<td>a <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a>
 
530
</td>
 
531
</tr>
 
532
<tr>
 
533
<td><p><span class="term"><em class="parameter"><code>unseen</code></em> :</span></p></td>
 
534
<td>a newly-reported "UNSEEN" value</td>
 
535
</tr>
 
536
</tbody>
 
537
</table></div>
 
538
<p class="since">Since 3.12</p>
 
539
</div>
 
540
<hr>
 
541
<div class="refsect2">
 
542
<a name="camel-imapx-mailbox-get-uidnext"></a><h3>camel_imapx_mailbox_get_uidnext ()</h3>
 
543
<pre class="programlisting"><span class="returnvalue">guint32</span>             camel_imapx_mailbox_get_uidnext     (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>);</pre>
 
544
<p>
 
545
Returns the last known next unique identifier value of the mailbox.
 
546
</p>
 
547
<p>
 
548
This value should reflect the present state of the IMAP server as
 
549
reported through untagged server responses in the current session.
 
550
</p>
 
551
<div class="variablelist"><table border="0">
 
552
<col align="left" valign="top">
 
553
<tbody>
 
554
<tr>
 
555
<td><p><span class="term"><em class="parameter"><code>mailbox</code></em> :</span></p></td>
 
556
<td>a <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a>
 
557
</td>
 
558
</tr>
 
559
<tr>
 
560
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
561
<td>the last known "UIDNEXT" value</td>
 
562
</tr>
 
563
</tbody>
 
564
</table></div>
 
565
<p class="since">Since 3.12</p>
 
566
</div>
 
567
<hr>
 
568
<div class="refsect2">
 
569
<a name="camel-imapx-mailbox-set-uidnext"></a><h3>camel_imapx_mailbox_set_uidnext ()</h3>
 
570
<pre class="programlisting"><span class="returnvalue">void</span>                camel_imapx_mailbox_set_uidnext     (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>,
 
571
                                                         <em class="parameter"><code><span class="type">guint32</span> uidnext</code></em>);</pre>
 
572
<p>
 
573
Updates the last known next unique identifier value of the mailbox.
 
574
</p>
 
575
<p>
 
576
This value should reflect the present state of the IMAP server as
 
577
reported through untagged server responses in the current session.
 
578
</p>
 
579
<div class="variablelist"><table border="0">
 
580
<col align="left" valign="top">
 
581
<tbody>
 
582
<tr>
 
583
<td><p><span class="term"><em class="parameter"><code>mailbox</code></em> :</span></p></td>
 
584
<td>a <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a>
 
585
</td>
 
586
</tr>
 
587
<tr>
 
588
<td><p><span class="term"><em class="parameter"><code>uidnext</code></em> :</span></p></td>
 
589
<td>a newly-reported "UIDNEXT" value</td>
 
590
</tr>
 
591
</tbody>
 
592
</table></div>
 
593
<p class="since">Since 3.12</p>
 
594
</div>
 
595
<hr>
 
596
<div class="refsect2">
 
597
<a name="camel-imapx-mailbox-get-uidvalidity"></a><h3>camel_imapx_mailbox_get_uidvalidity ()</h3>
 
598
<pre class="programlisting"><span class="returnvalue">guint32</span>             camel_imapx_mailbox_get_uidvalidity (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>);</pre>
 
599
<p>
 
600
Returns the last known unique identifier validity value of the mailbox.
 
601
</p>
 
602
<p>
 
603
This valud should reflect the present state of the IMAP server as
 
604
reported through untagged server responses in the current session.
 
605
</p>
 
606
<div class="variablelist"><table border="0">
 
607
<col align="left" valign="top">
 
608
<tbody>
 
609
<tr>
 
610
<td><p><span class="term"><em class="parameter"><code>mailbox</code></em> :</span></p></td>
 
611
<td>a <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a>
 
612
</td>
 
613
</tr>
 
614
<tr>
 
615
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
616
<td>the last known "UIDVALIDITY" value</td>
 
617
</tr>
 
618
</tbody>
 
619
</table></div>
 
620
<p class="since">Since 3.12</p>
 
621
</div>
 
622
<hr>
 
623
<div class="refsect2">
 
624
<a name="camel-imapx-mailbox-set-uidvalidity"></a><h3>camel_imapx_mailbox_set_uidvalidity ()</h3>
 
625
<pre class="programlisting"><span class="returnvalue">void</span>                camel_imapx_mailbox_set_uidvalidity (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>,
 
626
                                                         <em class="parameter"><code><span class="type">guint32</span> uidvalidity</code></em>);</pre>
 
627
<p>
 
628
Updates the last known unique identifier validity value of the mailbox.
 
629
</p>
 
630
<p>
 
631
This value should reflect the present state of the IMAP server as
 
632
reported through untagged server responses in the current session.
 
633
</p>
 
634
<div class="variablelist"><table border="0">
 
635
<col align="left" valign="top">
 
636
<tbody>
 
637
<tr>
 
638
<td><p><span class="term"><em class="parameter"><code>mailbox</code></em> :</span></p></td>
 
639
<td>a <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a>
 
640
</td>
 
641
</tr>
 
642
<tr>
 
643
<td><p><span class="term"><em class="parameter"><code>uidvalidity</code></em> :</span></p></td>
 
644
<td>a newly-reported "UIDVALIDITY" value</td>
 
645
</tr>
 
646
</tbody>
 
647
</table></div>
 
648
<p class="since">Since 3.12</p>
 
649
</div>
 
650
<hr>
 
651
<div class="refsect2">
 
652
<a name="camel-imapx-mailbox-get-highestmodseq"></a><h3>camel_imapx_mailbox_get_highestmodseq ()</h3>
 
653
<pre class="programlisting"><span class="returnvalue">guint64</span>             camel_imapx_mailbox_get_highestmodseq
 
654
                                                        (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>);</pre>
 
655
<p>
 
656
Returns the last known highest mod-sequence value of all messages in the
 
657
mailbox, or zero if the server does not support the persistent storage of
 
658
mod-sequences for the mailbox.
 
659
</p>
 
660
<p>
 
661
This value should reflect the present state of the IMAP server as
 
662
reported through untagged server responses in the current session.
 
663
</p>
 
664
<div class="variablelist"><table border="0">
 
665
<col align="left" valign="top">
 
666
<tbody>
 
667
<tr>
 
668
<td><p><span class="term"><em class="parameter"><code>mailbox</code></em> :</span></p></td>
 
669
<td>a <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a>
 
670
</td>
 
671
</tr>
 
672
<tr>
 
673
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
674
<td>the last known "HIGHESTMODSEQ" value</td>
 
675
</tr>
 
676
</tbody>
 
677
</table></div>
 
678
<p class="since">Since 3.12</p>
 
679
</div>
 
680
<hr>
 
681
<div class="refsect2">
 
682
<a name="camel-imapx-mailbox-set-highestmodseq"></a><h3>camel_imapx_mailbox_set_highestmodseq ()</h3>
 
683
<pre class="programlisting"><span class="returnvalue">void</span>                camel_imapx_mailbox_set_highestmodseq
 
684
                                                        (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>,
 
685
                                                         <em class="parameter"><code><span class="type">guint64</span> highestmodseq</code></em>);</pre>
 
686
<p>
 
687
Updates the last known highest mod-sequence value of all messages in
 
688
the mailbox.  If the server does not support the persistent storage of
 
689
mod-sequences for the mailbox then the value should remain zero.
 
690
</p>
 
691
<p>
 
692
This value should reflect the present state of the IMAP server as
 
693
reported through untagged server responses in the current session.
 
694
</p>
 
695
<div class="variablelist"><table border="0">
 
696
<col align="left" valign="top">
 
697
<tbody>
 
698
<tr>
 
699
<td><p><span class="term"><em class="parameter"><code>mailbox</code></em> :</span></p></td>
 
700
<td>a <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a>
 
701
</td>
 
702
</tr>
 
703
<tr>
 
704
<td><p><span class="term"><em class="parameter"><code>highestmodseq</code></em> :</span></p></td>
 
705
<td>a newly-reported "HIGHESTMODSEQ" value</td>
 
706
</tr>
 
707
</tbody>
 
708
</table></div>
 
709
<p class="since">Since 3.12</p>
 
710
</div>
 
711
<hr>
 
712
<div class="refsect2">
 
713
<a name="camel-imapx-mailbox-dup-quota-roots"></a><h3>camel_imapx_mailbox_dup_quota_roots ()</h3>
 
714
<pre class="programlisting"><span class="returnvalue">gchar</span> **            camel_imapx_mailbox_dup_quota_roots (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>);</pre>
 
715
<p>
 
716
Returns the last known list of quota roots for <em class="parameter"><code>mailbox</code></em> as described
 
717
in <a class="ulink" href="http://tools.ietf.org/html/rfc2087" target="_top">RFC 2087</a>,
 
718
or <code class="literal">NULL</code> if no quota information for <em class="parameter"><code>mailbox</code></em> is available.
 
719
</p>
 
720
<p>
 
721
This value should reflect the present state of the IMAP server as
 
722
reported through untagged server responses in the current session.
 
723
</p>
 
724
<p>
 
725
The returned newly-allocated, <code class="literal">NULL</code>-terminated string array should
 
726
be freed with <code class="function">g_strfreev()</code> when finished with it.
 
727
</p>
 
728
<div class="variablelist"><table border="0">
 
729
<col align="left" valign="top">
 
730
<tbody>
 
731
<tr>
 
732
<td><p><span class="term"><em class="parameter"><code>mailbox</code></em> :</span></p></td>
 
733
<td>a <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a>
 
734
</td>
 
735
</tr>
 
736
<tr>
 
737
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
738
<td>the last known "QUOTAROOT" value</td>
 
739
</tr>
 
740
</tbody>
 
741
</table></div>
 
742
<p class="since">Since 3.12</p>
 
743
</div>
 
744
<hr>
 
745
<div class="refsect2">
 
746
<a name="camel-imapx-mailbox-set-quota-roots"></a><h3>camel_imapx_mailbox_set_quota_roots ()</h3>
 
747
<pre class="programlisting"><span class="returnvalue">void</span>                camel_imapx_mailbox_set_quota_roots (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>,
 
748
                                                         <em class="parameter"><code>const <span class="type">gchar</span> **quota_roots</code></em>);</pre>
 
749
<p>
 
750
Updates the last known list of quota roots for <em class="parameter"><code>mailbox</code></em> as described
 
751
in <a class="ulink" href="http://tools.ietf.org/html/rfc2087" target="_top">RFC 2087</a>.
 
752
</p>
 
753
<p>
 
754
This value should reflect the present state of the IMAP server as
 
755
reported through untagged server responses in the current session.
 
756
</p>
 
757
<div class="variablelist"><table border="0">
 
758
<col align="left" valign="top">
 
759
<tbody>
 
760
<tr>
 
761
<td><p><span class="term"><em class="parameter"><code>mailbox</code></em> :</span></p></td>
 
762
<td>a <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a>
 
763
</td>
 
764
</tr>
 
765
<tr>
 
766
<td><p><span class="term"><em class="parameter"><code>quota_roots</code></em> :</span></p></td>
 
767
<td>a newly-reported "QUOTAROOT" value</td>
 
768
</tr>
 
769
</tbody>
 
770
</table></div>
 
771
<p class="since">Since 3.12</p>
 
772
</div>
 
773
<hr>
 
774
<div class="refsect2">
 
775
<a name="camel-imapx-mailbox-copy-message-map"></a><h3>camel_imapx_mailbox_copy_message_map ()</h3>
 
776
<pre class="programlisting"><span class="returnvalue">GSequence</span> *         camel_imapx_mailbox_copy_message_map
 
777
                                                        (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>);</pre>
 
778
<p>
 
779
Creates a copy of <em class="parameter"><code>mailbox</code></em>'s message map: a <span class="type">GSequence</span> of 32-bit integers
 
780
which map message sequence numbers (MSNs) to unique identifiers (UIDs).
 
781
</p>
 
782
<p>
 
783
Free the returned <span class="type">GSequence</span> with <code class="function">g_sequeuce_free()</code> when finished with it.
 
784
</p>
 
785
<div class="variablelist"><table border="0">
 
786
<col align="left" valign="top">
 
787
<tbody>
 
788
<tr>
 
789
<td><p><span class="term"><em class="parameter"><code>mailbox</code></em> :</span></p></td>
 
790
<td>a <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a>
 
791
</td>
 
792
</tr>
 
793
<tr>
 
794
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
795
<td>a <span class="type">GSequence</span> mapping MSNs to UIDs</td>
 
796
</tr>
 
797
</tbody>
 
798
</table></div>
 
799
<p class="since">Since 3.12</p>
 
800
</div>
 
801
<hr>
 
802
<div class="refsect2">
 
803
<a name="camel-imapx-mailbox-take-message-map"></a><h3>camel_imapx_mailbox_take_message_map ()</h3>
 
804
<pre class="programlisting"><span class="returnvalue">void</span>                camel_imapx_mailbox_take_message_map
 
805
                                                        (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>,
 
806
                                                         <em class="parameter"><code><span class="type">GSequence</span> *message_map</code></em>);</pre>
 
807
<p>
 
808
Takes ownership of a <span class="type">GSequence</span> of 32-bit integers which map message
 
809
sequence numbers (MSNs) to unique identifiers (UIDs) for <em class="parameter"><code>mailbox</code></em>.
 
810
</p>
 
811
<p>
 
812
The <em class="parameter"><code>message_map</code></em> is expected to be assembled from a local cache of
 
813
previously fetched UIDs.  The <em class="parameter"><code>mailbox</code></em> will update it as untagged
 
814
server responses are processed.
 
815
</p>
 
816
<div class="variablelist"><table border="0">
 
817
<col align="left" valign="top">
 
818
<tbody>
 
819
<tr>
 
820
<td><p><span class="term"><em class="parameter"><code>mailbox</code></em> :</span></p></td>
 
821
<td>a <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a>
 
822
</td>
 
823
</tr>
 
824
<tr>
 
825
<td><p><span class="term"><em class="parameter"><code>message_map</code></em> :</span></p></td>
 
826
<td>a <span class="type">GSequence</span> mapping MSNs to UIDs</td>
 
827
</tr>
 
828
</tbody>
 
829
</table></div>
 
830
<p class="since">Since 3.12</p>
 
831
</div>
 
832
<hr>
 
833
<div class="refsect2">
 
834
<a name="camel-imapx-mailbox-get-msn-for-uid"></a><h3>camel_imapx_mailbox_get_msn_for_uid ()</h3>
 
835
<pre class="programlisting"><span class="returnvalue">gboolean</span>            camel_imapx_mailbox_get_msn_for_uid (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>,
 
836
                                                         <em class="parameter"><code><span class="type">guint32</span> uid</code></em>,
 
837
                                                         <em class="parameter"><code><span class="type">guint32</span> *out_msn</code></em>);</pre>
 
838
<p>
 
839
Given a message's unique identifier (<em class="parameter"><code>uid</code></em>), write the message's sequence
 
840
number to <em class="parameter"><code>out_msn</code></em> and return <code class="literal">TRUE</code>.  If the unique identifier is unknown
 
841
(as far as <em class="parameter"><code>mailbox</code></em> has been informed), the function returns <code class="literal">FALSE</code>.
 
842
</p>
 
843
<div class="variablelist"><table border="0">
 
844
<col align="left" valign="top">
 
845
<tbody>
 
846
<tr>
 
847
<td><p><span class="term"><em class="parameter"><code>mailbox</code></em> :</span></p></td>
 
848
<td>a <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a>
 
849
</td>
 
850
</tr>
 
851
<tr>
 
852
<td><p><span class="term"><em class="parameter"><code>uid</code></em> :</span></p></td>
 
853
<td>a message's unique identifier</td>
 
854
</tr>
 
855
<tr>
 
856
<td><p><span class="term"><em class="parameter"><code>out_msn</code></em> :</span></p></td>
 
857
<td>return location for the message's sequence number, or <code class="literal">NULL</code>
 
858
</td>
 
859
</tr>
 
860
<tr>
 
861
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
862
<td>whether <em class="parameter"><code>out_msn</code></em> was set</td>
 
863
</tr>
 
864
</tbody>
 
865
</table></div>
 
866
<p class="since">Since 3.12</p>
 
867
</div>
 
868
<hr>
 
869
<div class="refsect2">
 
870
<a name="camel-imapx-mailbox-get-uid-for-msn"></a><h3>camel_imapx_mailbox_get_uid_for_msn ()</h3>
 
871
<pre class="programlisting"><span class="returnvalue">gboolean</span>            camel_imapx_mailbox_get_uid_for_msn (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>,
 
872
                                                         <em class="parameter"><code><span class="type">guint32</span> msn</code></em>,
 
873
                                                         <em class="parameter"><code><span class="type">guint32</span> *out_uid</code></em>);</pre>
 
874
<p>
 
875
Given a message's sequence number (<em class="parameter"><code>msn</code></em>), write the message's unique
 
876
identifier to <em class="parameter"><code>out_uid</code></em> and return <code class="literal">TRUE</code>.  If the sequence number is out of
 
877
range (as far as <em class="parameter"><code>mailbox</code></em> has been informed), the function returns <code class="literal">FALSE</code>.
 
878
</p>
 
879
<div class="variablelist"><table border="0">
 
880
<col align="left" valign="top">
 
881
<tbody>
 
882
<tr>
 
883
<td><p><span class="term"><em class="parameter"><code>mailbox</code></em> :</span></p></td>
 
884
<td>a <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a>
 
885
</td>
 
886
</tr>
 
887
<tr>
 
888
<td><p><span class="term"><em class="parameter"><code>msn</code></em> :</span></p></td>
 
889
<td>a message's sequence number (1..n)</td>
 
890
</tr>
 
891
<tr>
 
892
<td><p><span class="term"><em class="parameter"><code>out_uid</code></em> :</span></p></td>
 
893
<td>return location for the message's unique identifier, or <code class="literal">NULL</code>
 
894
</td>
 
895
</tr>
 
896
<tr>
 
897
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
898
<td>whether <em class="parameter"><code>out_uid</code></em> was set</td>
 
899
</tr>
 
900
</tbody>
 
901
</table></div>
 
902
<p class="since">Since 3.12</p>
 
903
</div>
 
904
<hr>
 
905
<div class="refsect2">
 
906
<a name="camel-imapx-mailbox-deleted"></a><h3>camel_imapx_mailbox_deleted ()</h3>
 
907
<pre class="programlisting"><span class="returnvalue">void</span>                camel_imapx_mailbox_deleted         (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>);</pre>
 
908
<p>
 
909
Adds the <a class="link" href="CamelIMAPXListResponse.html#CAMEL-IMAPX-LIST-ATTR-NONEXISTENT:CAPS" title="CAMEL_IMAPX_LIST_ATTR_NONEXISTENT"><span class="type">CAMEL_IMAPX_LIST_ATTR_NONEXISTENT</span></a> attribute to <em class="parameter"><code>mailbox</code></em>.
 
910
</p>
 
911
<p>
 
912
Call this function after successfully completing a DELETE command.
 
913
</p>
 
914
<div class="variablelist"><table border="0">
 
915
<col align="left" valign="top">
 
916
<tbody><tr>
 
917
<td><p><span class="term"><em class="parameter"><code>mailbox</code></em> :</span></p></td>
 
918
<td>a <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a>
 
919
</td>
 
920
</tr></tbody>
 
921
</table></div>
 
922
<p class="since">Since 3.12</p>
 
923
</div>
 
924
<hr>
 
925
<div class="refsect2">
 
926
<a name="camel-imapx-mailbox-subscribed"></a><h3>camel_imapx_mailbox_subscribed ()</h3>
 
927
<pre class="programlisting"><span class="returnvalue">void</span>                camel_imapx_mailbox_subscribed      (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>);</pre>
 
928
<p>
 
929
Add the <a class="link" href="CamelIMAPXListResponse.html#CAMEL-IMAPX-LIST-ATTR-SUBSCRIBED:CAPS" title="CAMEL_IMAPX_LIST_ATTR_SUBSCRIBED"><span class="type">CAMEL_IMAPX_LIST_ATTR_SUBSCRIBED</span></a> attribute to <em class="parameter"><code>mailbox</code></em>.
 
930
</p>
 
931
<p>
 
932
Call this function after successfully completing a SUBSCRIBE command.
 
933
</p>
 
934
<div class="variablelist"><table border="0">
 
935
<col align="left" valign="top">
 
936
<tbody><tr>
 
937
<td><p><span class="term"><em class="parameter"><code>mailbox</code></em> :</span></p></td>
 
938
<td>a <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a>
 
939
</td>
 
940
</tr></tbody>
 
941
</table></div>
 
942
<p class="since">Since 3.12</p>
 
943
</div>
 
944
<hr>
 
945
<div class="refsect2">
 
946
<a name="camel-imapx-mailbox-unsubscribed"></a><h3>camel_imapx_mailbox_unsubscribed ()</h3>
 
947
<pre class="programlisting"><span class="returnvalue">void</span>                camel_imapx_mailbox_unsubscribed    (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>);</pre>
 
948
<p>
 
949
Removes the <a class="link" href="CamelIMAPXListResponse.html#CAMEL-IMAPX-LIST-ATTR-SUBSCRIBED:CAPS" title="CAMEL_IMAPX_LIST_ATTR_SUBSCRIBED"><span class="type">CAMEL_IMAPX_LIST_ATTR_SUBSCRIBED</span></a> attribute from <em class="parameter"><code>mailbox</code></em>.
 
950
</p>
 
951
<p>
 
952
Call this function after successfully completing an UNSUBSCRIBE command.
 
953
</p>
 
954
<div class="variablelist"><table border="0">
 
955
<col align="left" valign="top">
 
956
<tbody><tr>
 
957
<td><p><span class="term"><em class="parameter"><code>mailbox</code></em> :</span></p></td>
 
958
<td>a <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a>
 
959
</td>
 
960
</tr></tbody>
 
961
</table></div>
 
962
<p class="since">Since 3.12</p>
 
963
</div>
 
964
<hr>
 
965
<div class="refsect2">
 
966
<a name="camel-imapx-mailbox-has-attribute"></a><h3>camel_imapx_mailbox_has_attribute ()</h3>
 
967
<pre class="programlisting"><span class="returnvalue">gboolean</span>            camel_imapx_mailbox_has_attribute   (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>,
 
968
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *attribute</code></em>);</pre>
 
969
<p>
 
970
Returns whether <em class="parameter"><code>mailbox</code></em> includes the given mailbox attribute.
 
971
The <em class="parameter"><code>attribute</code></em> should be one of the LIST attribute macros defined
 
972
for <a class="link" href="CamelIMAPXListResponse.html" title="CamelIMAPXListResponse"><span class="type">CamelIMAPXListResponse</span></a>.
 
973
</p>
 
974
<div class="variablelist"><table border="0">
 
975
<col align="left" valign="top">
 
976
<tbody>
 
977
<tr>
 
978
<td><p><span class="term"><em class="parameter"><code>mailbox</code></em> :</span></p></td>
 
979
<td>a <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a>
 
980
</td>
 
981
</tr>
 
982
<tr>
 
983
<td><p><span class="term"><em class="parameter"><code>attribute</code></em> :</span></p></td>
 
984
<td>a mailbox attribute</td>
 
985
</tr>
 
986
<tr>
 
987
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
988
<td>
 
989
<code class="literal">TRUE</code> if <em class="parameter"><code>mailbox</code></em> has <em class="parameter"><code>attribute</code></em>, or else <code class="literal">FALSE</code>
 
990
</td>
 
991
</tr>
 
992
</tbody>
 
993
</table></div>
 
994
<p class="since">Since 3.12</p>
 
995
</div>
 
996
<hr>
 
997
<div class="refsect2">
 
998
<a name="camel-imapx-mailbox-handle-list-response"></a><h3>camel_imapx_mailbox_handle_list_response ()</h3>
 
999
<pre class="programlisting"><span class="returnvalue">void</span>                camel_imapx_mailbox_handle_list_response
 
1000
                                                        (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>,
 
1001
                                                         <em class="parameter"><code><a class="link" href="CamelIMAPXListResponse.html" title="CamelIMAPXListResponse"><span class="type">CamelIMAPXListResponse</span></a> *response</code></em>);</pre>
 
1002
<p>
 
1003
Updates the internal state of <em class="parameter"><code>mailbox</code></em> from the data in <em class="parameter"><code>response</code></em>.
 
1004
</p>
 
1005
<div class="variablelist"><table border="0">
 
1006
<col align="left" valign="top">
 
1007
<tbody>
 
1008
<tr>
 
1009
<td><p><span class="term"><em class="parameter"><code>mailbox</code></em> :</span></p></td>
 
1010
<td>a <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a>
 
1011
</td>
 
1012
</tr>
 
1013
<tr>
 
1014
<td><p><span class="term"><em class="parameter"><code>response</code></em> :</span></p></td>
 
1015
<td>a <a class="link" href="CamelIMAPXListResponse.html" title="CamelIMAPXListResponse"><span class="type">CamelIMAPXListResponse</span></a>
 
1016
</td>
 
1017
</tr>
 
1018
</tbody>
 
1019
</table></div>
 
1020
<p class="since">Since 3.12</p>
 
1021
</div>
 
1022
<hr>
 
1023
<div class="refsect2">
 
1024
<a name="camel-imapx-mailbox-handle-lsub-response"></a><h3>camel_imapx_mailbox_handle_lsub_response ()</h3>
 
1025
<pre class="programlisting"><span class="returnvalue">void</span>                camel_imapx_mailbox_handle_lsub_response
 
1026
                                                        (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>,
 
1027
                                                         <em class="parameter"><code><a class="link" href="CamelIMAPXListResponse.html" title="CamelIMAPXListResponse"><span class="type">CamelIMAPXListResponse</span></a> *response</code></em>);</pre>
 
1028
<p>
 
1029
Updates the internal state of <em class="parameter"><code>mailbox</code></em> from the data in <em class="parameter"><code>response</code></em>.
 
1030
</p>
 
1031
<div class="variablelist"><table border="0">
 
1032
<col align="left" valign="top">
 
1033
<tbody>
 
1034
<tr>
 
1035
<td><p><span class="term"><em class="parameter"><code>mailbox</code></em> :</span></p></td>
 
1036
<td>a <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a>
 
1037
</td>
 
1038
</tr>
 
1039
<tr>
 
1040
<td><p><span class="term"><em class="parameter"><code>response</code></em> :</span></p></td>
 
1041
<td>a <a class="link" href="CamelIMAPXListResponse.html" title="CamelIMAPXListResponse"><span class="type">CamelIMAPXListResponse</span></a>
 
1042
</td>
 
1043
</tr>
 
1044
</tbody>
 
1045
</table></div>
 
1046
<p class="since">Since 3.12</p>
 
1047
</div>
 
1048
<hr>
 
1049
<div class="refsect2">
 
1050
<a name="camel-imapx-mailbox-handle-status-response"></a><h3>camel_imapx_mailbox_handle_status_response ()</h3>
 
1051
<pre class="programlisting"><span class="returnvalue">void</span>                camel_imapx_mailbox_handle_status_response
 
1052
                                                        (<em class="parameter"><code><a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a> *mailbox</code></em>,
 
1053
                                                         <em class="parameter"><code><a class="link" href="CamelIMAPXStatusResponse.html" title="CamelIMAPXStatusResponse"><span class="type">CamelIMAPXStatusResponse</span></a> *response</code></em>);</pre>
 
1054
<p>
 
1055
Updates the internal state of <em class="parameter"><code>mailbox</code></em> from the data in <em class="parameter"><code>response</code></em>.
 
1056
</p>
 
1057
<div class="variablelist"><table border="0">
 
1058
<col align="left" valign="top">
 
1059
<tbody>
 
1060
<tr>
 
1061
<td><p><span class="term"><em class="parameter"><code>mailbox</code></em> :</span></p></td>
 
1062
<td>a <a class="link" href="CamelIMAPXMailbox.html" title="CamelIMAPXMailbox"><span class="type">CamelIMAPXMailbox</span></a>
 
1063
</td>
 
1064
</tr>
 
1065
<tr>
 
1066
<td><p><span class="term"><em class="parameter"><code>response</code></em> :</span></p></td>
 
1067
<td>a <a class="link" href="CamelIMAPXStatusResponse.html" title="CamelIMAPXStatusResponse"><span class="type">CamelIMAPXStatusResponse</span></a>
 
1068
</td>
 
1069
</tr>
 
1070
</tbody>
 
1071
</table></div>
 
1072
<p class="since">Since 3.12</p>
 
1073
</div>
 
1074
</div>
 
1075
</div>
 
1076
<div class="footer">
 
1077
<hr>
 
1078
          Generated by GTK-Doc V1.19</div>
 
1079
</body>
 
1080
</html>
 
 
b'\\ No newline at end of file'