← Back to branch summary

~ubuntu-branches/ubuntu/maverick/evolution-data-server/maverick-updates

« back to all changes in this revision

Viewing changes to docs/reference/camel/xml/camel-imap-folder.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-03-01 22:47:15 UTC
  • mfrom: (1.1.77 upstream)
  • Revision ID: james.westby@ubuntu.com-20100301224715-drsxc2y3t8anz3c0
Tags: 2.28.3-0ubuntu1
https://launchpad.net/bugs/455020
https://launchpad.net/bugs/475147
https://launchpad.net/bugs/305428
https://launchpad.net/bugs/341909
https://launchpad.net/bugs/444177
* New upstream version:
  Bug Fixes:
  - #602723 - Contact list name doesn't get displayed in 'To' dialog 
  - #600322 - assertion failed: (reply == msg) in cs_waitinfo()
              (lp: #455020, #475147)
  - #564727 - Few memory leaks (lp: #305428)
  - #574940 - Always ref returned info from message_info_from_uid 
              (lp: #341909)
  - #429317 - Use the relative URI returned if the server 
              re-directs a request
  - #602820 - Test validity of a book_view before using it in LDAP 
  - #590762 - Recurring google calendar items are not changeable
  - #604236 - Slow GPG processing 
  - #597816 - Do not crash on incorrect parameters used in sexp to SQL 
              (lp: #444177)
  - #604544 - Try Exchange fallback authentication only once 
  - #600778 - Fix --enable-e2k-debug configure option resolution 
  - #260407 - 'endswith' address book search doesn't work 
  - #549221 - (bnc) delete, sync flags immediately
* debian/patches/99_reconfigure.patch:
  - new version update

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/camel/xml/camel-imap-folder.xml
1
 
<refentry id="camel-CamelImapFolder">
2
 
<refmeta>
3
 
<refentrytitle role="top_of_page" id="camel-CamelImapFolder.top_of_page">CamelImapFolder</refentrytitle>
4
 
<manvolnum>3</manvolnum>
5
 
<refmiscinfo>CAMEL Library</refmiscinfo>
6
 
</refmeta>
7
 
 
8
 
<refnamediv>
9
 
<refname>CamelImapFolder</refname>
10
 
<refpurpose></refpurpose>
11
 
</refnamediv>
12
 
 
13
 
<refsynopsisdiv id="camel-CamelImapFolder.synopsis" role="synopsis">
14
 
<title role="synopsis.title">Synopsis</title>
15
 
 
16
 
<synopsis>
17
 
struct              <link linkend="CamelImapFolder">CamelImapFolder</link>;
18
 
<link linkend="CamelFolder">CamelFolder</link> *       <link linkend="camel-imap-folder-new">camel_imap_folder_new</link>               (<link linkend="CamelStore">CamelStore</link> *parent,
19
 
                                                         const <link linkend="gchar">gchar</link> *folder_name,
20
 
                                                         const <link linkend="gchar">gchar</link> *folder_dir,
21
 
                                                         <link linkend="CamelException">CamelException</link> *ex);
22
 
<link linkend="void">void</link>                <link linkend="camel-imap-folder-selected">camel_imap_folder_selected</link>          (<link linkend="CamelFolder">CamelFolder</link> *folder,
23
 
                                                         <link linkend="CamelImapResponse">CamelImapResponse</link> *response,
24
 
                                                         <link linkend="CamelException">CamelException</link> *ex);
25
 
<link linkend="void">void</link>                <link linkend="camel-imap-folder-changed">camel_imap_folder_changed</link>           (<link linkend="CamelFolder">CamelFolder</link> *folder,
26
 
                                                         <link linkend="gint">gint</link> exists,
27
 
                                                         <link linkend="GArray">GArray</link> *expunged,
28
 
                                                         <link linkend="CamelException">CamelException</link> *ex);
29
 
<link linkend="CamelStream">CamelStream</link> *       <link linkend="camel-imap-folder-fetch-data">camel_imap_folder_fetch_data</link>        (<link linkend="CamelImapFolder">CamelImapFolder</link> *imap_folder,
30
 
                                                         const <link linkend="gchar">gchar</link> *uid,
31
 
                                                         const <link linkend="gchar">gchar</link> *section_text,
32
 
                                                         <link linkend="gboolean">gboolean</link> cache_only,
33
 
                                                         <link linkend="CamelException">CamelException</link> *ex);
34
 
<link linkend="void">void</link>                <link linkend="imap-append-resyncing">imap_append_resyncing</link>               (<link linkend="CamelFolder">CamelFolder</link> *folder,
35
 
                                                         <link linkend="CamelMimeMessage">CamelMimeMessage</link> *message,
36
 
                                                         const <link linkend="CamelMessageInfo">CamelMessageInfo</link> *info,
37
 
                                                         <link linkend="gchar">gchar</link> **appended_uid,
38
 
                                                         <link linkend="CamelException">CamelException</link> *ex);
39
 
<link linkend="void">void</link>                <link linkend="imap-transfer-resyncing">imap_transfer_resyncing</link>             (<link linkend="CamelFolder">CamelFolder</link> *source,
40
 
                                                         <link linkend="GPtrArray">GPtrArray</link> *uids,
41
 
                                                         <link linkend="CamelFolder">CamelFolder</link> *dest,
42
 
                                                         <link linkend="GPtrArray">GPtrArray</link> **transferred_uids,
43
 
                                                         <link linkend="gboolean">gboolean</link> delete_originals,
44
 
                                                         <link linkend="CamelException">CamelException</link> *ex);
45
 
<link linkend="void">void</link>                <link linkend="imap-expunge-uids-resyncing">imap_expunge_uids_resyncing</link>         (<link linkend="CamelFolder">CamelFolder</link> *folder,
46
 
                                                         <link linkend="GPtrArray">GPtrArray</link> *uids,
47
 
                                                         <link linkend="CamelException">CamelException</link> *ex);
48
 
</synopsis>
49
 
</refsynopsisdiv>
50
 
 
51
 
 
52
 
 
53
 
 
54
 
 
55
 
 
56
 
 
57
 
 
58
 
 
59
 
<refsect1 id="camel-CamelImapFolder.description" role="desc">
60
 
<title role="desc.title">Description</title>
61
 
<para>
62
 
</para>
63
 
</refsect1>
64
 
 
65
 
<refsect1 id="camel-CamelImapFolder.details" role="details">
66
 
<title role="details.title">Details</title>
67
 
<refsect2 id="CamelImapFolder" role="struct">
68
 
<title>struct CamelImapFolder</title>
69
 
<indexterm zone="CamelImapFolder"><primary sortas="CamelImapFolder">CamelImapFolder</primary></indexterm><programlisting>struct CamelImapFolder {
70
 
        CamelOfflineFolder parent_object;
71
 
 
72
 
        CamelImapFolderPrivate *priv;
73
 
 
74
 
        CamelFolderSearch *search;
75
 
        CamelImapMessageCache *cache;
76
 
        CamelOfflineJournal *journal;
77
 
 
78
 
        guint need_rescan:1;
79
 
        guint need_refresh:1;
80
 
        guint read_only:1;
81
 
        guint check_folder:1;
82
 
};
83
 
</programlisting>
84
 
<para>
85
 
</para></refsect2>
86
 
<refsect2 id="camel-imap-folder-new" role="function">
87
 
<title>camel_imap_folder_new ()</title>
88
 
<indexterm zone="camel-imap-folder-new"><primary sortas="camel_imap_folder_new">camel_imap_folder_new</primary></indexterm><programlisting><link linkend="CamelFolder">CamelFolder</link> *       camel_imap_folder_new               (<link linkend="CamelStore">CamelStore</link> *parent,
89
 
                                                         const <link linkend="gchar">gchar</link> *folder_name,
90
 
                                                         const <link linkend="gchar">gchar</link> *folder_dir,
91
 
                                                         <link linkend="CamelException">CamelException</link> *ex);</programlisting>
92
 
<para>
93
 
</para><variablelist role="params">
94
 
<varlistentry><term><parameter>parent</parameter>&#160;:</term>
95
 
<listitem><simpara>
96
 
</simpara></listitem></varlistentry>
97
 
<varlistentry><term><parameter>folder_name</parameter>&#160;:</term>
98
 
<listitem><simpara>
99
 
</simpara></listitem></varlistentry>
100
 
<varlistentry><term><parameter>folder_dir</parameter>&#160;:</term>
101
 
<listitem><simpara>
102
 
</simpara></listitem></varlistentry>
103
 
<varlistentry><term><parameter>ex</parameter>&#160;:</term>
104
 
<listitem><simpara>
105
 
</simpara></listitem></varlistentry>
106
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
107
 
</simpara></listitem></varlistentry>
108
 
</variablelist></refsect2>
109
 
<refsect2 id="camel-imap-folder-selected" role="function">
110
 
<title>camel_imap_folder_selected ()</title>
111
 
<indexterm zone="camel-imap-folder-selected"><primary sortas="camel_imap_folder_selected">camel_imap_folder_selected</primary></indexterm><programlisting><link linkend="void">void</link>                camel_imap_folder_selected          (<link linkend="CamelFolder">CamelFolder</link> *folder,
112
 
                                                         <link linkend="CamelImapResponse">CamelImapResponse</link> *response,
113
 
                                                         <link linkend="CamelException">CamelException</link> *ex);</programlisting>
114
 
<para>
115
 
</para><variablelist role="params">
116
 
<varlistentry><term><parameter>folder</parameter>&#160;:</term>
117
 
<listitem><simpara>
118
 
</simpara></listitem></varlistentry>
119
 
<varlistentry><term><parameter>response</parameter>&#160;:</term>
120
 
<listitem><simpara>
121
 
</simpara></listitem></varlistentry>
122
 
<varlistentry><term><parameter>ex</parameter>&#160;:</term>
123
 
<listitem><simpara>
124
 
</simpara></listitem></varlistentry>
125
 
</variablelist></refsect2>
126
 
<refsect2 id="camel-imap-folder-changed" role="function">
127
 
<title>camel_imap_folder_changed ()</title>
128
 
<indexterm zone="camel-imap-folder-changed"><primary sortas="camel_imap_folder_changed">camel_imap_folder_changed</primary></indexterm><programlisting><link linkend="void">void</link>                camel_imap_folder_changed           (<link linkend="CamelFolder">CamelFolder</link> *folder,
129
 
                                                         <link linkend="gint">gint</link> exists,
130
 
                                                         <link linkend="GArray">GArray</link> *expunged,
131
 
                                                         <link linkend="CamelException">CamelException</link> *ex);</programlisting>
132
 
<para>
133
 
</para><variablelist role="params">
134
 
<varlistentry><term><parameter>folder</parameter>&#160;:</term>
135
 
<listitem><simpara>
136
 
</simpara></listitem></varlistentry>
137
 
<varlistentry><term><parameter>exists</parameter>&#160;:</term>
138
 
<listitem><simpara>
139
 
</simpara></listitem></varlistentry>
140
 
<varlistentry><term><parameter>expunged</parameter>&#160;:</term>
141
 
<listitem><simpara>
142
 
</simpara></listitem></varlistentry>
143
 
<varlistentry><term><parameter>ex</parameter>&#160;:</term>
144
 
<listitem><simpara>
145
 
</simpara></listitem></varlistentry>
146
 
</variablelist></refsect2>
147
 
<refsect2 id="camel-imap-folder-fetch-data" role="function">
148
 
<title>camel_imap_folder_fetch_data ()</title>
149
 
<indexterm zone="camel-imap-folder-fetch-data"><primary sortas="camel_imap_folder_fetch_data">camel_imap_folder_fetch_data</primary></indexterm><programlisting><link linkend="CamelStream">CamelStream</link> *       camel_imap_folder_fetch_data        (<link linkend="CamelImapFolder">CamelImapFolder</link> *imap_folder,
150
 
                                                         const <link linkend="gchar">gchar</link> *uid,
151
 
                                                         const <link linkend="gchar">gchar</link> *section_text,
152
 
                                                         <link linkend="gboolean">gboolean</link> cache_only,
153
 
                                                         <link linkend="CamelException">CamelException</link> *ex);</programlisting>
154
 
<para>
155
 
</para><variablelist role="params">
156
 
<varlistentry><term><parameter>imap_folder</parameter>&#160;:</term>
157
 
<listitem><simpara>
158
 
</simpara></listitem></varlistentry>
159
 
<varlistentry><term><parameter>uid</parameter>&#160;:</term>
160
 
<listitem><simpara>
161
 
</simpara></listitem></varlistentry>
162
 
<varlistentry><term><parameter>section_text</parameter>&#160;:</term>
163
 
<listitem><simpara>
164
 
</simpara></listitem></varlistentry>
165
 
<varlistentry><term><parameter>cache_only</parameter>&#160;:</term>
166
 
<listitem><simpara>
167
 
</simpara></listitem></varlistentry>
168
 
<varlistentry><term><parameter>ex</parameter>&#160;:</term>
169
 
<listitem><simpara>
170
 
</simpara></listitem></varlistentry>
171
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
172
 
</simpara></listitem></varlistentry>
173
 
</variablelist></refsect2>
174
 
<refsect2 id="imap-append-resyncing" role="function">
175
 
<title>imap_append_resyncing ()</title>
176
 
<indexterm zone="imap-append-resyncing"><primary sortas="imap_append_resyncing">imap_append_resyncing</primary></indexterm><programlisting><link linkend="void">void</link>                imap_append_resyncing               (<link linkend="CamelFolder">CamelFolder</link> *folder,
177
 
                                                         <link linkend="CamelMimeMessage">CamelMimeMessage</link> *message,
178
 
                                                         const <link linkend="CamelMessageInfo">CamelMessageInfo</link> *info,
179
 
                                                         <link linkend="gchar">gchar</link> **appended_uid,
180
 
                                                         <link linkend="CamelException">CamelException</link> *ex);</programlisting>
181
 
<para>
182
 
</para><variablelist role="params">
183
 
<varlistentry><term><parameter>folder</parameter>&#160;:</term>
184
 
<listitem><simpara>
185
 
</simpara></listitem></varlistentry>
186
 
<varlistentry><term><parameter>message</parameter>&#160;:</term>
187
 
<listitem><simpara>
188
 
</simpara></listitem></varlistentry>
189
 
<varlistentry><term><parameter>info</parameter>&#160;:</term>
190
 
<listitem><simpara>
191
 
</simpara></listitem></varlistentry>
192
 
<varlistentry><term><parameter>appended_uid</parameter>&#160;:</term>
193
 
<listitem><simpara>
194
 
</simpara></listitem></varlistentry>
195
 
<varlistentry><term><parameter>ex</parameter>&#160;:</term>
196
 
<listitem><simpara>
197
 
</simpara></listitem></varlistentry>
198
 
</variablelist></refsect2>
199
 
<refsect2 id="imap-transfer-resyncing" role="function">
200
 
<title>imap_transfer_resyncing ()</title>
201
 
<indexterm zone="imap-transfer-resyncing"><primary sortas="imap_transfer_resyncing">imap_transfer_resyncing</primary></indexterm><programlisting><link linkend="void">void</link>                imap_transfer_resyncing             (<link linkend="CamelFolder">CamelFolder</link> *source,
202
 
                                                         <link linkend="GPtrArray">GPtrArray</link> *uids,
203
 
                                                         <link linkend="CamelFolder">CamelFolder</link> *dest,
204
 
                                                         <link linkend="GPtrArray">GPtrArray</link> **transferred_uids,
205
 
                                                         <link linkend="gboolean">gboolean</link> delete_originals,
206
 
                                                         <link linkend="CamelException">CamelException</link> *ex);</programlisting>
207
 
<para>
208
 
</para><variablelist role="params">
209
 
<varlistentry><term><parameter>source</parameter>&#160;:</term>
210
 
<listitem><simpara>
211
 
</simpara></listitem></varlistentry>
212
 
<varlistentry><term><parameter>uids</parameter>&#160;:</term>
213
 
<listitem><simpara>
214
 
</simpara></listitem></varlistentry>
215
 
<varlistentry><term><parameter>dest</parameter>&#160;:</term>
216
 
<listitem><simpara>
217
 
</simpara></listitem></varlistentry>
218
 
<varlistentry><term><parameter>transferred_uids</parameter>&#160;:</term>
219
 
<listitem><simpara>
220
 
</simpara></listitem></varlistentry>
221
 
<varlistentry><term><parameter>delete_originals</parameter>&#160;:</term>
222
 
<listitem><simpara>
223
 
</simpara></listitem></varlistentry>
224
 
<varlistentry><term><parameter>ex</parameter>&#160;:</term>
225
 
<listitem><simpara>
226
 
</simpara></listitem></varlistentry>
227
 
</variablelist></refsect2>
228
 
<refsect2 id="imap-expunge-uids-resyncing" role="function">
229
 
<title>imap_expunge_uids_resyncing ()</title>
230
 
<indexterm zone="imap-expunge-uids-resyncing"><primary sortas="imap_expunge_uids_resyncing">imap_expunge_uids_resyncing</primary></indexterm><programlisting><link linkend="void">void</link>                imap_expunge_uids_resyncing         (<link linkend="CamelFolder">CamelFolder</link> *folder,
231
 
                                                         <link linkend="GPtrArray">GPtrArray</link> *uids,
232
 
                                                         <link linkend="CamelException">CamelException</link> *ex);</programlisting>
233
 
<para>
234
 
</para><variablelist role="params">
235
 
<varlistentry><term><parameter>folder</parameter>&#160;:</term>
236
 
<listitem><simpara>
237
 
</simpara></listitem></varlistentry>
238
 
<varlistentry><term><parameter>uids</parameter>&#160;:</term>
239
 
<listitem><simpara>
240
 
</simpara></listitem></varlistentry>
241
 
<varlistentry><term><parameter>ex</parameter>&#160;:</term>
242
 
<listitem><simpara>
243
 
</simpara></listitem></varlistentry>
244
 
</variablelist></refsect2>
245
 
 
246
 
</refsect1>
247
 
 
248
 
 
249
 
 
250
 
 
251
 
</refentry>