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>GMimeContentType</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="Headers.html" title="Message and MIME Headers">
9 <link rel="prev" href="gmime-GMimeHeader.html" title="GMimeHeader">
10 <link rel="next" href="GMimeContentDisposition.html" title="GMimeContentDisposition">
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="gmime-GMimeHeader.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="Headers.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="GMimeContentDisposition.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="#GMimeContentType.synopsis" class="shortcut">Top</a>
26 <a href="#GMimeContentType.description" class="shortcut">Description</a>
28 <a href="#GMimeContentType.object-hierarchy" class="shortcut">Object Hierarchy</a>
31 <div class="refentry">
32 <a name="GMimeContentType"></a><div class="titlepage"></div>
33 <div class="refnamediv"><table width="100%"><tr>
35 <h2><span class="refentrytitle"><a name="GMimeContentType.top_of_page"></a>GMimeContentType</span></h2>
36 <p>GMimeContentType — Content-Type fields</p>
38 <td valign="top" align="right"></td>
40 <div class="refsynopsisdiv">
41 <a name="GMimeContentType.synopsis"></a><h2>Synopsis</h2>
42 <pre class="synopsis">struct <a class="link" href="GMimeContentType.html#GMimeContentType-struct" title="struct GMimeContentType">GMimeContentType</a>;
43 <a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="returnvalue">GMimeContentType</span></a> * <a class="link" href="GMimeContentType.html#g-mime-content-type-new" title="g_mime_content_type_new ()">g_mime_content_type_new</a> (<em class="parameter"><code>const <span class="type">char</span> *type</code></em>,
44 <em class="parameter"><code>const <span class="type">char</span> *subtype</code></em>);
45 <a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="returnvalue">GMimeContentType</span></a> * <a class="link" href="GMimeContentType.html#g-mime-content-type-new-from-string" title="g_mime_content_type_new_from_string ()">g_mime_content_type_new_from_string</a> (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>);
46 <span class="returnvalue">char</span> * <a class="link" href="GMimeContentType.html#g-mime-content-type-to-string" title="g_mime_content_type_to_string ()">g_mime_content_type_to_string</a> (<em class="parameter"><code><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> *mime_type</code></em>);
47 <span class="returnvalue">gboolean</span> <a class="link" href="GMimeContentType.html#g-mime-content-type-is-type" title="g_mime_content_type_is_type ()">g_mime_content_type_is_type</a> (<em class="parameter"><code><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> *mime_type</code></em>,
48 <em class="parameter"><code>const <span class="type">char</span> *type</code></em>,
49 <em class="parameter"><code>const <span class="type">char</span> *subtype</code></em>);
50 const <span class="returnvalue">char</span> * <a class="link" href="GMimeContentType.html#g-mime-content-type-get-media-type" title="g_mime_content_type_get_media_type ()">g_mime_content_type_get_media_type</a> (<em class="parameter"><code><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> *mime_type</code></em>);
51 <span class="returnvalue">void</span> <a class="link" href="GMimeContentType.html#g-mime-content-type-set-media-type" title="g_mime_content_type_set_media_type ()">g_mime_content_type_set_media_type</a> (<em class="parameter"><code><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> *mime_type</code></em>,
52 <em class="parameter"><code>const <span class="type">char</span> *type</code></em>);
53 const <span class="returnvalue">char</span> * <a class="link" href="GMimeContentType.html#g-mime-content-type-get-media-subtype" title="g_mime_content_type_get_media_subtype ()">g_mime_content_type_get_media_subtype</a>
54 (<em class="parameter"><code><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> *mime_type</code></em>);
55 <span class="returnvalue">void</span> <a class="link" href="GMimeContentType.html#g-mime-content-type-set-media-subtype" title="g_mime_content_type_set_media_subtype ()">g_mime_content_type_set_media_subtype</a>
56 (<em class="parameter"><code><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> *mime_type</code></em>,
57 <em class="parameter"><code>const <span class="type">char</span> *subtype</code></em>);
58 const <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="returnvalue">GMimeParam</span></a> * <a class="link" href="GMimeContentType.html#g-mime-content-type-get-params" title="g_mime_content_type_get_params ()">g_mime_content_type_get_params</a> (<em class="parameter"><code><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> *mime_type</code></em>);
59 <span class="returnvalue">void</span> <a class="link" href="GMimeContentType.html#g-mime-content-type-set-params" title="g_mime_content_type_set_params ()">g_mime_content_type_set_params</a> (<em class="parameter"><code><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> *mime_type</code></em>,
60 <em class="parameter"><code><a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *params</code></em>);
61 const <span class="returnvalue">char</span> * <a class="link" href="GMimeContentType.html#g-mime-content-type-get-parameter" title="g_mime_content_type_get_parameter ()">g_mime_content_type_get_parameter</a> (<em class="parameter"><code><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> *mime_type</code></em>,
62 <em class="parameter"><code>const <span class="type">char</span> *attribute</code></em>);
63 <span class="returnvalue">void</span> <a class="link" href="GMimeContentType.html#g-mime-content-type-set-parameter" title="g_mime_content_type_set_parameter ()">g_mime_content_type_set_parameter</a> (<em class="parameter"><code><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> *mime_type</code></em>,
64 <em class="parameter"><code>const <span class="type">char</span> *attribute</code></em>,
65 <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);
68 <div class="refsect1">
69 <a name="GMimeContentType.object-hierarchy"></a><h2>Object Hierarchy</h2>
70 <pre class="synopsis">
75 <div class="refsect1">
76 <a name="GMimeContentType.description"></a><h2>Description</h2>
78 A <a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> represents the pre-parsed contents of a
79 Content-Type header field.
82 <div class="refsect1">
83 <a name="GMimeContentType.details"></a><h2>Details</h2>
84 <div class="refsect2">
85 <a name="GMimeContentType-struct"></a><h3>struct GMimeContentType</h3>
86 <pre class="programlisting">struct GMimeContentType;</pre>
88 A data structure representing a Content-Type.
90 <div class="variablelist"><table border="0">
91 <col align="left" valign="top">
96 <div class="refsect2">
97 <a name="g-mime-content-type-new"></a><h3>g_mime_content_type_new ()</h3>
98 <pre class="programlisting"><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="returnvalue">GMimeContentType</span></a> * g_mime_content_type_new (<em class="parameter"><code>const <span class="type">char</span> *type</code></em>,
99 <em class="parameter"><code>const <span class="type">char</span> *subtype</code></em>);</pre>
101 Creates a Content-Type object with type <em class="parameter"><code>type</code></em> and subtype <em class="parameter"><code>subtype</code></em>.
103 <div class="variablelist"><table border="0">
104 <col align="left" valign="top">
107 <td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
108 <td>MIME type (or <code class="literal">NULL</code> for "text")</td>
111 <td><p><span class="term"><em class="parameter"><code>subtype</code></em> :</span></p></td>
112 <td>MIME subtype (or <code class="literal">NULL</code> for "plain")</td>
115 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
116 <td>a new <a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> object.</td>
122 <div class="refsect2">
123 <a name="g-mime-content-type-new-from-string"></a><h3>g_mime_content_type_new_from_string ()</h3>
124 <pre class="programlisting"><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="returnvalue">GMimeContentType</span></a> * g_mime_content_type_new_from_string (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>);</pre>
126 Constructs a new Content-Type object based on the input string.
128 <div class="variablelist"><table border="0">
129 <col align="left" valign="top">
132 <td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
133 <td>input string containing a content-type (and params)</td>
136 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
137 <td>a new <a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> object based on the input string.</td>
143 <div class="refsect2">
144 <a name="g-mime-content-type-to-string"></a><h3>g_mime_content_type_to_string ()</h3>
145 <pre class="programlisting"><span class="returnvalue">char</span> * g_mime_content_type_to_string (<em class="parameter"><code><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> *mime_type</code></em>);</pre>
147 Allocates a string buffer containing the type and subtype defined
148 by the <em class="parameter"><code>mime_type</code></em>.
150 <div class="variablelist"><table border="0">
151 <col align="left" valign="top">
154 <td><p><span class="term"><em class="parameter"><code>mime_type</code></em> :</span></p></td>
155 <td>a <a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> object</td>
158 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
159 <td>an allocated string containing the type and subtype of the
160 content-type in the format: type/subtype.</td>
166 <div class="refsect2">
167 <a name="g-mime-content-type-is-type"></a><h3>g_mime_content_type_is_type ()</h3>
168 <pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_content_type_is_type (<em class="parameter"><code><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> *mime_type</code></em>,
169 <em class="parameter"><code>const <span class="type">char</span> *type</code></em>,
170 <em class="parameter"><code>const <span class="type">char</span> *subtype</code></em>);</pre>
172 Compares the given type and subtype with that of the given mime
175 <div class="variablelist"><table border="0">
176 <col align="left" valign="top">
179 <td><p><span class="term"><em class="parameter"><code>mime_type</code></em> :</span></p></td>
180 <td>a <a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> object</td>
183 <td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
184 <td>MIME type to compare against</td>
187 <td><p><span class="term"><em class="parameter"><code>subtype</code></em> :</span></p></td>
188 <td>MIME subtype to compare against</td>
191 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
192 <td>TRUE if the MIME types match or FALSE otherwise. You may
193 use "*" in place of <em class="parameter"><code>type</code></em> and/or <em class="parameter"><code>subtype</code></em> as a wilcard.</td>
199 <div class="refsect2">
200 <a name="g-mime-content-type-get-media-type"></a><h3>g_mime_content_type_get_media_type ()</h3>
201 <pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_content_type_get_media_type (<em class="parameter"><code><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> *mime_type</code></em>);</pre>
203 Gets the Content-Type's media type.
205 <div class="variablelist"><table border="0">
206 <col align="left" valign="top">
209 <td><p><span class="term"><em class="parameter"><code>mime_type</code></em> :</span></p></td>
210 <td>a <a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> object</td>
213 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
214 <td>the Content-Type's media type.</td>
220 <div class="refsect2">
221 <a name="g-mime-content-type-set-media-type"></a><h3>g_mime_content_type_set_media_type ()</h3>
222 <pre class="programlisting"><span class="returnvalue">void</span> g_mime_content_type_set_media_type (<em class="parameter"><code><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> *mime_type</code></em>,
223 <em class="parameter"><code>const <span class="type">char</span> *type</code></em>);</pre>
225 Sets the Content-Type's media type.
227 <div class="variablelist"><table border="0">
228 <col align="left" valign="top">
231 <td><p><span class="term"><em class="parameter"><code>mime_type</code></em> :</span></p></td>
232 <td>a <a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> object</td>
235 <td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
242 <div class="refsect2">
243 <a name="g-mime-content-type-get-media-subtype"></a><h3>g_mime_content_type_get_media_subtype ()</h3>
244 <pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_content_type_get_media_subtype
245 (<em class="parameter"><code><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> *mime_type</code></em>);</pre>
247 Gets the Content-Type's media sub-type.
249 <div class="variablelist"><table border="0">
250 <col align="left" valign="top">
253 <td><p><span class="term"><em class="parameter"><code>mime_type</code></em> :</span></p></td>
254 <td>a <a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> object</td>
257 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
258 <td>the Content-Type's media sub-type.</td>
264 <div class="refsect2">
265 <a name="g-mime-content-type-set-media-subtype"></a><h3>g_mime_content_type_set_media_subtype ()</h3>
266 <pre class="programlisting"><span class="returnvalue">void</span> g_mime_content_type_set_media_subtype
267 (<em class="parameter"><code><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> *mime_type</code></em>,
268 <em class="parameter"><code>const <span class="type">char</span> *subtype</code></em>);</pre>
270 Sets the Content-Type's media subtype.
272 <div class="variablelist"><table border="0">
273 <col align="left" valign="top">
276 <td><p><span class="term"><em class="parameter"><code>mime_type</code></em> :</span></p></td>
277 <td>a <a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> object</td>
280 <td><p><span class="term"><em class="parameter"><code>subtype</code></em> :</span></p></td>
281 <td>media subtype</td>
287 <div class="refsect2">
288 <a name="g-mime-content-type-get-params"></a><h3>g_mime_content_type_get_params ()</h3>
289 <pre class="programlisting">const <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="returnvalue">GMimeParam</span></a> * g_mime_content_type_get_params (<em class="parameter"><code><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> *mime_type</code></em>);</pre>
291 Gets the Content-Type's parameter list.
293 <div class="variablelist"><table border="0">
294 <col align="left" valign="top">
297 <td><p><span class="term"><em class="parameter"><code>mime_type</code></em> :</span></p></td>
298 <td>a <a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> object</td>
301 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
302 <td>the Content-Type's parameter list.</td>
308 <div class="refsect2">
309 <a name="g-mime-content-type-set-params"></a><h3>g_mime_content_type_set_params ()</h3>
310 <pre class="programlisting"><span class="returnvalue">void</span> g_mime_content_type_set_params (<em class="parameter"><code><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> *mime_type</code></em>,
311 <em class="parameter"><code><a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *params</code></em>);</pre>
313 Sets the Content-Type's parameter list.
315 <div class="variablelist"><table border="0">
316 <col align="left" valign="top">
319 <td><p><span class="term"><em class="parameter"><code>mime_type</code></em> :</span></p></td>
320 <td>a <a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> object</td>
323 <td><p><span class="term"><em class="parameter"><code>params</code></em> :</span></p></td>
324 <td>a list of <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> objects</td>
330 <div class="refsect2">
331 <a name="g-mime-content-type-get-parameter"></a><h3>g_mime_content_type_get_parameter ()</h3>
332 <pre class="programlisting">const <span class="returnvalue">char</span> * g_mime_content_type_get_parameter (<em class="parameter"><code><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> *mime_type</code></em>,
333 <em class="parameter"><code>const <span class="type">char</span> *attribute</code></em>);</pre>
335 Gets the parameter value specified by <em class="parameter"><code>attribute</code></em> if it's available.
337 <div class="variablelist"><table border="0">
338 <col align="left" valign="top">
341 <td><p><span class="term"><em class="parameter"><code>mime_type</code></em> :</span></p></td>
342 <td>a <a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> object</td>
345 <td><p><span class="term"><em class="parameter"><code>attribute</code></em> :</span></p></td>
346 <td>parameter name (aka attribute)</td>
349 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
350 <td>a const pointer to the paramer value specified by
351 <em class="parameter"><code>attribute</code></em> or <code class="literal">NULL</code> on fail.</td>
357 <div class="refsect2">
358 <a name="g-mime-content-type-set-parameter"></a><h3>g_mime_content_type_set_parameter ()</h3>
359 <pre class="programlisting"><span class="returnvalue">void</span> g_mime_content_type_set_parameter (<em class="parameter"><code><a class="link" href="GMimeContentType.html" title="GMimeContentType"><span class="type">GMimeContentType</span></a> *mime_type</code></em>,
360 <em class="parameter"><code>const <span class="type">char</span> *attribute</code></em>,
361 <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);</pre>
363 Sets a parameter on the Content-Type.
365 <div class="variablelist"><table border="0">
366 <col align="left" valign="top">
369 <td><p><span class="term"><em class="parameter"><code>mime_type</code></em> :</span></p></td>
370 <td>MIME Content-Type</td>
373 <td><p><span class="term"><em class="parameter"><code>attribute</code></em> :</span></p></td>
374 <td>parameter name (aka attribute)</td>
377 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
378 <td>parameter value</td>
387 Generated by GTK-Doc V1.18</div>