← 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-imapp-stream.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-imapp-stream.xml
1
 
<refentry id="camel-CamelIMAPPStream">
2
 
<refmeta>
3
 
<refentrytitle role="top_of_page" id="camel-CamelIMAPPStream.top_of_page">CamelIMAPPStream</refentrytitle>
4
 
<manvolnum>3</manvolnum>
5
 
<refmiscinfo>CAMEL Library</refmiscinfo>
6
 
</refmeta>
7
 
 
8
 
<refnamediv>
9
 
<refname>CamelIMAPPStream</refname>
10
 
<refpurpose></refpurpose>
11
 
</refnamediv>
12
 
 
13
 
<refsynopsisdiv id="camel-CamelIMAPPStream.synopsis" role="synopsis">
14
 
<title role="synopsis.title">Synopsis</title>
15
 
 
16
 
<synopsis>
17
 
                    <link linkend="CamelIMAPPStream">CamelIMAPPStream</link>;
18
 
enum                <link linkend="camel-imapp-token-t">camel_imapp_token_t</link>;
19
 
<link linkend="CamelStream">CamelStream</link> *       <link linkend="camel-imapp-stream-new">camel_imapp_stream_new</link>              (<link linkend="CamelStream">CamelStream</link> *source);
20
 
<link linkend="camel-imapp-token-t">camel_imapp_token_t</link>  <link linkend="camel-imapp-stream-token">camel_imapp_stream_token</link>           (<link linkend="CamelIMAPPStream">CamelIMAPPStream</link> *is,
21
 
                                                         <link linkend="guchar">guchar</link> **start,
22
 
                                                         <link linkend="guint">guint</link> *len);
23
 
<link linkend="void">void</link>                <link linkend="camel-imapp-stream-ungettoken">camel_imapp_stream_ungettoken</link>       (<link linkend="CamelIMAPPStream">CamelIMAPPStream</link> *is,
24
 
                                                         <link linkend="camel-imapp-token-t">camel_imapp_token_t</link> tok,
25
 
                                                         <link linkend="guchar">guchar</link> *token,
26
 
                                                         <link linkend="guint">guint</link> len);
27
 
<link linkend="void">void</link>                <link linkend="camel-imapp-stream-set-literal">camel_imapp_stream_set_literal</link>      (<link linkend="CamelIMAPPStream">CamelIMAPPStream</link> *is,
28
 
                                                         <link linkend="guint">guint</link> literal);
29
 
<link linkend="gint">gint</link>                <link linkend="camel-imapp-stream-gets">camel_imapp_stream_gets</link>             (<link linkend="CamelIMAPPStream">CamelIMAPPStream</link> *is,
30
 
                                                         <link linkend="guchar">guchar</link> **start,
31
 
                                                         <link linkend="guint">guint</link> *len);
32
 
<link linkend="gint">gint</link>                <link linkend="camel-imapp-stream-getl">camel_imapp_stream_getl</link>             (<link linkend="CamelIMAPPStream">CamelIMAPPStream</link> *is,
33
 
                                                         <link linkend="guchar">guchar</link> **start,
34
 
                                                         <link linkend="guint">guint</link> *len);
35
 
<link linkend="gint">gint</link>                <link linkend="camel-imapp-stream-atom">camel_imapp_stream_atom</link>             (<link linkend="CamelIMAPPStream">CamelIMAPPStream</link> *is,
36
 
                                                         <link linkend="guchar">guchar</link> **start,
37
 
                                                         <link linkend="guint">guint</link> *len);
38
 
<link linkend="gint">gint</link>                <link linkend="camel-imapp-stream-astring">camel_imapp_stream_astring</link>          (<link linkend="CamelIMAPPStream">CamelIMAPPStream</link> *is,
39
 
                                                         <link linkend="guchar">guchar</link> **start);
40
 
<link linkend="gint">gint</link>                <link linkend="camel-imapp-stream-nstring">camel_imapp_stream_nstring</link>          (<link linkend="CamelIMAPPStream">CamelIMAPPStream</link> *is,
41
 
                                                         <link linkend="guchar">guchar</link> **start);
42
 
