1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>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">
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17 <td><a accesskey="p" href="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>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#GMimeObject.synopsis" class="shortcut">Top</a>
26 <a href="#GMimeObject.description" class="shortcut">Description</a>
28 <a href="#GMimeObject.object-hierarchy" class="shortcut">Object Hierarchy</a>
31 <div class="refentry">
32 <a name="GMimeObject"></a><div class="titlepage"></div>
33 <div class="refnamediv"><table width="100%"><tr>
35 <h2><span class="refentrytitle"><a name="GMimeObject.top_of_page"></a>GMimeObject</span></h2>
36 <p>GMimeObject — Abstract MIME objects</p>
38 <td valign="top" align="right"></td>
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>);
102 <div class="refsect1">
103 <a name="GMimeObject.object-hierarchy"></a><h2>Object Hierarchy</h2>
104 <pre class="synopsis">
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>
113 <div class="refsect1">
114 <a name="GMimeObject.description"></a><h2>Description</h2>
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
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>
126 Base class for all MIME parts.
128 <div class="variablelist"><table border="0">
129 <col align="left" valign="top">
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>
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>.
143 <div class="variablelist"><table border="0">
144 <col align="left" valign="top">
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>
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>
157 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
158 <td>User-supplied callback data.</td>
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>
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.
174 Note: You may use the wildcard "*" to match any type and/or
177 <div class="variablelist"><table border="0">
178 <col align="left" valign="top">
181 <td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
185 <td><p><span class="term"><em class="parameter"><code>subtype</code></em> :</span></p></td>
186 <td>mime subtype</td>
189 <td><p><span class="term"><em class="parameter"><code>object_type</code></em> :</span></p></td>
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>
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>.
208 <div class="variablelist"><table border="0">
209 <col align="left" valign="top">
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>
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>
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>
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>.
236 <div class="variablelist"><table border="0">
237 <col align="left" valign="top">
240 <td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
244 <td><p><span class="term"><em class="parameter"><code>subtype</code></em> :</span></p></td>
245 <td>mime subtype</td>
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>
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>
261 Sets the content-type for the specified MIME object and then
262 serializes it to the Content-Type header field.
264 <div class="variablelist"><table border="0">
265 <col align="left" valign="top">
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>
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>
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>
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.
287 <div class="variablelist"><table border="0">
288 <col align="left" valign="top">
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>
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>
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>
310 Sets the content-type param <em class="parameter"><code>name</code></em> to the value <em class="parameter"><code>value</code></em>.
312 <div class="variablelist"><table border="0">
313 <col align="left" valign="top">
316 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
317 <td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a>
321 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
325 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
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>
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>.
341 <div class="variablelist"><table border="0">
342 <col align="left" valign="top">
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>
350 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
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>
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>
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.
372 <div class="variablelist"><table border="0">
373 <col align="left" valign="top">
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>
381 <td><p><span class="term"><em class="parameter"><code>disposition</code></em> :</span></p></td>
382 <td>disposition ("attachment" or "inline")</td>
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>
392 Gets the MIME object's disposition if set or <code class="literal">NULL</code> otherwise.
394 <div class="variablelist"><table border="0">
395 <col align="left" valign="top">
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>
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>
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>
417 Set the content disposition for the specified mime part and then
418 serializes it to the Content-Disposition header field.
420 <div class="variablelist"><table border="0">
421 <col align="left" valign="top">
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>
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>
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>
441 Gets the <a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> for the specified MIME object.
443 <div class="variablelist"><table border="0">
444 <col align="left" valign="top">
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>
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>
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>
466 Add a content-disposition parameter to the specified mime part.
468 <div class="variablelist"><table border="0">
469 <col align="left" valign="top">
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>
477 <td><p><span class="term"><em class="parameter"><code>attribute</code></em> :</span></p></td>
478 <td>parameter name</td>
481 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
482 <td>parameter value</td>
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>
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.
497 <div class="variablelist"><table border="0">
498 <col align="left" valign="top">
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>
506 <td><p><span class="term"><em class="parameter"><code>attribute</code></em> :</span></p></td>
507 <td>parameter name</td>
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>
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>
523 Sets the Content-Id of the MIME object.
525 <div class="variablelist"><table border="0">
526 <col align="left" valign="top">
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>
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>
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>
545 Gets the Content-Id of the MIME object or NULL if one is not set.
547 <div class="variablelist"><table border="0">
548 <col align="left" valign="top">
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>
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>
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>
569 Prepends a raw, unprocessed header to the MIME object.
571 <div class="variablelist"><table border="0">
572 <col align="left" valign="top">
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>
580 <td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td>
584 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
585 <td>header value</td>
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>
597 Appends a raw, unprocessed header to the MIME object.
599 <div class="variablelist"><table border="0">
600 <col align="left" valign="top">
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>
608 <td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td>
612 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
613 <td>header value</td>
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>
624 Removed the specified header if it exists.
626 <div class="variablelist"><table border="0">
627 <col align="left" valign="top">
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>
635 <td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td>
639 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
641 <code class="literal">TRUE</code> if the header was removed or <code class="literal">FALSE</code> if it could not
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>
654 Sets an arbitrary raw, unprocessed header on the MIME object.
656 <div class="variablelist"><table border="0">
657 <col align="left" valign="top">
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>
665 <td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td>
669 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
670 <td>header value</td>
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>
681 Gets the raw, unprocessed value of the requested header.
683 <div class="variablelist"><table border="0">
684 <col align="left" valign="top">
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>
692 <td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td>
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>
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>
708 Allocates a string buffer containing all of the MIME object's raw
711 <div class="variablelist"><table border="0">
712 <col align="left" valign="top">
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>
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>
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>
731 Get the header list for <em class="parameter"><code>object</code></em>.
733 <div class="variablelist"><table border="0">
734 <col align="left" valign="top">
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>
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>
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>
755 Write the contents of the MIME object to <em class="parameter"><code>stream</code></em>.
757 <div class="variablelist"><table border="0">
758 <col align="left" valign="top">
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>
766 <td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
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>
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>
781 Allocates a string buffer containing the contents of <em class="parameter"><code>object</code></em>.
783 <div class="variablelist"><table border="0">
784 <col align="left" valign="top">
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>
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
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>
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>
809 <div class="variablelist"><table border="0">
810 <col align="left" valign="top">
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>
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>
829 Generated by GTK-Doc V1.18</div>