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

« back to all changes in this revision

Viewing changes to docs/reference/camel/html/camel-CamelMultipart.html

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.1.79 upstream) (1.6.12 experimental)
  • Revision ID: james.westby@ubuntu.com-20100517170206-4ufr52vwrhh26yh0
Tags: 2.30.1-1ubuntu1
* Merge from debian experimental. Remaining change:
  (LP: #42199, #229669, #173703, #360344, #508494)
  + debian/control:
    - add Vcs-Bzr tag
    - don't use libgnome
    - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  + debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    - use the upstream versioning, not a Debian-specific one 
  + debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
    debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
    - install html documentation
  + debian/rules:
    - don't build documentation it's shipped with the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>CamelMultipart</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
7
<link rel="home" href="index.html" title="Camel Reference Manual">
8
8
<link rel="up" href="MIME.html" title="MIME Objects">
9
9
<link rel="prev" href="camel-CamelMimePart.html" title="CamelMimePart">
26
26
                  <a href="#camel-CamelMultipart.description" class="shortcut">Description</a>
27
27
</td></tr>
28
28
</table>
29
 
<div class="refentry" lang="en">
 
29
<div class="refentry" title="CamelMultipart">
30
30
<a name="camel-CamelMultipart"></a><div class="titlepage"></div>
31
31
<div class="refnamediv"><table width="100%"><tr>
32
32
<td valign="top">
35
35
</td>
36
36
<td valign="top" align="right"></td>
37
37
</tr></table></div>
38
 
<div class="refsynopsisdiv">
 
38
<div class="refsynopsisdiv" title="Synopsis">
39
39
<a name="camel-CamelMultipart.synopsis"></a><h2>Synopsis</h2>
40
40
<pre class="synopsis">struct              <a class="link" href="camel-CamelMultipart.html#CamelMultipart" title="struct CamelMultipart">CamelMultipart</a>;
41
41
<a class="link" href="camel-CamelMultipart.html#CamelMultipart" title="struct CamelMultipart"><span class="returnvalue">CamelMultipart</span></a> *    <a class="link" href="camel-CamelMultipart.html#camel-multipart-new" title="camel_multipart_new ()">camel_multipart_new</a>                 (<em class="parameter"><code><span class="type">void</span></code></em>);
63
63
                                                         <em class="parameter"><code><span class="type">struct _CamelMimeParser</span> *parser</code></em>);
64
64
</pre>
65
65
</div>
66
 
<div class="refsect1" lang="en">
 
66
<div class="refsect1" title="Description">
67
67
<a name="camel-CamelMultipart.description"></a><h2>Description</h2>
68
68
<p>
69
69
</p>
70
70
</div>
71
 
<div class="refsect1" lang="en">
 
71
<div class="refsect1" title="Details">
72
72
<a name="camel-CamelMultipart.details"></a><h2>Details</h2>
73
 
<div class="refsect2" lang="en">
 