<link linkend="gint">gint</link>                <link linkend="camel-imapp-stream-nstring-stream">camel_imapp_stream_nstring_stream</link>   (<link linkend="CamelIMAPPStream">CamelIMAPPStream</link> *is,
43
 
                                                         <link linkend="CamelStream">CamelStream</link> **stream);
44
 
<link linkend="gint">gint</link>                <link linkend="camel-imapp-stream-text">camel_imapp_stream_text</link>             (<link linkend="CamelIMAPPStream">CamelIMAPPStream</link> *is,
45
 
                                                         <link linkend="guchar">guchar</link> **text);
46
 
<link linkend="guint32">guint32</link>             <link linkend="camel-imapp-stream-number">camel_imapp_stream_number</link>           (<link linkend="CamelIMAPPStream">CamelIMAPPStream</link> *is);
47
 
</synopsis>
48
 
</refsynopsisdiv>
49
 
 
50
 
 
51
 
 
52
 
 
53
 
 
54
 
 
55
 
 
56
 
 
57
 
 
58
 
<refsect1 id="camel-CamelIMAPPStream.description" role="desc">
59
 
<title role="desc.title">Description</title>
60
 
<para>
61
 
</para>
62
 
</refsect1>
63
 
 
64
 
<refsect1 id="camel-CamelIMAPPStream.details" role="details">
65
 
<title role="details.title">Details</title>
66
 
<refsect2 id="CamelIMAPPStream" role="struct">
67
 
<title>CamelIMAPPStream</title>
68
 
<indexterm zone="CamelIMAPPStream"><primary sortas="CamelIMAPPStream">CamelIMAPPStream</primary></indexterm><programlisting>typedef struct {
69
 
        CamelStream parent;
70
 
 
71
 
        CamelStream *source;
72
 
 
73
 
        /*int state;*/
74
 
        guchar *buf, *ptr, *end;
75
 
        guint literal;
76
 
 
77
 
        guint unget;
78
 
        camel_imapp_token_t unget_tok;
79
 
        guchar *unget_token;
80
 
        guint unget_len;
81
 
 
82
 
        guchar *tokenbuf, *tokenptr, *tokenend;
83
 
} CamelIMAPPStream;
84
 
</programlisting>
85
 
<para>
86
 
</para></refsect2>
87
 
<refsect2 id="camel-imapp-token-t" role="enum">
88
 
<title>enum camel_imapp_token_t</title>
89
 
<indexterm zone="camel-imapp-token-t"><primary sortas="camel_imapp_token_t">camel_imapp_token_t</primary></indexterm><programlisting>typedef enum {
90
 
        IMAP_TOK_PROTOCOL = -2,
91
 
        IMAP_TOK_ERROR = -1,
92
 
        IMAP_TOK_TOKEN = 256,
93
 
        IMAP_TOK_STRING,
94
 
        IMAP_TOK_INT,
95
 
        IMAP_TOK_LITERAL,
96
 
} camel_imapp_token_t;
97
 
</programlisting>
98
 
<para>
99
 
</para></refsect2>
100
 
<refsect2 id="camel-imapp-stream-new" role="function">
101
 
<title>camel_imapp_stream_new ()</title>
102
 
<indexterm zone="camel-imapp-stream-new"><primary sortas="camel_imapp_stream_new">camel_imapp_stream_new</primary></indexterm><programlisting><link linkend="CamelStream">CamelStream</link> *       camel_imapp_stream_new              (<link linkend="CamelStream">CamelStream</link> *source);</programlisting>
103
 
<para>
104
 
Returns a NULL stream.  A null stream is always at eof, and
105
 
always returns success for all reads and writes.</para>
106
 
<para>
107
 
</para><variablelist role="params">
108
 
<varlistentry><term><parameter>source</parameter>&#160;:</term>
109
 
<listitem><simpara>
110
 
</simpara></listitem></varlistentry>
111
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the stream
112
 
</simpara></listitem></varlistentry>
113
 
</variablelist></refsect2>
114
 
<refsect2 id="camel-imapp-stream-token" role="function">
115
 
<title>camel_imapp_stream_token ()</title>
116
 
