docs/reference/html/GMimeContentDisposition.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>GMimeContentDisposition</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="GMimeContentType.html" title="GMimeContentType">
  10 <link rel="next" href="gmime-GMimeParam.html" title="GMimeParam">
  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="GMimeContentType.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="gmime-GMimeParam.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="#GMimeContentDisposition.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#GMimeContentDisposition.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#GMimeContentDisposition.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry">
  32 <a name="GMimeContentDisposition"></a><div class="titlepage"></div>
  33 <div class="refnamediv"><table width="100%"><tr>
  34 <td valign="top">
  35 <h2><span class="refentrytitle"><a name="GMimeContentDisposition.top_of_page"></a>GMimeContentDisposition</span></h2>
  36 <p>GMimeContentDisposition — Content-Disposition fields</p>
  37 </td>
  38 <td valign="top" align="right"></td>
  39 </tr></table></div>
  40 <div class="refsynopsisdiv">
  41 <a name="GMimeContentDisposition.synopsis"></a><h2>Synopsis</h2>
  42 <pre class="synopsis">#define             <a class="link" href="GMimeContentDisposition.html#GMIME-DISPOSITION-ATTACHMENT:CAPS" title="GMIME_DISPOSITION_ATTACHMENT">GMIME_DISPOSITION_ATTACHMENT</a>
  43 #define             <a class="link" href="GMimeContentDisposition.html#GMIME-DISPOSITION-INLINE:CAPS" title="GMIME_DISPOSITION_INLINE">GMIME_DISPOSITION_INLINE</a>
  44 struct              <a class="link" href="GMimeContentDisposition.html#GMimeContentDisposition-struct" title="struct GMimeContentDisposition">GMimeContentDisposition</a>;
  45 <a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="returnvalue">GMimeContentDisposition</span></a> * <a class="link" href="GMimeContentDisposition.html#g-mime-content-disposition-new" title="g_mime_content_disposition_new ()">g_mime_content_disposition_new</a>
  46                                                         (<em class="parameter"><code><span class="type">void</span></code></em>);
  47 <a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="returnvalue">GMimeContentDisposition</span></a> * <a class="link" href="GMimeContentDisposition.html#g-mime-content-disposition-new-from-string" title="g_mime_content_disposition_new_from_string ()">g_mime_content_disposition_new_from_string</a>
  48                                                         (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>);
  49 <span class="returnvalue">void</span>                <a class="link" href="GMimeContentDisposition.html#g-mime-content-disposition-set-disposition" title="g_mime_content_disposition_set_disposition ()">g_mime_content_disposition_set_disposition</a>
  50                                                         (<em class="parameter"><code><a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> *disposition</code></em>,
  51                                                          <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);
  52 const <span class="returnvalue">char</span> *        <a class="link" href="GMimeContentDisposition.html#g-mime-content-disposition-get-disposition" title="g_mime_content_disposition_get_disposition ()">g_mime_content_disposition_get_disposition</a>
  53                                                         (<em class="parameter"><code><a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> *disposition</code></em>);
  54 const <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="returnvalue">GMimeParam</span></a> *  <a class="link" href="GMimeContentDisposition.html#g-mime-content-disposition-get-params" title="g_mime_content_disposition_get_params ()">g_mime_content_disposition_get_params</a>
  55                                                         (<em class="parameter"><code><a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> *disposition</code></em>);
  56 <span class="returnvalue">void</span>                <a class="link" href="GMimeContentDisposition.html#g-mime-content-disposition-set-params" title="g_mime_content_disposition_set_params ()">g_mime_content_disposition_set_params</a>
  57                                                         (<em class="parameter"><code><a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> *disposition</code></em>,
  58                                                          <em class="parameter"><code><a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> *params</code></em>);
  59 <span class="returnvalue">void</span>                <a class="link" href="GMimeContentDisposition.html#g-mime-content-disposition-set-parameter" title="g_mime_content_disposition_set_parameter ()">g_mime_content_disposition_set_parameter</a>
  60                                                         (<em class="parameter"><code><a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> *disposition</code></em>,
  61                                                          <em class="parameter"><code>const <span class="type">char</span> *attribute</code></em>,
  62                                                          <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);
  63 const <span class="returnvalue">char</span> *        <a class="link" href="GMimeContentDisposition.html#g-mime-content-disposition-get-parameter" title="g_mime_content_disposition_get_parameter ()">g_mime_content_disposition_get_parameter</a>
  64                                                         (<em class="parameter"><code><a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> *disposition</code></em>,
  65                                                          <em class="parameter"><code>const <span class="type">char</span> *attribute</code></em>);
  66 <span class="returnvalue">char</span> *              <a class="link" href="GMimeContentDisposition.html#g-mime-content-disposition-to-string" title="g_mime_content_disposition_to_string ()">g_mime_content_disposition_to_string</a>
  67                                                         (<em class="parameter"><code><a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> *disposition</code></em>,
  68                                                          <em class="parameter"><code><span class="type">gboolean</span> fold</code></em>);
  69 </pre>
  70 </div>
  71 <div class="refsect1">
  72 <a name="GMimeContentDisposition.object-hierarchy"></a><h2>Object Hierarchy</h2>
  73 <pre class="synopsis">
  74   GObject
  75    +----GMimeContentDisposition
  76 </pre>
  77 </div>
  78 <div class="refsect1">
  79 <a name="GMimeContentDisposition.description"></a><h2>Description</h2>
  80 <p>
  81 A <a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> represents the pre-parsed contents of a
  82 Content-Disposition header field.
  83 </p>
  84 </div>
  85 <div class="refsect1">
  86 <a name="GMimeContentDisposition.details"></a><h2>Details</h2>
  87 <div class="refsect2">
  88 <a name="GMIME-DISPOSITION-ATTACHMENT:CAPS"></a><h3>GMIME_DISPOSITION_ATTACHMENT</h3>
  89 <pre class="programlisting">#define GMIME_DISPOSITION_ATTACHMENT "attachment"
  90 </pre>
  91 <p>
  92 Standard attachment disposition.
  93 </p>
  94 </div>
  95 <hr>
  96 <div class="refsect2">
  97 <a name="GMIME-DISPOSITION-INLINE:CAPS"></a><h3>GMIME_DISPOSITION_INLINE</h3>
  98 <pre class="programlisting">#define GMIME_DISPOSITION_INLINE     "inline"
  99 </pre>
 100 <p>
 101 Standard inline disposition.
 102 </p>
 103 </div>
 104 <hr>
 105 <div class="refsect2">
 106 <a name="GMimeContentDisposition-struct"></a><h3>struct GMimeContentDisposition</h3>
 107 <pre class="programlisting">struct GMimeContentDisposition;</pre>
 108 <p>
 109 A data structure representing a Content-Disposition.
 110 </p>
 111 <div class="variablelist"><table border="0">
 112 <col align="left" valign="top">
 113 <tbody></tbody>
 114 </table></div>
 115 </div>
 116 <hr>
 117 <div class="refsect2">
 118 <a name="g-mime-content-disposition-new"></a><h3>g_mime_content_disposition_new ()</h3>
 119 <pre class="programlisting"><a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="returnvalue">GMimeContentDisposition</span></a> * g_mime_content_disposition_new
 120                                                         (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 121 <p>
 122 Creates a new <a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> object.
 123 </p>
 124 <div class="variablelist"><table border="0">
 125 <col align="left" valign="top">
 126 <tbody><tr>
 127 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 128 <td>a new <a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> object.</td>
 129 </tr></tbody>
 130 </table></div>
 131 </div>
 132 <hr>
 133 <div class="refsect2">
 134 <a name="g-mime-content-disposition-new-from-string"></a><h3>g_mime_content_disposition_new_from_string ()</h3>
 135 <pre class="programlisting"><a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="returnvalue">GMimeContentDisposition</span></a> * g_mime_content_disposition_new_from_string
 136                                                         (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>);</pre>
 137 <p>
 138 Creates a new <a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> object.
 139 </p>
 140 <div class="variablelist"><table border="0">
 141 <col align="left" valign="top">
 142 <tbody>
 143 <tr>
 144 <td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
 145 <td>Content-Disposition field value or <code class="literal">NULL</code>
 146 </td>
 147 </tr>
 148 <tr>
 149 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 150 <td>a new <a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> object.</td>
 151 </tr>
 152 </tbody>
 153 </table></div>
 154 </div>
 155 <hr>
 156 <div class="refsect2">
 157 <a name="g-mime-content-disposition-set-disposition"></a><h3>g_mime_content_disposition_set_disposition ()</h3>
 158 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_content_disposition_set_disposition
 159                                                         (<em class="parameter"><code><a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> *disposition</code></em>,
 160                                                          <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);</pre>
 161 <p>
 162 Sets the disposition to <em class="parameter"><code>value</code></em> which may be one of
 163 <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
 164 your choice, any other string which would indicate how the MIME
 165 part should be displayed by the MUA.
 166 </p>
 167 <div class="variablelist"><table border="0">
 168 <col align="left" valign="top">
 169 <tbody>
 170 <tr>
 171 <td><p><span class="term"><em class="parameter"><code>disposition</code></em> :</span></p></td>
 172 <td>a <a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> object</td>
 173 </tr>
 174 <tr>
 175 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 176 <td>disposition value</td>
 177 </tr>
 178 </tbody>
 179 </table></div>
 180 </div>
 181 <hr>
 182 <div class="refsect2">
 183 <a name="g-mime-content-disposition-get-disposition"></a><h3>g_mime_content_disposition_get_disposition ()</h3>
 184 <pre class="programlisting">const <span class="returnvalue">char</span> *        g_mime_content_disposition_get_disposition
 185                                                         (<em class="parameter"><code><a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> *disposition</code></em>);</pre>
 186 <p>
 187 Gets the disposition or <code class="literal">NULL</code> on fail.
 188 </p>
 189 <div class="variablelist"><table border="0">
 190 <col align="left" valign="top">
 191 <tbody>
 192 <tr>
 193 <td><p><span class="term"><em class="parameter"><code>disposition</code></em> :</span></p></td>
 194 <td>a <a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> object</td>
 195 </tr>
 196 <tr>
 197 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 198 <td>the disposition string which is probably one of
 199 <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>
 200 </tr>
 201 </tbody>
 202 </table></div>
 203 </div>
 204 <hr>
 205 <div class="refsect2">
 206 <a name="g-mime-content-disposition-get-params"></a><h3>g_mime_content_disposition_get_params ()</h3>
 207 <pre class="programlisting">const <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="returnvalue">GMimeParam</span></a> *  g_mime_content_disposition_get_params
 208                                                         (<em class="parameter"><code><a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> *disposition</code></em>);</pre>
 209 <p>
 210 Gets the Content-Disposition parameter list.
 211 </p>
 212 <div class="variablelist"><table border="0">
 213 <col align="left" valign="top">
 214 <tbody>
 215 <tr>
 216 <td><p><span class="term"><em class="parameter"><code>disposition</code></em> :</span></p></td>
 217 <td>a <a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> object</td>
 218 </tr>
 219 <tr>
 220 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 221 <td>the list of <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a>'s set on <em class="parameter"><code>disposition</code></em>.</td>
 222 </tr>
 223 </tbody>
 224 </table></div>
 225 </div>
 226 <hr>
 227 <div class="refsect2">
 228 <a name="g-mime-content-disposition-set-params"></a><h3>g_mime_content_disposition_set_params ()</h3>
 229 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_content_disposition_set_params
 230                                                         (<em class="parameter"><code><a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> *disposition</code></em>,
 231                                                          <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>
 232 <p>
 233 Sets the Content-Disposition's parameter list.
 234 </p>
 235 <div class="variablelist"><table border="0">
 236 <col align="left" valign="top">
 237 <tbody>
 238 <tr>
 239 <td><p><span class="term"><em class="parameter"><code>disposition</code></em> :</span></p></td>
 240 <td>a <a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> object</td>
 241 </tr>
 242 <tr>
 243 <td><p><span class="term"><em class="parameter"><code>params</code></em> :</span></p></td>
 244 <td>a list of <a class="link" href="gmime-GMimeParam.html#GMimeParam" title="struct GMimeParam"><span class="type">GMimeParam</span></a> objects</td>
 245 </tr>
 246 </tbody>
 247 </table></div>
 248 </div>
 249 <hr>
 250 <div class="refsect2">
 251 <a name="g-mime-content-disposition-set-parameter"></a><h3>g_mime_content_disposition_set_parameter ()</h3>
 252 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_content_disposition_set_parameter
 253                                                         (<em class="parameter"><code><a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> *disposition</code></em>,
 254                                                          <em class="parameter"><code>const <span class="type">char</span> *attribute</code></em>,
 255                                                          <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);</pre>
 256 <p>
 257 Sets a parameter on the Content-Disposition.
 258 </p>
 259 <div class="variablelist"><table border="0">
 260 <col align="left" valign="top">
 261 <tbody>
 262 <tr>
 263 <td><p><span class="term"><em class="parameter"><code>disposition</code></em> :</span></p></td>
 264 <td>a <a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> object</td>
 265 </tr>
 266 <tr>
 267 <td><p><span class="term"><em class="parameter"><code>attribute</code></em> :</span></p></td>
 268 <td>parameter name</td>
 269 </tr>
 270 <tr>
 271 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 272 <td>parameter value</td>
 273 </tr>
 274 </tbody>
 275 </table></div>
 276 </div>
 277 <hr>
 278 <div class="refsect2">
 279 <a name="g-mime-content-disposition-get-parameter"></a><h3>g_mime_content_disposition_get_parameter ()</h3>
 280 <pre class="programlisting">const <span class="returnvalue">char</span> *        g_mime_content_disposition_get_parameter
 281                                                         (<em class="parameter"><code><a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> *disposition</code></em>,
 282                                                          <em class="parameter"><code>const <span class="type">char</span> *attribute</code></em>);</pre>
 283 <p>
 284 Gets the value of the parameter <em class="parameter"><code>attribute</code></em>, or <code class="literal">NULL</code> on fail.
 285 </p>
 286 <div class="variablelist"><table border="0">
 287 <col align="left" valign="top">
 288 <tbody>
 289 <tr>
 290 <td><p><span class="term"><em class="parameter"><code>disposition</code></em> :</span></p></td>
 291 <td>a <a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> object</td>
 292 </tr>
 293 <tr>
 294 <td><p><span class="term"><em class="parameter"><code>attribute</code></em> :</span></p></td>
 295 <td>parameter name</td>
 296 </tr>
 297 <tr>
 298 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 299 <td>the value of the parameter of name <em class="parameter"><code>attribute</code></em>.</td>
 300 </tr>
 301 </tbody>
 302 </table></div>
 303 </div>
 304 <hr>
 305 <div class="refsect2">
 306 <a name="g-mime-content-disposition-to-string"></a><h3>g_mime_content_disposition_to_string ()</h3>
 307 <pre class="programlisting"><span class="returnvalue">char</span> *              g_mime_content_disposition_to_string
 308                                                         (<em class="parameter"><code><a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> *disposition</code></em>,
 309                                                          <em class="parameter"><code><span class="type">gboolean</span> fold</code></em>);</pre>
 310 <p>
 311 Allocates a string buffer containing the Content-Disposition header
 312 represented by the disposition object <em class="parameter"><code>disposition</code></em>.
 313 </p>
 314 <div class="variablelist"><table border="0">
 315 <col align="left" valign="top">
 316 <tbody>
 317 <tr>
 318 <td><p><span class="term"><em class="parameter"><code>disposition</code></em> :</span></p></td>
 319 <td>a <a class="link" href="GMimeContentDisposition.html" title="GMimeContentDisposition"><span class="type">GMimeContentDisposition</span></a> object</td>
 320 </tr>
 321 <tr>
 322 <td><p><span class="term"><em class="parameter"><code>fold</code></em> :</span></p></td>
 323 <td>fold header if needed</td>
 324 </tr>
 325 <tr>
 326 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 327 <td>a string containing the disposition header</td>
 328 </tr>
 329 </tbody>
 330 </table></div>
 331 </div>
 332 </div>
 333 </div>
 334 <div class="footer">
 335 <hr>
 336           Generated by GTK-Doc V1.18</div>
 337 </body>
 338 </html>