73
<div class="refsect2" title="struct CamelMultipart">
74
74
<a name="CamelMultipart"></a><h3>struct CamelMultipart</h3>
75
75
<pre class="programlisting">struct CamelMultipart {
76
76
        CamelDataWrapper parent_object;
84
84
</p>
85
85
</div>
86
86
<hr>
87
 
<div class="refsect2" lang="en">
 
87
<div class="refsect2" title="camel_multipart_new ()">
88
88
<a name="camel-multipart-new"></a><h3>camel_multipart_new ()</h3>
89
89
<pre class="programlisting"><a class="link" href="camel-CamelMultipart.html#CamelMultipart" title="struct CamelMultipart"><span class="returnvalue">CamelMultipart</span></a> *    camel_multipart_new                 (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
90
90
<p>
91
 
Create a new <a class="link" href="camel-CamelMultipart.html#CamelMultipart" title="struct CamelMultipart"><span class="type">CamelMultipart</span></a> object.</p>
 
91
Create a new <a class="link" href="camel-CamelMultipart.html#CamelMultipart" title="struct CamelMultipart"><span class="type">CamelMultipart</span></a> object.
 
92
</p>
92
93
<div class="variablelist"><table border="0">
93
94
<col align="left" valign="top">
94
95
<tbody><tr>
99
100
</table></div>
100
101
</div>
101
102
<hr>
102
 
<div class="refsect2" lang="en">
 
103
<div class="refsect2" title="camel_multipart_add_part ()">
103
104
<a name="camel-multipart-add-part"></a><h3>camel_multipart_add_part ()</h3>
104
105
<pre class="programlisting"><span class="returnvalue">void</span>                camel_multipart_add_part            (<em class="parameter"><code><a class="link" href="camel-CamelMultipart.html#CamelMultipart" title="struct CamelMultipart"><span class="type">CamelMultipart</span></a> *multipart</code></em>,
105
106
                                                         <em class="parameter"><code><a class="link" href="camel-CamelMimePart.html#CamelMimePart" title="struct CamelMimePart"><span class="type">CamelMimePart</span></a> *part</code></em>);</pre>
106
107
<p>
107
 
Appends the part to the multipart object.</p>
 
108
Appends the part to the multipart object.
 
109
</p>
108
110
<div class="variablelist"><table border="0">
109
111
<col align="left" valign="top">
110
112
<tbody>
122
124
</table></div>
123
125
</div>
124
126
<hr>
125
 
<div class="refsect2" lang="en">
 
127
<div class="refsect2" title="camel_multipart_add_part_at ()">
126
128
<a name="camel-multipart-add-part-at"></a><h3>camel_multipart_add_part_at ()</h3>
127
129
<pre class="programlisting"><span class="returnvalue">void</span>                camel_multipart_add_part_at         (<em class="parameter"><code><a class="link" href="camel-CamelMultipart.html#CamelMultipart" title="struct CamelMultipart"><span class="type">CamelMultipart</span></a> *multipart</code></em>,
128
130
                                                         <em class="parameter"><code><a class="link" href="camel-CamelMimePart.html#CamelMimePart" title="struct CamelMimePart"><span class="type">CamelMimePart</span></a> *part</code></em>,
130
132
<p>
131
133
Adds the part to the multipart object after the <em class="parameter"><code>index</code></em>'th
132
134
element. If <em class="parameter"><code>index</code></em> is greater than the number of parts, it is
133
 
equivalent to <a class="link" href="camel-CamelMultipart.html#camel-multipart-add-part" title="camel_multipart_add_part ()"><span class="type">camel_multipart_add_part</span></a>.</p>
 
135
equivalent to <a class="link" href="camel-CamelMultipart.html#camel-multipart-add-part" title="camel_multipart_add_part ()"><span class="type">camel_multipart_add_part</span></a>.
 
136
</p>
134
137
<div class="variablelist"><table border="0">
135
138
<col align="left" valign="top">
136
139
<tbody>
153
156
</table></div>
154
157
</div>
155
158
<hr>
156
 
<div class="refsect2" lang="en">
 
159
<div class="refsect2" title="camel_multipart_remove_part ()">
157
160
<a name="camel-multipart-remove-part"></a><h3>camel_multipart_remove_part ()</h3>
158
161
<pre class="programlisting"><span class="returnvalue">void</span>                camel_multipart_remove_part         (<em class="parameter"><code><a class="link" href="camel-CamelMultipart.html#CamelMultipart" title="struct CamelMultipart"><span class="type">CamelMultipart</span></a> *multipart</code></em>,
159
162
                                                         <em class="parameter"><code><a class="link" href="camel-CamelMimePart.html#CamelMimePart" title="struct CamelMimePart"><span class="type">CamelMimePart</span></a> *part</code></em>);</pre>
160
163
<p>
161
 
Removes <em class="parameter"><code>part</code></em> from <em class="parameter"><code>multipart</code></em>.</p>
 
164
Removes <em class="parameter"><code>part</code></em> from <em class="parameter"><code>multipart</code></em>.
 
165
</p>
162
166
<div class="variablelist"><table border="0">
163
167
<col align="left" valign="top">
164
168
<tbody>
176
180
</table></div>
177
181
</div>
178
182
<hr>
179
 
<div class="refsect2" lang="en">
 
183
<div class="refsect2" title="camel_multipart_remove_part_at ()">
180
184
<a name="camel-multipart-remove-part-at"></a><h3>camel_multipart_remove_part_at ()</h3>
181
185
<pre class="programlisting"><a class="link" href="camel-CamelMimePart.html#CamelMimePart" title="struct CamelMimePart"><span class="returnvalue">CamelMimePart</span></a> *     camel_multipart_remove_part_at      (<em class="parameter"><code><a class="link" href="camel-CamelMultipart.html#CamelMultipart" title="struct CamelMultipart"><span class="type">CamelMultipart</span></a> *multipart</code></em>,
182
186
                                                         <em class="parameter"><code><span class="type">guint</span> index</code></em>);</pre>
183
187
<p>
184
 
Remove the indicated part from the multipart object.</p>
 
188
Remove the indicated part from the multipart object.
 
189
</p>
185
190
<div class="variablelist"><table border="0">
186
191
<col align="left" valign="top">
187
192
<tbody>
205
210
</table></div>
206
211
</div>
207
212
<hr>
208
 
<div class="refsect2" lang="en">
 
213
<div class="refsect2" title="camel_multipart_get_part ()">
209
214
<a name="camel-multipart-get-part"></a><h3>camel_multipart_get_part ()</h3>
210
215
<pre class="programlisting"><a class="link" href="camel-CamelMimePart.html#CamelMimePart" title="struct CamelMimePart"><span class="returnvalue">CamelMimePart</span></a> *     camel_multipart_get_part            (<em class="parameter"><code><a class="link" href="camel-CamelMultipart.html#CamelMultipart" title="struct CamelMultipart"><span class="type">CamelMultipart</span></a> *multipart</code></em>,
211
216
                                                         <em class="parameter"><code><span class="type">guint</span> index</code></em>);</pre>
231
236
</table></div>
232
237
</div>
233
238
<hr>
234
 
<div class="refsect2" lang="en">
 
239
<div class="refsect2" title="camel_multipart_get_number ()">
235
240
<a name="camel-multipart-get-number"></a><h3>camel_multipart_get_number ()</h3>
236
241
<pre class="programlisting"><span class="returnvalue">guint</span>               camel_multipart_get_number          (<em class="parameter"><code><a class="link" href="camel-CamelMultipart.html#CamelMultipart" title="struct CamelMultipart"><span class="type">CamelMultipart</span></a> *multipart</code></em>);</pre>
237
242
<div class="variablelist"><table border="0">
251
256
</table></div>
252
257
</div>
253
258
<hr>
254
 
<div class="refsect2" lang="en">
 
259
<div class="refsect2" title="camel_multipart_set_boundary ()">
255
260
<a name="camel-multipart-set-boundary"></a><h3>camel_multipart_set_boundary ()</h3>
256
261
<pre class="programlisting"><span class="returnvalue">void</span>                camel_multipart_set_boundary        (<em class="parameter"><code><a class="link" href="camel-CamelMultipart.html#CamelMultipart" title="struct CamelMultipart"><span class="type">CamelMultipart</span></a> *multipart</code></em>,
257
262
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *boundary</code></em>);</pre>
259
264
Sets the message boundary for <em class="parameter"><code>multipart</code></em> to <em class="parameter"><code>boundary</code></em>. This should
260
265
be a string which does not occur anywhere in any of <em class="parameter"><code>multipart</code></em>'s
261
266
subparts. If <em class="parameter"><code>boundary</code></em> is <code class="literal">NULL</code>, a randomly-generated boundary will
262
 
be used.</p>
 
267
be used.
 
268
</p>
263
269
<div class="variablelist"><table border="0">
264
270
<col align="left" valign="top">
265
271
<tbody>
277
283
</table></div>
278
284
</div>
279
285
<hr>
280
 
<div class="refsect2" lang="en">
 
286
<div class="refsect2" title="camel_multipart_get_boundary ()">
281
287
<a name="camel-multipart-get-boundary"></a><h3>camel_multipart_get_boundary ()</h3>
282
288
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       camel_multipart_get_boundary        (<em class="parameter"><code><a class="link" href="camel-CamelMultipart.html#CamelMultipart" title="struct CamelMultipart"><span class="type">CamelMultipart</span></a> *multipart</code></em>);</pre>
283
289
<div class="variablelist"><table border="0">
297
303
</table></div>
298
304
</div>
299
305
<hr>
300
 
<div class="refsect2" lang="en">
 
306
<div class="refsect2" title="camel_multipart_set_preface ()">
301
307
<a name="camel-multipart-set-preface"></a><h3>camel_multipart_set_preface ()</h3>
302
308
<pre class="programlisting"><span class="returnvalue">void</span>                camel_multipart_set_preface         (<em class="parameter"><code><a class="link" href="camel-CamelMultipart.html#CamelMultipart" title="struct CamelMultipart"><span class="type">CamelMultipart</span></a> *multipart</code></em>,
303
309
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *preface</code></em>);</pre>
304
310
<p>
305
311
Set the preface text for this multipart.  Will be written out infront
306
312
of the multipart.  This text should only include US-ASCII strings, and
307
 
be relatively short, and will be ignored by any MIME mail client.</p>
 
313
be relatively short, and will be ignored by any MIME mail client.
 
314
</p>
308
315
<div class="variablelist"><table border="0">
309
316
<col align="left" valign="top">
310
317
<tbody>
322
329
</table></div>
323
330
</div>
324
331
<hr>
325
 
<div class="refsect2" lang="en">
 
332
<div class="refsect2" title="camel_multipart_set_postface ()">
326
333
<a name="camel-multipart-set-postface"></a><h3>camel_multipart_set_postface ()</h3>
327
334
<pre class="programlisting"><span class="returnvalue">void</span>                camel_multipart_set_postface        (<em class="parameter"><code><a class="link" href="camel-CamelMultipart.html#CamelMultipart" title="struct CamelMultipart"><span class="type">CamelMultipart</span></a> *multipart</code></em>,
328
335
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *postface</code></em>);</pre>
332
339
client.
333
340
</p>
334
341
<p>
335
 
Generally postface texts should not be sent with multipart messages.</p>
 
342
Generally postface texts should not be sent with multipart messages.
 
343
</p>
336
344
<div class="variablelist"><table border="0">
337
345
<col align="left" valign="top">
338
346
<tbody>
350
358
</table></div>
351
359
</div>
352
360
<hr>
353
 
<div class="refsect2" lang="en">
 
361
<div class="refsect2" title="camel_multipart_construct_from_parser ()">
354
362
<a name="camel-multipart-construct-from-parser"></a><h3>camel_multipart_construct_from_parser ()</h3>
355
363
<pre class="programlisting"><span class="returnvalue">gint</span>                camel_multipart_construct_from_parser
356
364
                                                        (<em class="parameter"><code><a class="link" href="camel-CamelMultipart.html#CamelMultipart" title="struct CamelMultipart"><span class="type">CamelMultipart</span></a> *multipart</code></em>,
357
365
                                                         <em class="parameter"><code><span class="type">struct _CamelMimeParser</span> *parser</code></em>);</pre>
358
366
<p>
359
 
Construct a multipart from a parser.</p>
 
367
Construct a multipart from a parser.
 
368
</p>
360
369
<div class="variablelist"><table border="0">
361
370
<col align="left" valign="top">
362
371
<tbody>