<indexterm zone="camel-imapp-stream-token"><primary sortas="camel_imapp_stream_token">camel_imapp_stream_token</primary></indexterm><programlisting><link linkend="camel-imapp-token-t">camel_imapp_token_t</link>  camel_imapp_stream_token           (<link linkend="CamelIMAPPStream">CamelIMAPPStream</link> *is,
117
 
                                                         <link linkend="guchar">guchar</link> **start,
118
 
                                                         <link linkend="guint">guint</link> *len);</programlisting>
119
 
<para>
120
 
</para><variablelist role="params">
121
 
<varlistentry><term><parameter>is</parameter>&#160;:</term>
122
 
<listitem><simpara>
123
 
</simpara></listitem></varlistentry>
124
 
<varlistentry><term><parameter>start</parameter>&#160;:</term>
125
 
<listitem><simpara>
126
 
</simpara></listitem></varlistentry>
127
 
<varlistentry><term><parameter>len</parameter>&#160;:</term>
128
 
<listitem><simpara>
129
 
</simpara></listitem></varlistentry>
130
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
131
 
</simpara></listitem></varlistentry>
132
 
</variablelist></refsect2>
133
 
<refsect2 id="camel-imapp-stream-ungettoken" role="function">
134
 
<title>camel_imapp_stream_ungettoken ()</title>
135
 
<indexterm zone="camel-imapp-stream-ungettoken"><primary sortas="camel_imapp_stream_ungettoken">camel_imapp_stream_ungettoken</primary></indexterm><programlisting><link linkend="void">void</link>                camel_imapp_stream_ungettoken       (<link linkend="CamelIMAPPStream">CamelIMAPPStream</link> *is,
136
 
                                                         <link linkend="camel-imapp-token-t">camel_imapp_token_t</link> tok,
137
 
                                                         <link linkend="guchar">guchar</link> *token,
138
 
                                                         <link linkend="guint">guint</link> len);</programlisting>
139
 
<para>
140
 
</para><variablelist role="params">
141
 
<varlistentry><term><parameter>is</parameter>&#160;:</term>
142
 
<listitem><simpara>
143
 
</simpara></listitem></varlistentry>
144
 
<varlistentry><term><parameter>tok</parameter>&#160;:</term>
145
 
<listitem><simpara>
146
 
</simpara></listitem></varlistentry>
147
 
<varlistentry><term><parameter>token</parameter>&#160;:</term>
148
 
<listitem><simpara>
149
 
</simpara></listitem></varlistentry>
150
 
<varlistentry><term><parameter>len</parameter>&#160;:</term>
151
 
<listitem><simpara>
152
 
</simpara></listitem></varlistentry>
153
 
</variablelist></refsect2>
154
 
<refsect2 id="camel-imapp-stream-set-literal" role="function">
155
 
<title>camel_imapp_stream_set_literal ()</title>
156
 
<indexterm zone="camel-imapp-stream-set-literal"><primary sortas="camel_imapp_stream_set_literal">camel_imapp_stream_set_literal</primary></indexterm><programlisting><link linkend="void">void</link>                camel_imapp_stream_set_literal      (<link linkend="CamelIMAPPStream">CamelIMAPPStream</link> *is,
157
 
                                                         <link linkend="guint">guint</link> literal);</programlisting>
158
 
<para>
159
 
</para><variablelist role="params">
160
 
<varlistentry><term><parameter>is</parameter>&#160;:</term>
161
 
<listitem><simpara>
162
 
</simpara></listitem></varlistentry>
163
 
<varlistentry><term><parameter>literal</parameter>&#160;:</term>
164
 
<listitem><simpara>
165
 
</simpara></listitem></varlistentry>
166
 
</variablelist></refsect2>
167
 
<refsect2 id="camel-imapp-stream-gets" role="function">
168
 
<title>camel_imapp_stream_gets ()</title>
169
 
<indexterm zone="camel-imapp-stream-gets"><primary sortas="camel_imapp_stream_gets">camel_imapp_stream_gets</primary></indexterm><programlisting><link linkend="gint">gint</link>                camel_imapp_stream_gets             (<link linkend="CamelIMAPPStream">CamelIMAPPStream</link> *is,
170
 
                                                         <link linkend="guchar">guchar</link> **start,
171
 
                                                         <link linkend="guint">guint</link> *len);</programlisting>
172
 
<para>
173
 
