Initialize the gmime for upstream
[platform/upstream/gmime.git] / docs / reference / html / GMimeMultipart.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>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">
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="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>
22 </tr>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#GMimeMultipart.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#GMimeMultipart.description" class="shortcut">Description</a>
27                    | 
28                   <a href="#GMimeMultipart.object-hierarchy" class="shortcut">Object Hierarchy</a>
29 </td></tr>
30 </table>
31 <div class="refentry">
32 <a name="GMimeMultipart"></a><div class="titlepage"></div>
33 <div class="refnamediv"><table width="100%"><tr>
34 <td valign="top">
35 <h2><span class="refentrytitle"><a name="GMimeMultipart.top_of_page"></a>GMimeMultipart</span></h2>
36 <p>GMimeMultipart — MIME multiparts</p>
37 </td>
38 <td valign="top" align="right"></td>
39 </tr></table></div>
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>);
80 </pre>
81 </div>
82 <div class="refsect1">
83 <a name="GMimeMultipart.object-hierarchy"></a><h2>Object Hierarchy</h2>
84 <pre class="synopsis">
85   GObject
86    +----<a class="link" href="GMimeObject.html" title="GMimeObject">GMimeObject</a>
87          +----GMimeMultipart
88                +----<a class="link" href="GMimeMultipartEncrypted.html" title="GMimeMultipartEncrypted">GMimeMultipartEncrypted</a>
89                +----<a class="link" href="GMimeMultipartSigned.html" title="GMimeMultipartSigned">GMimeMultipartSigned</a>
90 </pre>
91 </div>
92 <div class="refsect1">
93 <a name="GMimeMultipart.description"></a><h2>Description</h2>
94 <p>
95 A <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> represents all multipart MIME container parts.
96 </p>
97 </div>
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>
103 <p>
104 A base MIME multipart object.
105 </p>
106 <div class="variablelist"><table border="0">
107 <col align="left" valign="top">
108 <tbody></tbody>
109 </table></div>
110 </div>
111 <hr>
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>
115 <p>
116 Creates a new MIME multipart object with a default content-type of
117 multipart/mixed.
118 </p>
119 <div class="variablelist"><table border="0">
120 <col align="left" valign="top">
121 <tbody><tr>
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>
125 </tr></tbody>
126 </table></div>
127 </div>
128 <hr>
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>
132 <p>
133 Creates a new MIME multipart object with a content-type of
134 multipart/<em class="parameter"><code>subtype</code></em>.
135 </p>
136 <div class="variablelist"><table border="0">
137 <col align="left" valign="top">
138 <tbody>
139 <tr>
140 <td><p><span class="term"><em class="parameter"><code>subtype</code></em> :</span></p></td>
141 <td>content-type subtype</td>
142 </tr>
143 <tr>
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>
147 </tr>
148 </tbody>
149 </table></div>
150 </div>
151 <hr>
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>
156 <p>
157 Sets the preface on the multipart.
158 </p>
159 <div class="variablelist"><table border="0">
160 <col align="left" valign="top">
161 <tbody>
162 <tr>
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>
165 </tr>
166 <tr>
167 <td><p><span class="term"><em class="parameter"><code>preface</code></em> :</span></p></td>
168 <td>preface</td>
169 </tr>
170 </tbody>
171 </table></div>
172 </div>
173 <hr>
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>
177 <p>
178 Gets the preface on the multipart.
179 </p>
180 <div class="variablelist"><table border="0">
181 <col align="left" valign="top">
182 <tbody>
183 <tr>
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>
186 </tr>
187 <tr>
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>
190 </tr>
191 </tbody>
192 </table></div>
193 </div>
194 <hr>
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>
199 <p>
200 Sets the postface on the multipart.
201 </p>
202 <div class="variablelist"><table border="0">
203 <col align="left" valign="top">
204 <tbody>
205 <tr>
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>
208 </tr>
209 <tr>
210 <td><p><span class="term"><em class="parameter"><code>postface</code></em> :</span></p></td>
211 <td>postface</td>
212 </tr>
213 </tbody>
214 </table></div>
215 </div>
216 <hr>
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>
220 <p>
221 Gets the postface on the multipart.
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>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>
229 </tr>
230 <tr>
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>
233 </tr>
234 </tbody>
235 </table></div>
236 </div>
237 <hr>
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>
242 <p>
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.
245 </p>
246 <div class="variablelist"><table border="0">
247 <col align="left" valign="top">
248 <tbody>
249 <tr>
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>
252 </tr>
253 <tr>
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>
256 </tr>
257 </tbody>
258 </table></div>
259 </div>
260 <hr>
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>
264 <p>
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
267 and returned.
268 </p>
269 <div class="variablelist"><table border="0">
270 <col align="left" valign="top">
271 <tbody>
272 <tr>
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>
275 </tr>
276 <tr>
277 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
278 <td>the boundary on the multipart.</td>
279 </tr>
280 </tbody>
281 </table></div>
282 </div>
283 <hr>
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>
287 <p>
288 Gets the number of mime parts contained within the multipart.
289 </p>
290 <div class="variablelist"><table border="0">
291 <col align="left" valign="top">
292 <tbody>
293 <tr>
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>
296 </tr>
297 <tr>
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>
300 </tr>
301 </tbody>
302 </table></div>
303 </div>
304 <hr>
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>
309 <p>
310 Checks if <em class="parameter"><code>part</code></em> is contained within <em class="parameter"><code>multipart</code></em>.
311 </p>
312 <div class="variablelist"><table border="0">
313 <col align="left" valign="top">
314 <tbody>
315 <tr>
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>
318 </tr>
319 <tr>
320 <td><p><span class="term"><em class="parameter"><code>part</code></em> :</span></p></td>
321 <td>mime part</td>
322 </tr>
323 <tr>
324 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
325 <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>
327 otherwise.</td>
328 </tr>
329 </tbody>
330 </table></div>
331 </div>
332 <hr>
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>
337 <p>
338 Gets the index of <em class="parameter"><code>part</code></em> within <em class="parameter"><code>multipart</code></em>.
339 </p>
340 <div class="variablelist"><table border="0">
341 <col align="left" valign="top">
342 <tbody>
343 <tr>
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>
346 </tr>
347 <tr>
348 <td><p><span class="term"><em class="parameter"><code>part</code></em> :</span></p></td>
349 <td>mime part</td>
350 </tr>
351 <tr>
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>
354 </tr>
355 </tbody>
356 </table></div>
357 </div>
358 <hr>
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>
363 <p>
364 Adds a mime part to the multipart.
365 </p>
366 <div class="variablelist"><table border="0">
367 <col align="left" valign="top">
368 <tbody>
369 <tr>
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>
372 </tr>
373 <tr>
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>
376 </td>
377 </tr>
378 </tbody>
379 </table></div>
380 </div>
381 <hr>
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>
385 <p>
386 Removes all subparts from <em class="parameter"><code>multipart</code></em>.
387 </p>
388 <div class="variablelist"><table border="0">
389 <col align="left" valign="top">
390 <tbody><tr>
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>
393 </tr></tbody>
394 </table></div>
395 </div>
396 <hr>
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>
402 <p>
403 Inserts the specified mime part into the multipart at the position
404 <em class="parameter"><code>index</code></em>.
405 </p>
406 <div class="variablelist"><table border="0">
407 <col align="left" valign="top">
408 <tbody>
409 <tr>
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>
412 </tr>
413 <tr>
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>
416 </tr>
417 <tr>
418 <td><p><span class="term"><em class="parameter"><code>part</code></em> :</span></p></td>
419 <td>mime part</td>
420 </tr>
421 </tbody>
422 </table></div>
423 </div>
424 <hr>
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>
429 <p>
430 Removes the specified mime part from the multipart.
431 </p>
432 <div class="variablelist"><table border="0">
433 <col align="left" valign="top">
434 <tbody>
435 <tr>
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>
438 </tr>
439 <tr>
440 <td><p><span class="term"><em class="parameter"><code>part</code></em> :</span></p></td>
441 <td>mime part</td>
442 </tr>
443 <tr>
444 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
445 <td>
446 <code class="literal">TRUE</code> if the part was removed or <code class="literal">FALSE</code> otherwise.</td>
447 </tr>
448 </tbody>
449 </table></div>
450 </div>
451 <hr>
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>
456 <p>
457 Removes the mime part at position <em class="parameter"><code>index</code></em> from the multipart.
458 </p>
459 <div class="variablelist"><table border="0">
460 <col align="left" valign="top">
461 <tbody>
462 <tr>
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>
465 </tr>
466 <tr>
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>
469 </tr>
470 <tr>
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>
474 </tr>
475 </tbody>
476 </table></div>
477 </div>
478 <hr>
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>
484 <p>
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>.
487 </p>
488 <div class="variablelist"><table border="0">
489 <col align="left" valign="top">
490 <tbody>
491 <tr>
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>
494 </tr>
495 <tr>
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>
498 </tr>
499 <tr>
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>
502 </tr>
503 <tr>
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>
507 </tr>
508 </tbody>
509 </table></div>
510 </div>
511 <hr>
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>
516 <p>
517 Gets the mime part at position <em class="parameter"><code>index</code></em> within the multipart.
518 </p>
519 <div class="variablelist"><table border="0">
520 <col align="left" valign="top">
521 <tbody>
522 <tr>
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>
525 </tr>
526 <tr>
527 <td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td>
528 <td>position of the mime part</td>
529 </tr>
530 <tr>
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>
533 </tr>
534 </tbody>
535 </table></div>
536 </div>
537 <hr>
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>
543 <p>
544 Recursively calls <em class="parameter"><code>callback</code></em> on each of <em class="parameter"><code>multipart</code></em>'s subparts.
545 </p>
546 <div class="variablelist"><table border="0">
547 <col align="left" valign="top">
548 <tbody>
549 <tr>
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>
552 </td>
553 </tr>
554 <tr>
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>
557 </tr>
558 <tr>
559 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
560 <td>user-supplied callback data</td>
561 </tr>
562 </tbody>
563 </table></div>
564 </div>
565 <hr>
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>
571 <p>
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>.
574 </p>
575 <div class="variablelist"><table border="0">
576 <col align="left" valign="top">
577 <tbody>
578 <tr>
579 <td><p><span class="term"><em class="parameter"><code>multipart</code></em> :</span></p></td>
580 <td>a multipart</td>
581 </tr>
582 <tr>
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>
585 </tr>
586 <tr>
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>
590 </tr>
591 </tbody>
592 </table></div>
593 </div>
594 </div>
595 </div>
596 <div class="footer">
597 <hr>
598           Generated by GTK-Doc V1.18</div>
599 </body>
600 </html>