Initialize the gmime for upstream
[platform/upstream/gmime.git] / docs / reference / html / GMimeObject.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>GMimeObject</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="MimeParts.html" title="MIME Messages and Parts">
10 <link rel="next" href="GMimeMessage.html" title="GMimeMessage">
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="MimeParts.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="GMimeMessage.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="#GMimeObject.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#GMimeObject.description" class="shortcut">Description</a>
27                    | 
28                   <a href="#GMimeObject.object-hierarchy" class="shortcut">Object Hierarchy</a>
29 </td></tr>
30 </table>
31 <div class="refentry">
32 <a name="GMimeObject"></a><div class="titlepage"></div>
33 <div class="refnamediv"><table width="100%"><tr>
34 <td valign="top">
35 <h2><span class="refentrytitle"><a name="GMimeObject.top_of_page"></a>GMimeObject</span></h2>
36 <p>GMimeObject — Abstract MIME objects</p>
37 </td>
38 <td valign="top" align="right"></td>
39 </tr></table></div>
40 <div class="refsynopsisdiv">
41 <a name="GMimeObject.synopsis"></a><h2>Synopsis</h2>
42 <pre class="synopsis">struct              <a class="link" href="GMimeObject.html#GMimeObject-struct" title="struct GMimeObject">GMimeObject</a>;
43 <span class="returnvalue">void</span>                (<a class="link" href="GMimeObject.html#GMimeObjectForeachFunc" title="GMimeObjectForeachFunc ()">*GMimeObjectForeachFunc</a>)           (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *parent</code></em>,
44                                                          <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *part</code></em>,
45                                                          <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
46 <span class="returnvalue">void</span>                <a class="link" href="GMimeObject.html#g-mime-object-register-type" title="g_mime_object_register_type ()">g_mime_object_register_type</a>         (<em class="parameter"><code>const <span class="type">char</span> *type</code></em>,
47                                                          <em class="parameter"><code>const <span class="type">char</span> *subtype</code></em>,
48                                                          <em class="parameter"><code><span class="type">GType</span> object_type</code></em>);
49 <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> *       <a class="link" href="GMimeObject.html#g-mime-object-new" title="g_mime_object_new ()">g_mime_object_new</a>                   (<em class="parameter"><code><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> *content_type</code></em>);
50 <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> *       <a class="link" href="GMimeObject.html#g-mime-object-new-type" title="g_mime_object_new_type ()">g_mime_object_new_type</a>              (<em class="parameter"><code>const <span class="type">char</span> *type</code></em>,
51                                                          <em class="parameter"><code>const <span class="type">char</span> *subtype</code></em>);
52 <span class="returnvalue">void</span>                <a class="link" href="GMimeObject.html#g-mime-object-set-content-type" title="g_mime_object_set_content_type ()">g_mime_object_set_content_type</a>      (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>,
53                                                          <em class="parameter"><code><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> *content_type</code></em>);
54 <a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="returnvalue">GMimeContentType</span></a> *  <a class="link" href="GMimeObject.html#g-mime-object-get-content-type" title="g_mime_object_get_content_type ()">g_mime_object_get_content_type</a>      (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>);
55 <span class="returnvalue">void</span>                <a class="link" href="GMimeObject.html#g-mime-object-set-content-type-parameter" title="g_mime_object_set_content_type_parameter ()">g_mime_object_set_content_type_parameter</a>
56                                                         (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>,
57                                                          <em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
58                                                          <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);
59 const <span class="returnvalue">char</span> *        <a class="link" href="GMimeObject.html#g-mime-object-get-content-type-parameter" title="g_mime_object_get_content_type_parameter ()">g_mime_object_get_content_type_parameter</a>
60                                                         (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>,
61                                                          <em class="parameter"><code>const <span class="type">char</span> *name</code></em>);
62 <span class="returnvalue">void</span>                <a class="link" href="GMimeObject.html#g-mime-object-set-disposition" title="g_mime_object_set_disposition ()">g_mime_object_set_disposition</a>       (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>,
63                                                          <em class="parameter"><code>const <span class="type">char</span> *disposition</code></em>);
64 const <span class="returnvalue">char</span> *        <a class="link" href="GMimeObject.html#g-mime-object-get-disposition" title="g_mime_object_get_disposition ()">g_mime_object_get_disposition</a>       (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>);
65 <span class="returnvalue">void</span>                <a class="link" href="GMimeObject.html#g-mime-object-set-content-disposition" title="g_mime_object_set_content_disposition ()">g_mime_object_set_content_disposition</a>
66                                                         (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>,
67                                                          <em class="parameter"><code><a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> *disposition</code></em>);
68 <a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="returnvalue">GMimeContentDisposition</span></a> * <a class="link" href="GMimeObject.html#g-mime-object-get-content-disposition" title="g_mime_object_get_content_disposition ()">g_mime_object_get_content_disposition</a>
69                                                         (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>);
70 <span class="returnvalue">void</span>                <a class="link" href="GMimeObject.html#g-mime-object-set-content-disposition-parameter" title="g_mime_object_set_content_disposition_parameter ()">g_mime_object_set_content_disposition_parameter</a>
71                                                         (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>,
72                                                          <em class="parameter"><code>const <span class="type">char</span> *attribute</code></em>,
73                                                          <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);
74 const <span class="returnvalue">char</span> *        <a class="link" href="GMimeObject.html#g-mime-object-get-content-disposition-parameter" title="g_mime_object_get_content_disposition_parameter ()">g_mime_object_get_content_disposition_parameter</a>
75                                                         (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>,
76                                                          <em class="parameter"><code>const <span class="type">char</span> *attribute</code></em>);
77 <span class="returnvalue">void</span>                <a class="link" href="GMimeObject.html#g-mime-object-set-content-id" title="g_mime_object_set_content_id ()">g_mime_object_set_content_id</a>        (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>,
78                                                          <em class="parameter"><code>const <span class="type">char</span> *content_id</code></em>);
79 const <span class="returnvalue">char</span> *        <a class="link" href="GMimeObject.html#g-mime-object-get-content-id" title="g_mime_object_get_content_id ()">g_mime_object_get_content_id</a>        (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>);
80 <span class="returnvalue">void</span>                <a class="link" href="GMimeObject.html#g-mime-object-prepend-header" title="g_mime_object_prepend_header ()">g_mime_object_prepend_header</a>        (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>,
81                                                          <em class="parameter"><code>const <span class="type">char</span> *header</code></em>,
82                                                          <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);
83 <span class="returnvalue">void</span>                <a class="link" href="GMimeObject.html#g-mime-object-append-header" title="g_mime_object_append_header ()">g_mime_object_append_header</a>         (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>,
84                                                          <em class="parameter"><code>const <span class="type">char</span> *header</code></em>,
85                                                          <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);
86 <span class="returnvalue">gboolean</span>            <a class="link" href="GMimeObject.html#g-mime-object-remove-header" title="g_mime_object_remove_header ()">g_mime_object_remove_header</a>         (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>,
87                                                          <em class="parameter"><code>const <span class="type">char</span> *header</code></em>);
88 <span class="returnvalue">void</span>                <a class="link" href="GMimeObject.html#g-mime-object-set-header" title="g_mime_object_set_header ()">g_mime_object_set_header</a>            (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>,
89                                                          <em class="parameter"><code>const <span class="type">char</span> *header</code></em>,
90                                                          <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);
91 const <span class="returnvalue">char</span> *        <a class="link" href="GMimeObject.html#g-mime-object-get-header" title="g_mime_object_get_header ()">g_mime_object_get_header</a>            (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>,
92                                                          <em class="parameter"><code>const <span class="type">char</span> *header</code></em>);
93 <span class="returnvalue">char</span> *              <a class="link" href="GMimeObject.html#g-mime-object-get-headers" title="g_mime_object_get_headers ()">g_mime_object_get_headers</a>           (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>);
94 <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="returnvalue">GMimeHeaderList</span></a> *   <a class="link" href="GMimeObject.html#g-mime-object-get-header-list" title="g_mime_object_get_header_list ()">g_mime_object_get_header_list</a>       (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>);
95 <span class="returnvalue">ssize_t</span>             <a class="link" href="GMimeObject.html#g-mime-object-write-to-stream" title="g_mime_object_write_to_stream ()">g_mime_object_write_to_stream</a>       (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>,
96                                                          <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>);
97 <span class="returnvalue">char</span> *              <a class="link" href="GMimeObject.html#g-mime-object-to-string" title="g_mime_object_to_string ()">g_mime_object_to_string</a>             (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>);
98 <span class="returnvalue">void</span>                <a class="link" href="GMimeObject.html#g-mime-object-encode" title="g_mime_object_encode ()">g_mime_object_encode</a>                (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>,
99                                                          <em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeEncodingConstraint" title="enum GMimeEncodingConstraint"><span class="type">GMimeEncodingConstraint</span></a> constraint</code></em>);
100 </pre>
101 </div>
102 <div class="refsect1">
103 <a name="GMimeObject.object-hierarchy"></a><h2>Object Hierarchy</h2>
104 <pre class="synopsis">
105   GObject
106    +----GMimeObject
107          +----<a class="link" href="GMimeMessage.html" title="GMimeMessage">GMimeMessage</a>
108          +----<a class="link" href="GMimePart.html" title="GMimePart">GMimePart</a>
109          +----<a class="link" href="GMimeMultipart.html" title="GMimeMultipart">GMimeMultipart</a>
110          +----<a class="link" href="GMimeMessagePart.html" title="GMimeMessagePart">GMimeMessagePart</a>
111 </pre>
112 </div>
113 <div class="refsect1">
114 <a name="GMimeObject.description"></a><h2>Description</h2>
115 <p>
116 <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> is an abstract class from which all message and MIME
117 parts are derived.
118 </p>
119 </div>
120 <div class="refsect1">
121 <a name="GMimeObject.details"></a><h2>Details</h2>
122 <div class="refsect2">
123 <a name="GMimeObject-struct"></a><h3>struct GMimeObject</h3>
124 <pre class="programlisting">struct GMimeObject;</pre>
125 <p>
126 Base class for all MIME parts.
127 </p>
128 <div class="variablelist"><table border="0">
129 <col align="left" valign="top">
130 <tbody></tbody>
131 </table></div>
132 </div>
133 <hr>
134 <div class="refsect2">
135 <a name="GMimeObjectForeachFunc"></a><h3>GMimeObjectForeachFunc ()</h3>
136 <pre class="programlisting"><span class="returnvalue">void</span>                (*GMimeObjectForeachFunc)           (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *parent</code></em>,
137                                                          <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *part</code></em>,
138                                                          <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
139 <p>
140 The function signature for a callback to <a class="link" href="GMimeMessage.html#g-mime-message-foreach" title="g_mime_message_foreach ()"><code class="function">g_mime_message_foreach()</code></a>
141 and <a class="link" href="GMimeMultipart.html#g-mime-multipart-foreach" title="g_mime_multipart_foreach ()"><code class="function">g_mime_multipart_foreach()</code></a>.
142 </p>
143 <div class="variablelist"><table border="0">
144 <col align="left" valign="top">
145 <tbody>
146 <tr>
147 <td><p><span class="term"><em class="parameter"><code>parent</code></em> :</span></p></td>
148 <td>parent <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a>
149 </td>
150 </tr>
151 <tr>
152 <td><p><span class="term"><em class="parameter"><code>part</code></em> :</span></p></td>
153 <td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a>
154 </td>
155 </tr>
156 <tr>
157 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
158 <td>User-supplied callback data.</td>
159 </tr>
160 </tbody>
161 </table></div>
162 </div>
163 <hr>
164 <div class="refsect2">
165 <a name="g-mime-object-register-type"></a><h3>g_mime_object_register_type ()</h3>
166 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_object_register_type         (<em class="parameter"><code>const <span class="type">char</span> *type</code></em>,
167                                                          <em class="parameter"><code>const <span class="type">char</span> *subtype</code></em>,
168                                                          <em class="parameter"><code><span class="type">GType</span> object_type</code></em>);</pre>
169 <p>
170 Registers the object type <em class="parameter"><code>object_type</code></em> for use with the
171 <a class="link" href="GMimeObject.html#g-mime-object-new-type" title="g_mime_object_new_type ()"><code class="function">g_mime_object_new_type()</code></a> convenience function.
172 </p>
173 <p>
174 Note: You may use the wildcard "*" to match any type and/or
175 subtype.
176 </p>
177 <div class="variablelist"><table border="0">
178 <col align="left" valign="top">
179 <tbody>
180 <tr>
181 <td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
182 <td>mime type</td>
183 </tr>
184 <tr>
185 <td><p><span class="term"><em class="parameter"><code>subtype</code></em> :</span></p></td>
186 <td>mime subtype</td>
187 </tr>
188 <tr>
189 <td><p><span class="term"><em class="parameter"><code>object_type</code></em> :</span></p></td>
190 <td>object type</td>
191 </tr>
192 </tbody>
193 </table></div>
194 </div>
195 <hr>
196 <div class="refsect2">
197 <a name="g-mime-object-new"></a><h3>g_mime_object_new ()</h3>
198 <pre class="programlisting"><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> *       g_mime_object_new                   (<em class="parameter"><code><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> *content_type</code></em>);</pre>
199 <p>
200 Performs a lookup of registered <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> subclasses, registered
201 using <a class="link" href="GMimeObject.html#g-mime-object-register-type" title="g_mime_object_register_type ()"><code class="function">g_mime_object_register_type()</code></a>, to find an appropriate class
202 capable of handling MIME parts of the specified Content-Type. If no
203 class has been registered to handle that type, it looks for a
204 registered class that can handle <em class="parameter"><code>content_type</code></em>'s media type. If
205 that also fails, then it will use the generic part class,
206 <a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a>.
207 </p>
208 <div class="variablelist"><table border="0">
209 <col align="left" valign="top">
210 <tbody>
211 <tr>
212 <td><p><span class="term"><em class="parameter"><code>content_type</code></em> :</span></p></td>
213 <td>a <a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> object</td>
214 </tr>
215 <tr>
216 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
217 <td>an appropriate <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> registered to handle MIME
218 parts appropriate for <em class="parameter"><code>content_type</code></em>.</td>
219 </tr>
220 </tbody>
221 </table></div>
222 </div>
223 <hr>
224 <div class="refsect2">
225 <a name="g-mime-object-new-type"></a><h3>g_mime_object_new_type ()</h3>
226 <pre class="programlisting"><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> *       g_mime_object_new_type              (<em class="parameter"><code>const <span class="type">char</span> *type</code></em>,
227                                                          <em class="parameter"><code>const <span class="type">char</span> *subtype</code></em>);</pre>
228 <p>
229 Performs a lookup of registered <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> subclasses, registered
230 using <a class="link" href="GMimeObject.html#g-mime-object-register-type" title="g_mime_object_register_type ()"><code class="function">g_mime_object_register_type()</code></a>, to find an appropriate class
231 capable of handling MIME parts of type <em class="parameter"><code>type</code></em>/<em class="parameter"><code>subtype</code></em>. If no class
232 has been registered to handle that type, it looks for a registered
233 class that can handle <em class="parameter"><code>type</code></em>. If that also fails, then it will use
234 the generic part class, <a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a>.
235 </p>
236 <div class="variablelist"><table border="0">
237 <col align="left" valign="top">
238 <tbody>
239 <tr>
240 <td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
241 <td>mime type</td>
242 </tr>
243 <tr>
244 <td><p><span class="term"><em class="parameter"><code>subtype</code></em> :</span></p></td>
245 <td>mime subtype</td>
246 </tr>
247 <tr>
248 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
249 <td>an appropriate <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> registered to handle mime-types
250 of <em class="parameter"><code>type</code></em>/<em class="parameter"><code>subtype</code></em>.</td>
251 </tr>
252 </tbody>
253 </table></div>
254 </div>
255 <hr>
256 <div class="refsect2">
257 <a name="g-mime-object-set-content-type"></a><h3>g_mime_object_set_content_type ()</h3>
258 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_object_set_content_type      (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>,
259                                                          <em class="parameter"><code><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> *content_type</code></em>);</pre>
260 <p>
261 Sets the content-type for the specified MIME object and then
262 serializes it to the Content-Type header field.
263 </p>
264 <div class="variablelist"><table border="0">
265 <col align="left" valign="top">
266 <tbody>
267 <tr>
268 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
269 <td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a>
270 </td>
271 </tr>
272 <tr>
273 <td><p><span class="term"><em class="parameter"><code>content_type</code></em> :</span></p></td>
274 <td>a <a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> object</td>
275 </tr>
276 </tbody>
277 </table></div>
278 </div>
279 <hr>
280 <div class="refsect2">
281 <a name="g-mime-object-get-content-type"></a><h3>g_mime_object_get_content_type ()</h3>
282 <pre class="programlisting"><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="returnvalue">GMimeContentType</span></a> *  g_mime_object_get_content_type      (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>);</pre>
283 <p>
284 Gets the <a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> object for the given MIME object or
285 <code class="literal">NULL</code> on fail.
286 </p>
287 <div class="variablelist"><table border="0">
288 <col align="left" valign="top">
289 <tbody>
290 <tr>
291 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
292 <td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a>
293 </td>
294 </tr>
295 <tr>
296 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
297 <td>the content-type object for the specified MIME object.</td>
298 </tr>
299 </tbody>
300 </table></div>
301 </div>
302 <hr>
303 <div class="refsect2">
304 <a name="g-mime-object-set-content-type-parameter"></a><h3>g_mime_object_set_content_type_parameter ()</h3>
305 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_object_set_content_type_parameter
306                                                         (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>,
307                                                          <em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
308                                                          <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);</pre>
309 <p>
310 Sets the content-type param <em class="parameter"><code>name</code></em> to the value <em class="parameter"><code>value</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>object</code></em> :</span></p></td>
317 <td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a>
318 </td>
319 </tr>
320 <tr>
321 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
322 <td>param name</td>
323 </tr>
324 <tr>
325 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
326 <td>param value</td>
327 </tr>
328 </tbody>
329 </table></div>
330 </div>
331 <hr>
332 <div class="refsect2">
333 <a name="g-mime-object-get-content-type-parameter"></a><h3>g_mime_object_get_content_type_parameter ()</h3>
334 <pre class="programlisting">const <span class="returnvalue">char</span> *        g_mime_object_get_content_type_parameter
335                                                         (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>,
336                                                          <em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre>
337 <p>
338 Gets the value of the content-type param <em class="parameter"><code>name</code></em> set on the MIME part
339 <em class="parameter"><code>object</code></em>.
340 </p>
341 <div class="variablelist"><table border="0">
342 <col align="left" valign="top">
343 <tbody>
344 <tr>
345 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
346 <td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a>
347 </td>
348 </tr>
349 <tr>
350 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
351 <td>param name</td>
352 </tr>
353 <tr>
354 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
355 <td>the value of the requested content-type param or <code class="literal">NULL</code> on
356 if the param doesn't exist.</td>
357 </tr>
358 </tbody>
359 </table></div>
360 </div>
361 <hr>
362 <div class="refsect2">
363 <a name="g-mime-object-set-disposition"></a><h3>g_mime_object_set_disposition ()</h3>
364 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_object_set_disposition       (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>,
365                                                          <em class="parameter"><code>const <span class="type">char</span> *disposition</code></em>);</pre>
366 <p>
367 Sets the disposition to <em class="parameter"><code>disposition</code></em> which may be one of
368 <a class="link" href="GMimeContentDisposition.html#GMIME-DISPOSITION-ATTACHMENT:CAPS" title="GMIME_DISPOSITION_ATTACHMENT"><span class="type">GMIME_DISPOSITION_ATTACHMENT</span></a> or <a class="link" href="GMimeContentDisposition.html#GMIME-DISPOSITION-INLINE:CAPS" title="GMIME_DISPOSITION_INLINE"><span class="type">GMIME_DISPOSITION_INLINE</span></a> or, by
369 your choice, any other string which would indicate how the MIME
370 part should be displayed by the MUA.
371 </p>
372 <div class="variablelist"><table border="0">
373 <col align="left" valign="top">
374 <tbody>
375 <tr>
376 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
377 <td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a>
378 </td>
379 </tr>
380 <tr>
381 <td><p><span class="term"><em class="parameter"><code>disposition</code></em> :</span></p></td>
382 <td>disposition ("attachment" or "inline")</td>
383 </tr>
384 </tbody>
385 </table></div>
386 </div>
387 <hr>
388 <div class="refsect2">
389 <a name="g-mime-object-get-disposition"></a><h3>g_mime_object_get_disposition ()</h3>
390 <pre class="programlisting">const <span class="returnvalue">char</span> *        g_mime_object_get_disposition       (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>);</pre>
391 <p>
392 Gets the MIME object's disposition if set or <code class="literal">NULL</code> otherwise.
393 </p>
394 <div class="variablelist"><table border="0">
395 <col align="left" valign="top">
396 <tbody>
397 <tr>
398 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
399 <td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a>
400 </td>
401 </tr>
402 <tr>
403 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
404 <td>the disposition string which is probably one of
405 <a class="link" href="GMimeContentDisposition.html#GMIME-DISPOSITION-ATTACHMENT:CAPS" title="GMIME_DISPOSITION_ATTACHMENT"><span class="type">GMIME_DISPOSITION_ATTACHMENT</span></a> or <a class="link" href="GMimeContentDisposition.html#GMIME-DISPOSITION-INLINE:CAPS" title="GMIME_DISPOSITION_INLINE"><span class="type">GMIME_DISPOSITION_INLINE</span></a>.</td>
406 </tr>
407 </tbody>
408 </table></div>
409 </div>
410 <hr>
411 <div class="refsect2">
412 <a name="g-mime-object-set-content-disposition"></a><h3>g_mime_object_set_content_disposition ()</h3>
413 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_object_set_content_disposition
414                                                         (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>,
415                                                          <em class="parameter"><code><a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> *disposition</code></em>);</pre>
416 <p>
417 Set the content disposition for the specified mime part and then
418 serializes it to the Content-Disposition header field.
419 </p>
420 <div class="variablelist"><table border="0">
421 <col align="left" valign="top">
422 <tbody>
423 <tr>
424 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
425 <td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a>
426 </td>
427 </tr>
428 <tr>
429 <td><p><span class="term"><em class="parameter"><code>disposition</code></em> :</span></p></td>
430 <td>a <a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> object</td>
431 </tr>
432 </tbody>
433 </table></div>
434 </div>
435 <hr>
436 <div class="refsect2">
437 <a name="g-mime-object-get-content-disposition"></a><h3>g_mime_object_get_content_disposition ()</h3>
438 <pre class="programlisting"><a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="returnvalue">GMimeContentDisposition</span></a> * g_mime_object_get_content_disposition
439                                                         (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>);</pre>
440 <p>
441 Gets the <a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> for the specified MIME object.
442 </p>
443 <div class="variablelist"><table border="0">
444 <col align="left" valign="top">
445 <tbody>
446 <tr>
447 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
448 <td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a>
449 </td>
450 </tr>
451 <tr>
452 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
453 <td>the <a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> set on the MIME object.</td>
454 </tr>
455 </tbody>
456 </table></div>
457 </div>
458 <hr>
459 <div class="refsect2">
460 <a name="g-mime-object-set-content-disposition-parameter"></a><h3>g_mime_object_set_content_disposition_parameter ()</h3>
461 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_object_set_content_disposition_parameter
462                                                         (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>,
463                                                          <em class="parameter"><code>const <span class="type">char</span> *attribute</code></em>,
464                                                          <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);</pre>
465 <p>
466 Add a content-disposition parameter to the specified mime part.
467 </p>
468 <div class="variablelist"><table border="0">
469 <col align="left" valign="top">
470 <tbody>
471 <tr>
472 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
473 <td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a>
474 </td>
475 </tr>
476 <tr>
477 <td><p><span class="term"><em class="parameter"><code>attribute</code></em> :</span></p></td>
478 <td>parameter name</td>
479 </tr>
480 <tr>
481 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
482 <td>parameter value</td>
483 </tr>
484 </tbody>
485 </table></div>
486 </div>
487 <hr>
488 <div class="refsect2">
489 <a name="g-mime-object-get-content-disposition-parameter"></a><h3>g_mime_object_get_content_disposition_parameter ()</h3>
490 <pre class="programlisting">const <span class="returnvalue">char</span> *        g_mime_object_get_content_disposition_parameter
491                                                         (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>,
492                                                          <em class="parameter"><code>const <span class="type">char</span> *attribute</code></em>);</pre>
493 <p>
494 Gets the value of the Content-Disposition parameter specified by
495 <em class="parameter"><code>attribute</code></em>, or <code class="literal">NULL</code> if the parameter does not exist.
496 </p>
497 <div class="variablelist"><table border="0">
498 <col align="left" valign="top">
499 <tbody>
500 <tr>
501 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
502 <td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a>
503 </td>
504 </tr>
505 <tr>
506 <td><p><span class="term"><em class="parameter"><code>attribute</code></em> :</span></p></td>
507 <td>parameter name</td>
508 </tr>
509 <tr>
510 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
511 <td>the value of a previously defined content-disposition
512 parameter specified by <em class="parameter"><code>attribute</code></em>.</td>
513 </tr>
514 </tbody>
515 </table></div>
516 </div>
517 <hr>
518 <div class="refsect2">
519 <a name="g-mime-object-set-content-id"></a><h3>g_mime_object_set_content_id ()</h3>
520 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_object_set_content_id        (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>,
521                                                          <em class="parameter"><code>const <span class="type">char</span> *content_id</code></em>);</pre>
522 <p>
523 Sets the Content-Id of the MIME object.
524 </p>
525 <div class="variablelist"><table border="0">
526 <col align="left" valign="top">
527 <tbody>
528 <tr>
529 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
530 <td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a>
531 </td>
532 </tr>
533 <tr>
534 <td><p><span class="term"><em class="parameter"><code>content_id</code></em> :</span></p></td>
535 <td>content-id (addr-spec portion)</td>
536 </tr>
537 </tbody>
538 </table></div>
539 </div>
540 <hr>
541 <div class="refsect2">
542 <a name="g-mime-object-get-content-id"></a><h3>g_mime_object_get_content_id ()</h3>
543 <pre class="programlisting">const <span class="returnvalue">char</span> *        g_mime_object_get_content_id        (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>);</pre>
544 <p>
545 Gets the Content-Id of the MIME object or NULL if one is not set.
546 </p>
547 <div class="variablelist"><table border="0">
548 <col align="left" valign="top">
549 <tbody>
550 <tr>
551 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
552 <td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a>
553 </td>
554 </tr>
555 <tr>
556 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
557 <td>a const pointer to the Content-Id header.</td>
558 </tr>
559 </tbody>
560 </table></div>
561 </div>
562 <hr>
563 <div class="refsect2">
564 <a name="g-mime-object-prepend-header"></a><h3>g_mime_object_prepend_header ()</h3>
565 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_object_prepend_header        (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>,
566                                                          <em class="parameter"><code>const <span class="type">char</span> *header</code></em>,
567                                                          <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);</pre>
568 <p>
569 Prepends a raw, unprocessed header to the MIME object.
570 </p>
571 <div class="variablelist"><table border="0">
572 <col align="left" valign="top">
573 <tbody>
574 <tr>
575 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
576 <td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a>
577 </td>
578 </tr>
579 <tr>
580 <td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td>
581 <td>header name</td>
582 </tr>
583 <tr>
584 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
585 <td>header value</td>
586 </tr>
587 </tbody>
588 </table></div>
589 </div>
590 <hr>
591 <div class="refsect2">
592 <a name="g-mime-object-append-header"></a><h3>g_mime_object_append_header ()</h3>
593 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_object_append_header         (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>,
594                                                          <em class="parameter"><code>const <span class="type">char</span> *header</code></em>,
595                                                          <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);</pre>
596 <p>
597 Appends a raw, unprocessed header to the MIME object.
598 </p>
599 <div class="variablelist"><table border="0">
600 <col align="left" valign="top">
601 <tbody>
602 <tr>
603 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
604 <td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a>
605 </td>
606 </tr>
607 <tr>
608 <td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td>
609 <td>header name</td>
610 </tr>
611 <tr>
612 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
613 <td>header value</td>
614 </tr>
615 </tbody>
616 </table></div>
617 </div>
618 <hr>
619 <div class="refsect2">
620 <a name="g-mime-object-remove-header"></a><h3>g_mime_object_remove_header ()</h3>
621 <pre class="programlisting"><span class="returnvalue">gboolean</span>            g_mime_object_remove_header         (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>,
622                                                          <em class="parameter"><code>const <span class="type">char</span> *header</code></em>);</pre>
623 <p>
624 Removed the specified header if it exists.
625 </p>
626 <div class="variablelist"><table border="0">
627 <col align="left" valign="top">
628 <tbody>
629 <tr>
630 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
631 <td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a>
632 </td>
633 </tr>
634 <tr>
635 <td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td>
636 <td>header name</td>
637 </tr>
638 <tr>
639 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
640 <td>
641 <code class="literal">TRUE</code> if the header was removed or <code class="literal">FALSE</code> if it could not
642 be found.</td>
643 </tr>
644 </tbody>
645 </table></div>
646 </div>
647 <hr>
648 <div class="refsect2">
649 <a name="g-mime-object-set-header"></a><h3>g_mime_object_set_header ()</h3>
650 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_object_set_header            (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>,
651                                                          <em class="parameter"><code>const <span class="type">char</span> *header</code></em>,
652                                                          <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);</pre>
653 <p>
654 Sets an arbitrary raw, unprocessed header on the MIME object.
655 </p>
656 <div class="variablelist"><table border="0">
657 <col align="left" valign="top">
658 <tbody>
659 <tr>
660 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
661 <td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a>
662 </td>
663 </tr>
664 <tr>
665 <td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td>
666 <td>header name</td>
667 </tr>
668 <tr>
669 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
670 <td>header value</td>
671 </tr>
672 </tbody>
673 </table></div>
674 </div>
675 <hr>
676 <div class="refsect2">
677 <a name="g-mime-object-get-header"></a><h3>g_mime_object_get_header ()</h3>
678 <pre class="programlisting">const <span class="returnvalue">char</span> *        g_mime_object_get_header            (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>,
679                                                          <em class="parameter"><code>const <span class="type">char</span> *header</code></em>);</pre>
680 <p>
681 Gets the raw, unprocessed value of the requested header.
682 </p>
683 <div class="variablelist"><table border="0">
684 <col align="left" valign="top">
685 <tbody>
686 <tr>
687 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
688 <td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a>
689 </td>
690 </tr>
691 <tr>
692 <td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td>
693 <td>header name</td>
694 </tr>
695 <tr>
696 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
697 <td>the raw, unprocessed value of the requested header if it
698 exists or <code class="literal">NULL</code> otherwise.</td>
699 </tr>
700 </tbody>
701 </table></div>
702 </div>
703 <hr>
704 <div class="refsect2">
705 <a name="g-mime-object-get-headers"></a><h3>g_mime_object_get_headers ()</h3>
706 <pre class="programlisting"><span class="returnvalue">char</span> *              g_mime_object_get_headers           (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>);</pre>
707 <p>
708 Allocates a string buffer containing all of the MIME object's raw
709 headers.
710 </p>
711 <div class="variablelist"><table border="0">
712 <col align="left" valign="top">
713 <tbody>
714 <tr>
715 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
716 <td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a>
717 </td>
718 </tr>
719 <tr>
720 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
721 <td>an allocated string containing all of the raw MIME headers.</td>
722 </tr>
723 </tbody>
724 </table></div>
725 </div>
726 <hr>
727 <div class="refsect2">
728 <a name="g-mime-object-get-header-list"></a><h3>g_mime_object_get_header_list ()</h3>
729 <pre class="programlisting"><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="returnvalue">GMimeHeaderList</span></a> *   g_mime_object_get_header_list       (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>);</pre>
730 <p>
731 Get the header list for <em class="parameter"><code>object</code></em>.
732 </p>
733 <div class="variablelist"><table border="0">
734 <col align="left" valign="top">
735 <tbody>
736 <tr>
737 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
738 <td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a>
739 </td>
740 </tr>
741 <tr>
742 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
743 <td>the <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> for <em class="parameter"><code>object</code></em>. Do not free this pointer
744 when you are done with it.</td>
745 </tr>
746 </tbody>
747 </table></div>
748 </div>
749 <hr>
750 <div class="refsect2">
751 <a name="g-mime-object-write-to-stream"></a><h3>g_mime_object_write_to_stream ()</h3>
752 <pre class="programlisting"><span class="returnvalue">ssize_t</span>             g_mime_object_write_to_stream       (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>,
753                                                          <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>);</pre>
754 <p>
755 Write the contents of the MIME object to <em class="parameter"><code>stream</code></em>.
756 </p>
757 <div class="variablelist"><table border="0">
758 <col align="left" valign="top">
759 <tbody>
760 <tr>
761 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
762 <td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a>
763 </td>
764 </tr>
765 <tr>
766 <td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
767 <td>stream</td>
768 </tr>
769 <tr>
770 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
771 <td>the number of bytes written or <code class="literal">-1</code> on fail.</td>
772 </tr>
773 </tbody>
774 </table></div>
775 </div>
776 <hr>
777 <div class="refsect2">
778 <a name="g-mime-object-to-string"></a><h3>g_mime_object_to_string ()</h3>
779 <pre class="programlisting"><span class="returnvalue">char</span> *              g_mime_object_to_string             (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>);</pre>
780 <p>
781 Allocates a string buffer containing the contents of <em class="parameter"><code>object</code></em>.
782 </p>
783 <div class="variablelist"><table border="0">
784 <col align="left" valign="top">
785 <tbody>
786 <tr>
787 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
788 <td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a>
789 </td>
790 </tr>
791 <tr>
792 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
793 <td>an allocated string containing the contents of the mime
794 object.</td>
795 </tr>
796 </tbody>
797 </table></div>
798 </div>
799 <hr>
800 <div class="refsect2">
801 <a name="g-mime-object-encode"></a><h3>g_mime_object_encode ()</h3>
802 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_object_encode                (<em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *object</code></em>,
803                                                          <em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeEncodingConstraint" title="enum GMimeEncodingConstraint"><span class="type">GMimeEncodingConstraint</span></a> constraint</code></em>);</pre>
804 <p>
805 Calculates and sets the most efficient Content-Transfer-Encoding
806 for this <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> and all child parts based on the <em class="parameter"><code>constraint</code></em>
807 provided.
808 </p>
809 <div class="variablelist"><table border="0">
810 <col align="left" valign="top">
811 <tbody>
812 <tr>
813 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
814 <td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a>
815 </td>
816 </tr>
817 <tr>
818 <td><p><span class="term"><em class="parameter"><code>constraint</code></em> :</span></p></td>
819 <td>a <a class="link" href="gmime-gmime-encodings.html#GMimeEncodingConstraint" title="enum GMimeEncodingConstraint"><span class="type">GMimeEncodingConstraint</span></a>
820 </td>
821 </tr>
822 </tbody>
823 </table></div>
824 </div>
825 </div>
826 </div>
827 <div class="footer">
828 <hr>
829           Generated by GTK-Doc V1.18</div>
830 </body>
831 </html>