</para><variablelist role="params">
174
 
<varlistentry><term><parameter>is</parameter>&#160;:</term>
175
 
<listitem><simpara>
176
 
</simpara></listitem></varlistentry>
177
 
<varlistentry><term><parameter>start</parameter>&#160;:</term>
178
 
<listitem><simpara>
179
 
</simpara></listitem></varlistentry>
180
 
<varlistentry><term><parameter>len</parameter>&#160;:</term>
181
 
<listitem><simpara>
182
 
</simpara></listitem></varlistentry>
183
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
184
 
</simpara></listitem></varlistentry>
185
 
</variablelist></refsect2>
186
 
<refsect2 id="camel-imapp-stream-getl" role="function">
187
 
<title>camel_imapp_stream_getl ()</title>
188
 
<indexterm zone="camel-imapp-stream-getl"><primary sortas="camel_imapp_stream_getl">camel_imapp_stream_getl</primary></indexterm><programlisting><link linkend="gint">gint</link>                camel_imapp_stream_getl             (<link linkend="CamelIMAPPStream">CamelIMAPPStream</link> *is,
189
 
                                                         <link linkend="guchar">guchar</link> **start,
190
 
                                                         <link linkend="guint">guint</link> *len);</programlisting>
191
 
<para>
192
 
</para><variablelist role="params">
193
 
<varlistentry><term><parameter>is</parameter>&#160;:</term>
194
 
<listitem><simpara>
195
 
</simpara></listitem></varlistentry>
196
 
<varlistentry><term><parameter>start</parameter>&#160;:</term>
197
 
<listitem><simpara>
198
 
</simpara></listitem></varlistentry>
199
 
<varlistentry><term><parameter>len</parameter>&#160;:</term>
200
 
<listitem><simpara>
201
 
</simpara></listitem></varlistentry>
202
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
203
 
</simpara></listitem></varlistentry>
204
 
</variablelist></refsect2>
205
 
<refsect2 id="camel-imapp-stream-atom" role="function">
206
 
<title>camel_imapp_stream_atom ()</title>
207
 
<indexterm zone="camel-imapp-stream-atom"><primary sortas="camel_imapp_stream_atom">camel_imapp_stream_atom</primary></indexterm><programlisting><link linkend="gint">gint</link>                camel_imapp_stream_atom             (<link linkend="CamelIMAPPStream">CamelIMAPPStream</link> *is,
208
 
                                                         <link linkend="guchar">guchar</link> **start,
209
 
                                                         <link linkend="guint">guint</link> *len);</programlisting>
210
 
<para>
211
 
</para><variablelist role="params">
212
 
<varlistentry><term><parameter>is</parameter>&#160;:</term>
213
 
<listitem><simpara>
214
 
</simpara></listitem></varlistentry>
215
 
<varlistentry><term><parameter>start</parameter>&#160;:</term>
216
 
<listitem><simpara>
217
 
</simpara></listitem></varlistentry>
218
 
<varlistentry><term><parameter>len</parameter>&#160;:</term>
219
 
<listitem><simpara>
220
 
</simpara></listitem></varlistentry>
221
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
222
 
</simpara></listitem></varlistentry>
223
 
</variablelist></refsect2>
224
 
<refsect2 id="camel-imapp-stream-astring" role="function">
225
 
<title>camel_imapp_stream_astring ()</title>
226
 
<indexterm zone="camel-imapp-stream-astring"><primary sortas="camel_imapp_stream_astring">camel_imapp_stream_astring</primary></indexterm><programlisting><link linkend="gint">gint</link>                camel_imapp_stream_astring          (<link linkend="CamelIMAPPStream">CamelIMAPPStream</link> *is,
227
 
                                                         <link linkend="guchar">guchar</link> **start);</programlisting>
228
 
<para>
229
 
</para><variablelist role="params">
230
 
<varlistentry><term><parameter>is</parameter>&#160;:</term>
231
 
<listitem><simpara>
232
 
</simpara></listitem></varlistentry>
233
 
<varlistentry><term><parameter>start</parameter>&#160;:</term>
234
 
<listitem><simpara>
235
 
</simpara></listitem></varlistentry>
236
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
237
 
</simpara></listitem></varlistentry>
238
 
