1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>GMimeMultipart</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="GMime 2.6 Reference Manual">
8 <link rel="up" href="MimeParts.html" title="MIME Messages and Parts">
9 <link rel="prev" href="GMimePart.html" title="GMimePart">
10 <link rel="next" href="GMimeMultipartEncrypted.html" title="GMimeMultipartEncrypted">
11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
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">
17 <td><a accesskey="p" href="GMimePart.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="MimeParts.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">GMime 2.6 Reference Manual</th>
21 <td><a accesskey="n" href="GMimeMultipartEncrypted.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#GMimeMultipart.synopsis" class="shortcut">Top</a>
26 <a href="#GMimeMultipart.description" class="shortcut">Description</a>
28 <a href="#GMimeMultipart.object-hierarchy" class="shortcut">Object Hierarchy</a>
31 <div class="refentry">
32 <a name="GMimeMultipart"></a><div class="titlepage"></div>
33 <div class="refnamediv"><table width="100%"><tr>
35 <h2><span class="refentrytitle"><a name="GMimeMultipart.top_of_page"></a>GMimeMultipart</span></h2>
36 <p>GMimeMultipart — MIME multiparts</p>
38 <td valign="top" align="right"></td>
40 <div class="refsynopsisdiv">
41 <a name="GMimeMultipart.synopsis"></a><h2>Synopsis</h2>
42 <pre class="synopsis">struct <a class="link" href="GMimeMultipart.html#GMimeMultipart-struct" title="struct GMimeMultipart">GMimeMultipart</a>;
43 <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="returnvalue">GMimeMultipart</span></a> * <a class="link" href="GMimeMultipart.html#g-mime-multipart-new" title="g_mime_multipart_new ()">g_mime_multipart_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
44 <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="returnvalue">GMimeMultipart</span></a> * <a class="link" href="GMimeMultipart.html#g-mime-multipart-new-with-subtype" title="g_mime_multipart_new_with_subtype ()">g_mime_multipart_new_with_subtype</a> (<em class="parameter"><code>const <span class="type">char</span> *subtype</code></em>);
45 <span class="returnvalue">void</span> <a class="link" href="GMimeMultipart.html#g-mime-multipart-set-preface" title="g_mime_multipart_set_preface ()">g_mime_multipart_set_preface</a> (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>,
46 <em class="parameter"><code>const <span class="type">char</span> *preface</code></em>);
47 const <span class="returnvalue">char</span> * <a class="link" href="GMimeMultipart.html#g-mime-multipart-get-preface" title="g_mime_multipart_get_preface ()">g_mime_multipart_get_preface</a> (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>);
48 <span class="returnvalue">void</span> <a class="link" href="GMimeMultipart.html#g-mime-multipart-set-postface" title="g_mime_multipart_set_postface ()">g_mime_multipart_set_postface</a> (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>,
49 <em class="parameter"><code>const <span class="type">char</span> *postface</code></em>);
50 const <span class="returnvalue">char</span> * <a class="link" href="GMimeMultipart.html#g-mime-multipart-get-postface" title="g_mime_multipart_get_postface ()">g_mime_multipart_get_postface</a> (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>);
51 <span class="returnvalue">void</span> <a class="link" href="GMimeMultipart.html#g-mime-multipart-set-boundary" title="g_mime_multipart_set_boundary ()">g_mime_multipart_set_boundary</a> (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>,
52 <em class="parameter"><code>const <span class="type">char</span> *boundary</code></em>);
53 const <span class="returnvalue">char</span> * <a class="link" href="GMimeMultipart.html#g-mime-multipart-get-boundary" title="g_mime_multipart_get_boundary ()">g_mime_multipart_get_boundary</a> (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>);
54 <span class="returnvalue">int</span> <a class="link" href="GMimeMultipart.html#g-mime-multipart-get-count" title="g_mime_multipart_get_count ()">g_mime_multipart_get_count</a> (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>);
55 <span class="returnvalue">gboolean</span> <a class="link" href="GMimeMultipart.html#g-mime-multipart-contains" title="g_mime_multipart_contains ()">g_mime_multipart_contains</a> (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>,
56 <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *part</code></em>);
57 <span class="returnvalue">int</span> <a class="link" href="GMimeMultipart.html#g-mime-multipart-index-of" title="g_mime_multipart_index_of ()">g_mime_multipart_index_of</a> (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>,
58 <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *part</code></em>);
59 <span class="returnvalue">void</span> <a class="link" href="GMimeMultipart.html#g-mime-multipart-add" title="g_mime_multipart_add ()">g_mime_multipart_add</a> (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>,
60 <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *part</code></em>);
61 <span class="returnvalue">void</span> <a class="link" href="GMimeMultipart.html#g-mime-multipart-clear" title="g_mime_multipart_clear ()">g_mime_multipart_clear</a> (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>);
62 <span class="returnvalue">void</span> <a class="link" href="GMimeMultipart.html#g-mime-multipart-insert" title="g_mime_multipart_insert ()">g_mime_multipart_insert</a> (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>,
63 <em class="parameter"><code><span class="type">int</span> index</code></em>,
64 <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *part</code></em>);
65 <span class="returnvalue">gboolean</span> <a class="link" href="GMimeMultipart.html#g-mime-multipart-remove" title="g_mime_multipart_remove ()">g_mime_multipart_remove</a> (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>,
66 <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *part</code></em>);
67 <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> * <a class="link" href="GMimeMultipart.html#g-mime-multipart-remove-at" title="g_mime_multipart_remove_at ()">g_mime_multipart_remove_at</a> (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>,
68 <em class="parameter"><code><span class="type">int</span> index</code></em>);
69 <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> * <a class="link" href="GMimeMultipart.html#g-mime-multipart-replace" title="g_mime_multipart_replace ()">g_mime_multipart_replace</a> (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>,
70 <em class="parameter"><code><span class="type">int</span> index</code></em>,
71 <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *replacement</code></em>);
72 <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> * <a class="link" href="GMimeMultipart.html#g-mime-multipart-get-part" title="g_mime_multipart_get_part ()">g_mime_multipart_get_part</a> (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>,
73 <em class="parameter"><code><span class="type">int</span> index</code></em>);
74 <span class="returnvalue">void</span> <a class="link" href="GMimeMultipart.html#g-mime-multipart-foreach" title="g_mime_multipart_foreach ()">g_mime_multipart_foreach</a> (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>,
75 <em class="parameter"><code><a class="link" href="GMimeObject.html#GMimeObjectForeachFunc" title="GMimeObjectForeachFunc ()"><span class="type">GMimeObjectForeachFunc</span></a> callback</code></em>,
76 <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
77 <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> * <a class="link" href="GMimeMultipart.html#g-mime-multipart-get-subpart-from-content-id" title="g_mime_multipart_get_subpart_from_content_id ()">g_mime_multipart_get_subpart_from_content_id</a>
78 (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>,
79 <em class="parameter"><code>const <span class="type">char</span> *content_id</code></em>);
82 <div class="refsect1">
83 <a name="GMimeMultipart.object-hierarchy"></a><h2>Object Hierarchy</h2>
84 <pre class="synopsis">
86 +----<a class="link" href="GMimeObject.html" title="GMimeObject">GMimeObject</a>
88 +----<a class="link" href="GMimeMultipartEncrypted.html" title="GMimeMultipartEncrypted">GMimeMultipartEncrypted</a>
89 +----<a class="link" href="GMimeMultipartSigned.html" title="GMimeMultipartSigned">GMimeMultipartSigned</a>
92 <div class="refsect1">
93 <a name="GMimeMultipart.description"></a><h2>Description</h2>
95 A <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> represents all multipart MIME container parts.
98 <div class="refsect1">
99 <a name="GMimeMultipart.details"></a><h2>Details</h2>
100 <div class="refsect2">
101 <a name="GMimeMultipart-struct"></a><h3>struct GMimeMultipart</h3>
102 <pre class="programlisting">struct GMimeMultipart;</pre>
104 A base MIME multipart object.
106 <div class="variablelist"><table border="0">
107 <col align="left" valign="top">
112 <div class="refsect2">
113 <a name="g-mime-multipart-new"></a><h3>g_mime_multipart_new ()</h3>
114 <pre class="programlisting"><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="returnvalue">GMimeMultipart</span></a> * g_mime_multipart_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
116 Creates a new MIME multipart object with a default content-type of
119 <div class="variablelist"><table border="0">
120 <col align="left" valign="top">
122 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
123 <td>an empty MIME multipart object with a default content-type of
124 multipart/mixed.</td>
129 <div class="refsect2">
130 <a name="g-mime-multipart-new-with-subtype"></a><h3>g_mime_multipart_new_with_subtype ()</h3>
131 <pre class="programlisting"><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="returnvalue">GMimeMultipart</span></a> * g_mime_multipart_new_with_subtype (<em class="parameter"><code>const <span class="type">char</span> *subtype</code></em>);</pre>
133 Creates a new MIME multipart object with a content-type of
134 multipart/<em class="parameter"><code>subtype</code></em>.
136 <div class="variablelist"><table border="0">
137 <col align="left" valign="top">
140 <td><p><span class="term"><em class="parameter"><code>subtype</code></em> :</span></p></td>
141 <td>content-type subtype</td>
144 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
145 <td>an empty MIME multipart object with a content-type of
146 multipart/<em class="parameter"><code>subtype</code></em>.</td>
152 <div class="refsect2">
153 <a name="g-mime-multipart-set-preface"></a><h3>g_mime_multipart_set_preface ()</h3>
154 <pre class="programlisting"><span class="returnvalue">void</span> g_mime_multipart_set_preface (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>,
155 <em class="parameter"><code>const <span class="type">char</span> *preface</code></em>);</pre>
157 Sets the preface on the multipart.
159 <div class="variablelist"><table border="0">
160 <col align="left" valign="top">
163 <td><p><span class="term"><em class="parameter"><code>multipart</code></em> :</span></p></td>
164 <td>a <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> object</td>
167 <td><p><span class="term"><em class="parameter"><code>preface</code></em> :</span></p></td>
174 <div class="refsect2">
175 <a name="g-mime-multipart-get-preface"></a><h3>g_mime_multipart_get_preface ()</h3>
176 <pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_multipart_get_preface (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>);</pre>
178 Gets the preface on the multipart.
180 <div class="variablelist"><table border="0">
181 <col align="left" valign="top">
184 <td><p><span class="term"><em class="parameter"><code>multipart</code></em> :</span></p></td>
185 <td>a <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> object</td>
188 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
189 <td>a pointer to the preface string on the multipart.</td>
195 <div class="refsect2">
196 <a name="g-mime-multipart-set-postface"></a><h3>g_mime_multipart_set_postface ()</h3>
197 <pre class="programlisting"><span class="returnvalue">void</span> g_mime_multipart_set_postface (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>,
198 <em class="parameter"><code>const <span class="type">char</span> *postface</code></em>);</pre>
200 Sets the postface on the multipart.
202 <div class="variablelist"><table border="0">
203 <col align="left" valign="top">
206 <td><p><span class="term"><em class="parameter"><code>multipart</code></em> :</span></p></td>
207 <td>a <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> object</td>
210 <td><p><span class="term"><em class="parameter"><code>postface</code></em> :</span></p></td>
217 <div class="refsect2">
218 <a name="g-mime-multipart-get-postface"></a><h3>g_mime_multipart_get_postface ()</h3>
219 <pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_multipart_get_postface (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>);</pre>
221 Gets the postface on the multipart.
223 <div class="variablelist"><table border="0">
224 <col align="left" valign="top">
227 <td><p><span class="term"><em class="parameter"><code>multipart</code></em> :</span></p></td>
228 <td>a <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> object</td>
231 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
232 <td>a pointer to the postface string on the multipart.</td>
238 <div class="refsect2">
239 <a name="g-mime-multipart-set-boundary"></a><h3>g_mime_multipart_set_boundary ()</h3>
240 <pre class="programlisting"><span class="returnvalue">void</span> g_mime_multipart_set_boundary (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>,
241 <em class="parameter"><code>const <span class="type">char</span> *boundary</code></em>);</pre>
243 Sets <em class="parameter"><code>boundary</code></em> as the boundary on the multipart. If <em class="parameter"><code>boundary</code></em> is
244 <code class="literal">NULL</code>, then a boundary will be auto-generated for you.
246 <div class="variablelist"><table border="0">
247 <col align="left" valign="top">
250 <td><p><span class="term"><em class="parameter"><code>multipart</code></em> :</span></p></td>
251 <td>a <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> object</td>
254 <td><p><span class="term"><em class="parameter"><code>boundary</code></em> :</span></p></td>
255 <td>boundary or <code class="literal">NULL</code> to autogenerate one</td>
261 <div class="refsect2">
262 <a name="g-mime-multipart-get-boundary"></a><h3>g_mime_multipart_get_boundary ()</h3>
263 <pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_multipart_get_boundary (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>);</pre>
265 Gets the boundary on the multipart. If the internal boundary is
266 <code class="literal">NULL</code>, then an auto-generated boundary will be set on the multipart
269 <div class="variablelist"><table border="0">
270 <col align="left" valign="top">
273 <td><p><span class="term"><em class="parameter"><code>multipart</code></em> :</span></p></td>
274 <td>a <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> object</td>
277 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
278 <td>the boundary on the multipart.</td>
284 <div class="refsect2">
285 <a name="g-mime-multipart-get-count"></a><h3>g_mime_multipart_get_count ()</h3>
286 <pre class="programlisting"><span class="returnvalue">int</span> g_mime_multipart_get_count (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>);</pre>
288 Gets the number of mime parts contained within the multipart.
290 <div class="variablelist"><table border="0">
291 <col align="left" valign="top">
294 <td><p><span class="term"><em class="parameter"><code>multipart</code></em> :</span></p></td>
295 <td>a <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> object</td>
298 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
299 <td>the number of mime parts contained within the multipart.</td>
305 <div class="refsect2">
306 <a name="g-mime-multipart-contains"></a><h3>g_mime_multipart_contains ()</h3>
307 <pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_multipart_contains (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>,
308 <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *part</code></em>);</pre>
310 Checks if <em class="parameter"><code>part</code></em> is contained within <em class="parameter"><code>multipart</code></em>.
312 <div class="variablelist"><table border="0">
313 <col align="left" valign="top">
316 <td><p><span class="term"><em class="parameter"><code>multipart</code></em> :</span></p></td>
317 <td>a <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> object</td>
320 <td><p><span class="term"><em class="parameter"><code>part</code></em> :</span></p></td>
324 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
326 <code class="literal">TRUE</code> if <em class="parameter"><code>part</code></em> is a subpart of <em class="parameter"><code>multipart</code></em> or <code class="literal">FALSE</code>
333 <div class="refsect2">
334 <a name="g-mime-multipart-index-of"></a><h3>g_mime_multipart_index_of ()</h3>
335 <pre class="programlisting"><span class="returnvalue">int</span> g_mime_multipart_index_of (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>,
336 <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *part</code></em>);</pre>
338 Gets the index of <em class="parameter"><code>part</code></em> within <em class="parameter"><code>multipart</code></em>.
340 <div class="variablelist"><table border="0">
341 <col align="left" valign="top">
344 <td><p><span class="term"><em class="parameter"><code>multipart</code></em> :</span></p></td>
345 <td>a <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> object</td>
348 <td><p><span class="term"><em class="parameter"><code>part</code></em> :</span></p></td>
352 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
353 <td>the index of <em class="parameter"><code>part</code></em> within <em class="parameter"><code>multipart</code></em> or <code class="literal">-1</code> if not found.</td>
359 <div class="refsect2">
360 <a name="g-mime-multipart-add"></a><h3>g_mime_multipart_add ()</h3>
361 <pre class="programlisting"><span class="returnvalue">void</span> g_mime_multipart_add (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>,
362 <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *part</code></em>);</pre>
364 Adds a mime part to the multipart.
366 <div class="variablelist"><table border="0">
367 <col align="left" valign="top">
370 <td><p><span class="term"><em class="parameter"><code>multipart</code></em> :</span></p></td>
371 <td>a <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> object</td>
374 <td><p><span class="term"><em class="parameter"><code>part</code></em> :</span></p></td>
375 <td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a>
382 <div class="refsect2">
383 <a name="g-mime-multipart-clear"></a><h3>g_mime_multipart_clear ()</h3>
384 <pre class="programlisting"><span class="returnvalue">void</span> g_mime_multipart_clear (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>);</pre>
386 Removes all subparts from <em class="parameter"><code>multipart</code></em>.
388 <div class="variablelist"><table border="0">
389 <col align="left" valign="top">
391 <td><p><span class="term"><em class="parameter"><code>multipart</code></em> :</span></p></td>
392 <td>a <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> object</td>
397 <div class="refsect2">
398 <a name="g-mime-multipart-insert"></a><h3>g_mime_multipart_insert ()</h3>
399 <pre class="programlisting"><span class="returnvalue">void</span> g_mime_multipart_insert (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>,
400 <em class="parameter"><code><span class="type">int</span> index</code></em>,
401 <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *part</code></em>);</pre>
403 Inserts the specified mime part into the multipart at the position
404 <em class="parameter"><code>index</code></em>.
406 <div class="variablelist"><table border="0">
407 <col align="left" valign="top">
410 <td><p><span class="term"><em class="parameter"><code>multipart</code></em> :</span></p></td>
411 <td>a <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> object</td>
414 <td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td>
415 <td>position to insert the mime part</td>
418 <td><p><span class="term"><em class="parameter"><code>part</code></em> :</span></p></td>
425 <div class="refsect2">
426 <a name="g-mime-multipart-remove"></a><h3>g_mime_multipart_remove ()</h3>
427 <pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_multipart_remove (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>,
428 <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *part</code></em>);</pre>
430 Removes the specified mime part from the multipart.
432 <div class="variablelist"><table border="0">
433 <col align="left" valign="top">
436 <td><p><span class="term"><em class="parameter"><code>multipart</code></em> :</span></p></td>
437 <td>a <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> object</td>
440 <td><p><span class="term"><em class="parameter"><code>part</code></em> :</span></p></td>
444 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
446 <code class="literal">TRUE</code> if the part was removed or <code class="literal">FALSE</code> otherwise.</td>
452 <div class="refsect2">
453 <a name="g-mime-multipart-remove-at"></a><h3>g_mime_multipart_remove_at ()</h3>
454 <pre class="programlisting"><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> * g_mime_multipart_remove_at (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>,
455 <em class="parameter"><code><span class="type">int</span> index</code></em>);</pre>
457 Removes the mime part at position <em class="parameter"><code>index</code></em> from the multipart.
459 <div class="variablelist"><table border="0">
460 <col align="left" valign="top">
463 <td><p><span class="term"><em class="parameter"><code>multipart</code></em> :</span></p></td>
464 <td>a <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> object</td>
467 <td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td>
468 <td>position of the mime part to remove</td>
471 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
472 <td>the mime part that was removed or <code class="literal">NULL</code> if the part was
473 not contained within the multipart.</td>
479 <div class="refsect2">
480 <a name="g-mime-multipart-replace"></a><h3>g_mime_multipart_replace ()</h3>
481 <pre class="programlisting"><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> * g_mime_multipart_replace (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>,
482 <em class="parameter"><code><span class="type">int</span> index</code></em>,
483 <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *replacement</code></em>);</pre>
485 Replaces the mime part at position <em class="parameter"><code>index</code></em> within <em class="parameter"><code>multipart</code></em> with
486 <em class="parameter"><code>replacement</code></em>.
488 <div class="variablelist"><table border="0">
489 <col align="left" valign="top">
492 <td><p><span class="term"><em class="parameter"><code>multipart</code></em> :</span></p></td>
493 <td>a <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> object</td>
496 <td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td>
497 <td>position of the mime part to replace</td>
500 <td><p><span class="term"><em class="parameter"><code>replacement</code></em> :</span></p></td>
501 <td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> to use as the replacement</td>
504 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
505 <td>the mime part that was replaced or <code class="literal">NULL</code> if the part was
506 not contained within the multipart.</td>
512 <div class="refsect2">
513 <a name="g-mime-multipart-get-part"></a><h3>g_mime_multipart_get_part ()</h3>
514 <pre class="programlisting"><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> * g_mime_multipart_get_part (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>,
515 <em class="parameter"><code><span class="type">int</span> index</code></em>);</pre>
517 Gets the mime part at position <em class="parameter"><code>index</code></em> within the multipart.
519 <div class="variablelist"><table border="0">
520 <col align="left" valign="top">
523 <td><p><span class="term"><em class="parameter"><code>multipart</code></em> :</span></p></td>
524 <td>a <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> object</td>
527 <td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td>
528 <td>position of the mime part</td>
531 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
532 <td>the mime part at position <em class="parameter"><code>index</code></em>.</td>
538 <div class="refsect2">
539 <a name="g-mime-multipart-foreach"></a><h3>g_mime_multipart_foreach ()</h3>
540 <pre class="programlisting"><span class="returnvalue">void</span> g_mime_multipart_foreach (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>,
541 <em class="parameter"><code><a class="link" href="GMimeObject.html#GMimeObjectForeachFunc" title="GMimeObjectForeachFunc ()"><span class="type">GMimeObjectForeachFunc</span></a> callback</code></em>,
542 <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
544 Recursively calls <em class="parameter"><code>callback</code></em> on each of <em class="parameter"><code>multipart</code></em>'s subparts.
546 <div class="variablelist"><table border="0">
547 <col align="left" valign="top">
550 <td><p><span class="term"><em class="parameter"><code>multipart</code></em> :</span></p></td>
551 <td>a <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a>
555 <td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
556 <td>function to call for each of <em class="parameter"><code>multipart</code></em>'s subparts.</td>
559 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
560 <td>user-supplied callback data</td>
566 <div class="refsect2">
567 <a name="g-mime-multipart-get-subpart-from-content-id"></a><h3>g_mime_multipart_get_subpart_from_content_id ()</h3>
568 <pre class="programlisting"><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> * g_mime_multipart_get_subpart_from_content_id
569 (<em class="parameter"><code><a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> *multipart</code></em>,
570 <em class="parameter"><code>const <span class="type">char</span> *content_id</code></em>);</pre>
572 Gets the mime part with the content-id <em class="parameter"><code>content_id</code></em> from the
573 multipart <em class="parameter"><code>multipart</code></em>.
575 <div class="variablelist"><table border="0">
576 <col align="left" valign="top">
579 <td><p><span class="term"><em class="parameter"><code>multipart</code></em> :</span></p></td>
583 <td><p><span class="term"><em class="parameter"><code>content_id</code></em> :</span></p></td>
584 <td>the content id of the part to look for</td>
587 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
588 <td>the <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> whose content-id matches the search string,
589 or <code class="literal">NULL</code> if a match cannot be found.</td>
598 Generated by GTK-Doc V1.18</div>