</variablelist></refsect2>
239
 
<refsect2 id="camel-imapp-stream-nstring" role="function">
240
 
<title>camel_imapp_stream_nstring ()</title>
241
 
<indexterm zone="camel-imapp-stream-nstring"><primary sortas="camel_imapp_stream_nstring">camel_imapp_stream_nstring</primary></indexterm><programlisting><link linkend="gint">gint</link>                camel_imapp_stream_nstring          (<link linkend="CamelIMAPPStream">CamelIMAPPStream</link> *is,
242
 
                                                         <link linkend="guchar">guchar</link> **start);</programlisting>
243
 
<para>
244
 
</para><variablelist role="params">
245
 
<varlistentry><term><parameter>is</parameter>&#160;:</term>
246
 
<listitem><simpara>
247
 
</simpara></listitem></varlistentry>
248
 
<varlistentry><term><parameter>start</parameter>&#160;:</term>
249
 
<listitem><simpara>
250
 
</simpara></listitem></varlistentry>
251
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
252
 
</simpara></listitem></varlistentry>
253
 
</variablelist></refsect2>
254
 
<refsect2 id="camel-imapp-stream-nstring-stream" role="function">
255
 
<title>camel_imapp_stream_nstring_stream ()</title>
256
 
<indexterm zone="camel-imapp-stream-nstring-stream"><primary sortas="camel_imapp_stream_nstring_stream">camel_imapp_stream_nstring_stream</primary></indexterm><programlisting><link linkend="gint">gint</link>                camel_imapp_stream_nstring_stream   (<link linkend="CamelIMAPPStream">CamelIMAPPStream</link> *is,
257
 
                                                         <link linkend="CamelStream">CamelStream</link> **stream);</programlisting>
258
 
<para>
259
 
</para><variablelist role="params">
260
 
<varlistentry><term><parameter>is</parameter>&#160;:</term>
261
 
<listitem><simpara>
262
 
</simpara></listitem></varlistentry>
263
 
<varlistentry><term><parameter>stream</parameter>&#160;:</term>
264
 
<listitem><simpara>
265
 
</simpara></listitem></varlistentry>
266
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
267
 
</simpara></listitem></varlistentry>
268
 
</variablelist></refsect2>
269
 
<refsect2 id="camel-imapp-stream-text" role="function">
270
 
<title>camel_imapp_stream_text ()</title>
271
 
<indexterm zone="camel-imapp-stream-text"><primary sortas="camel_imapp_stream_text">camel_imapp_stream_text</primary></indexterm><programlisting><link linkend="gint">gint</link>                camel_imapp_stream_text             (<link linkend="CamelIMAPPStream">CamelIMAPPStream</link> *is,
272
 
                                                         <link linkend="guchar">guchar</link> **text);</programlisting>
273
 
<para>
274
 
</para><variablelist role="params">
275
 
<varlistentry><term><parameter>is</parameter>&#160;:</term>
276
 
<listitem><simpara>
277
 
</simpara></listitem></varlistentry>
278
 
<varlistentry><term><parameter>text</parameter>&#160;:</term>
279
 
<listitem><simpara>
280
 
</simpara></listitem></varlistentry>
281
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
282
 
</simpara></listitem></varlistentry>
283
 
</variablelist></refsect2>
284
 
<refsect2 id="camel-imapp-stream-number" role="function">
285
 
<title>camel_imapp_stream_number ()</title>
286
 
<indexterm zone="camel-imapp-stream-number"><primary sortas="camel_imapp_stream_number">camel_imapp_stream_number</primary></indexterm><programlisting><link linkend="guint32">guint32</link>             camel_imapp_stream_number           (<link linkend="CamelIMAPPStream">CamelIMAPPStream</link> *is);</programlisting>
287
 
<para>
288
 
</para><variablelist role="params">
289
 
<varlistentry><term><parameter>is</parameter>&#160;:</term>
290
 
<listitem><simpara>
291
 
</simpara></listitem></varlistentry>
292
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
293
 
</simpara></listitem></varlistentry>
294
 
</variablelist></refsect2>
295
 
 
296
 
</refsect1>
297
 
 
298
 
 
299
 
 
300
 
 
301
 
</refentry>