docs/reference/html/gmime-GMimeHeader.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>GMimeHeader</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="Headers.html" title="Message and MIME Headers">
  10 <link rel="next" href="GMimeContentType.html" title="GMimeContentType">
  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="Headers.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="GMimeContentType.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="#gmime-GMimeHeader.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gmime-GMimeHeader.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="gmime-GMimeHeader"></a><div class="titlepage"></div>
  31 <div class="refnamediv"><table width="100%"><tr>
  32 <td valign="top">
  33 <h2><span class="refentrytitle"><a name="gmime-GMimeHeader.top_of_page"></a>GMimeHeader</span></h2>
  34 <p>GMimeHeader — Message and MIME part headers</p>
  35 </td>
  36 <td valign="top" align="right"></td>
  37 </tr></table></div>
  38 <div class="refsynopsisdiv">
  39 <a name="gmime-GMimeHeader.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis">struct              <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter">GMimeHeaderIter</a>;
  41                     <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList">GMimeHeaderList</a>;
  42 <span class="returnvalue">ssize_t</span>             (<a class="link" href="gmime-GMimeHeader.html#GMimeHeaderWriter" title="GMimeHeaderWriter ()">*GMimeHeaderWriter</a>)                (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>,
  43                                                          <em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
  44                                                          <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);
  45 <span class="returnvalue">void</span>                (<a class="link" href="gmime-GMimeHeader.html#GMimeHeaderForeachFunc" title="GMimeHeaderForeachFunc ()">*GMimeHeaderForeachFunc</a>)           (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
  46                                                          <em class="parameter"><code>const <span class="type">char</span> *value</code></em>,
  47                                                          <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
  48 <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="returnvalue">GMimeHeaderIter</span></a> *   <a class="link" href="gmime-GMimeHeader.html#g-mime-header-iter-new" title="g_mime_header_iter_new ()">g_mime_header_iter_new</a>              (<em class="parameter"><code><span class="type">void</span></code></em>);
  49 <span class="returnvalue">void</span>                <a class="link" href="gmime-GMimeHeader.html#g-mime-header-iter-free" title="g_mime_header_iter_free ()">g_mime_header_iter_free</a>             (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter</code></em>);
  50 <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="returnvalue">GMimeHeaderIter</span></a> *   <a class="link" href="gmime-GMimeHeader.html#g-mime-header-iter-copy" title="g_mime_header_iter_copy ()">g_mime_header_iter_copy</a>             (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter</code></em>);
  51 <span class="returnvalue">void</span>                <a class="link" href="gmime-GMimeHeader.html#g-mime-header-iter-copy-to" title="g_mime_header_iter_copy_to ()">g_mime_header_iter_copy_to</a>          (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *src</code></em>,
  52                                                          <em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *dest</code></em>);
  53 <span class="returnvalue">gboolean</span>            <a class="link" href="gmime-GMimeHeader.html#g-mime-header-iter-equal" title="g_mime_header_iter_equal ()">g_mime_header_iter_equal</a>            (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter1</code></em>,
  54                                                          <em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter2</code></em>);
  55 <span class="returnvalue">gboolean</span>            <a class="link" href="gmime-GMimeHeader.html#g-mime-header-iter-first" title="g_mime_header_iter_first ()">g_mime_header_iter_first</a>            (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter</code></em>);
  56 <span class="returnvalue">gboolean</span>            <a class="link" href="gmime-GMimeHeader.html#g-mime-header-iter-last" title="g_mime_header_iter_last ()">g_mime_header_iter_last</a>             (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter</code></em>);
  57 <span class="returnvalue">gboolean</span>            <a class="link" href="gmime-GMimeHeader.html#g-mime-header-iter-next" title="g_mime_header_iter_next ()">g_mime_header_iter_next</a>             (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter</code></em>);
  58 <span class="returnvalue">gboolean</span>            <a class="link" href="gmime-GMimeHeader.html#g-mime-header-iter-prev" title="g_mime_header_iter_prev ()">g_mime_header_iter_prev</a>             (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter</code></em>);
  59 <span class="returnvalue">gboolean</span>            <a class="link" href="gmime-GMimeHeader.html#g-mime-header-iter-is-valid" title="g_mime_header_iter_is_valid ()">g_mime_header_iter_is_valid</a>         (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter</code></em>);
  60 const <span class="returnvalue">char</span> *        <a class="link" href="gmime-GMimeHeader.html#g-mime-header-iter-get-name" title="g_mime_header_iter_get_name ()">g_mime_header_iter_get_name</a>         (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter</code></em>);
  61 const <span class="returnvalue">char</span> *        <a class="link" href="gmime-GMimeHeader.html#g-mime-header-iter-get-value" title="g_mime_header_iter_get_value ()">g_mime_header_iter_get_value</a>        (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter</code></em>);
  62 <span class="returnvalue">gboolean</span>            <a class="link" href="gmime-GMimeHeader.html#g-mime-header-iter-set-value" title="g_mime_header_iter_set_value ()">g_mime_header_iter_set_value</a>        (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter</code></em>,
  63                                                          <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);
  64 <span class="returnvalue">gboolean</span>            <a class="link" href="gmime-GMimeHeader.html#g-mime-header-iter-remove" title="g_mime_header_iter_remove ()">g_mime_header_iter_remove</a>           (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter</code></em>);
  65 <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="returnvalue">GMimeHeaderList</span></a> *   <a class="link" href="gmime-GMimeHeader.html#g-mime-header-list-new" title="g_mime_header_list_new ()">g_mime_header_list_new</a>              (<em class="parameter"><code><span class="type">void</span></code></em>);
  66 <span class="returnvalue">void</span>                <a class="link" href="gmime-GMimeHeader.html#g-mime-header-list-destroy" title="g_mime_header_list_destroy ()">g_mime_header_list_destroy</a>          (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>);
  67 <span class="returnvalue">void</span>                <a class="link" href="gmime-GMimeHeader.html#g-mime-header-list-clear" title="g_mime_header_list_clear ()">g_mime_header_list_clear</a>            (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>);
  68 <span class="returnvalue">gboolean</span>            <a class="link" href="gmime-GMimeHeader.html#g-mime-header-list-contains" title="g_mime_header_list_contains ()">g_mime_header_list_contains</a>         (<em class="parameter"><code>const <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>,
  69                                                          <em class="parameter"><code>const <span class="type">char</span> *name</code></em>);
  70 <span class="returnvalue">void</span>                <a class="link" href="gmime-GMimeHeader.html#g-mime-header-list-prepend" title="g_mime_header_list_prepend ()">g_mime_header_list_prepend</a>          (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>,
  71                                                          <em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
  72                                                          <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);
  73 <span class="returnvalue">void</span>                <a class="link" href="gmime-GMimeHeader.html#g-mime-header-list-append" title="g_mime_header_list_append ()">g_mime_header_list_append</a>           (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>,
  74                                                          <em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
  75                                                          <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);
  76 <span class="returnvalue">gboolean</span>            <a class="link" href="gmime-GMimeHeader.html#g-mime-header-list-remove" title="g_mime_header_list_remove ()">g_mime_header_list_remove</a>           (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>,
  77                                                          <em class="parameter"><code>const <span class="type">char</span> *name</code></em>);
  78 <span class="returnvalue">void</span>                <a class="link" href="gmime-GMimeHeader.html#g-mime-header-list-set" title="g_mime_header_list_set ()">g_mime_header_list_set</a>              (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>,
  79                                                          <em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
  80                                                          <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);
  81 const <span class="returnvalue">char</span> *        <a class="link" href="gmime-GMimeHeader.html#g-mime-header-list-get" title="g_mime_header_list_get ()">g_mime_header_list_get</a>              (<em class="parameter"><code>const <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>,
  82                                                          <em class="parameter"><code>const <span class="type">char</span> *name</code></em>);
  83 <span class="returnvalue">gboolean</span>            <a class="link" href="gmime-GMimeHeader.html#g-mime-header-list-get-iter" title="g_mime_header_list_get_iter ()">g_mime_header_list_get_iter</a>         (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>,
  84                                                          <em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter</code></em>);
  85 <span class="returnvalue">void</span>                <a class="link" href="gmime-GMimeHeader.html#g-mime-header-list-foreach" title="g_mime_header_list_foreach ()">g_mime_header_list_foreach</a>          (<em class="parameter"><code>const <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>,
  86                                                          <em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderForeachFunc" title="GMimeHeaderForeachFunc ()"><span class="type">GMimeHeaderForeachFunc</span></a> func</code></em>,
  87                                                          <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
  88 <span class="returnvalue">void</span>                <a class="link" href="gmime-GMimeHeader.html#g-mime-header-list-register-writer" title="g_mime_header_list_register_writer ()">g_mime_header_list_register_writer</a>  (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>,
  89                                                          <em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
  90                                                          <em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderWriter" title="GMimeHeaderWriter ()"><span class="type">GMimeHeaderWriter</span></a> writer</code></em>);
  91 <span class="returnvalue">ssize_t</span>             <a class="link" href="gmime-GMimeHeader.html#g-mime-header-list-write-to-stream" title="g_mime_header_list_write_to_stream ()">g_mime_header_list_write_to_stream</a>  (<em class="parameter"><code>const <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>,
  92                                                          <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>);
  93 <span class="returnvalue">char</span> *              <a class="link" href="gmime-GMimeHeader.html#g-mime-header-list-to-string" title="g_mime_header_list_to_string ()">g_mime_header_list_to_string</a>        (<em class="parameter"><code>const <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>);
  94 <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> *       <a class="link" href="gmime-GMimeHeader.html#g-mime-header-list-get-stream" title="g_mime_header_list_get_stream ()">g_mime_header_list_get_stream</a>       (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>);
  95 <span class="returnvalue">void</span>                <a class="link" href="gmime-GMimeHeader.html#g-mime-header-list-set-stream" title="g_mime_header_list_set_stream ()">g_mime_header_list_set_stream</a>       (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</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 </pre>
  98 </div>
  99 <div class="refsect1">
 100 <a name="gmime-GMimeHeader.description"></a><h2>Description</h2>
 101 <p>
 102 A <span class="type">GMimeHeader</span> is a collection of rfc822 header fields and their
 103 values.
 104 </p>
 105 </div>
 106 <div class="refsect1">
 107 <a name="gmime-GMimeHeader.details"></a><h2>Details</h2>
 108 <div class="refsect2">
 109 <a name="GMimeHeaderIter"></a><h3>struct GMimeHeaderIter</h3>
 110 <pre class="programlisting">struct GMimeHeaderIter {
 111         GMimeHeaderList *hdrlist;
 112         GMimeHeader *cursor;
 113         guint32 version;
 114 };
 115 </pre>
 116 <p>
 117 A message or mime-part header iterator. All members should be
 118 considered private.
 119 </p>
 120 <div class="variablelist"><table border="0">
 121 <col align="left" valign="top">
 122 <tbody>
 123 <tr>
 124 <td><p><span class="term"><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *<em class="structfield"><code><a name="GMimeHeaderIter.hdrlist"></a>hdrlist</code></em>;</span></p></td>
 125 <td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a>
 126 </td>
 127 </tr>
 128 <tr>
 129 <td><p><span class="term"><span class="type">GMimeHeader</span> *<em class="structfield"><code><a name="GMimeHeaderIter.cursor"></a>cursor</code></em>;</span></p></td>
 130 <td>a <span class="type">GMimeHeader</span>
 131 </td>
 132 </tr>
 133 <tr>
 134 <td><p><span class="term"><span class="type">guint32</span> <em class="structfield"><code><a name="GMimeHeaderIter.version"></a>version</code></em>;</span></p></td>
 135 <td>the version of <em class="parameter"><code>hdrlist</code></em> when initialized</td>
 136 </tr>
 137 </tbody>
 138 </table></div>
 139 </div>
 140 <hr>
 141 <div class="refsect2">
 142 <a name="GMimeHeaderList"></a><h3>GMimeHeaderList</h3>
 143 <pre class="programlisting">typedef struct _GMimeHeaderList GMimeHeaderList;</pre>
 144 <p>
 145 A message or mime-part header.
 146 </p>
 147 </div>
 148 <hr>
 149 <div class="refsect2">
 150 <a name="GMimeHeaderWriter"></a><h3>GMimeHeaderWriter ()</h3>
 151 <pre class="programlisting"><span class="returnvalue">ssize_t</span>             (*GMimeHeaderWriter)                (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>,
 152                                                          <em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
 153                                                          <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);</pre>
 154 <p>
 155 Function signature for the callback to
 156 <a class="link" href="gmime-GMimeHeader.html#g-mime-header-list-register-writer" title="g_mime_header_list_register_writer ()"><code class="function">g_mime_header_list_register_writer()</code></a>.
 157 </p>
 158 <div class="variablelist"><table border="0">
 159 <col align="left" valign="top">
 160 <tbody>
 161 <tr>
 162 <td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
 163 <td>The output stream.</td>
 164 </tr>
 165 <tr>
 166 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
 167 <td>The field name.</td>
 168 </tr>
 169 <tr>
 170 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 171 <td>The field value.</td>
 172 </tr>
 173 <tr>
 174 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 175 <td>the number of bytes written or <code class="literal">-1</code> on error.</td>
 176 </tr>
 177 </tbody>
 178 </table></div>
 179 </div>
 180 <hr>
 181 <div class="refsect2">
 182 <a name="GMimeHeaderForeachFunc"></a><h3>GMimeHeaderForeachFunc ()</h3>
 183 <pre class="programlisting"><span class="returnvalue">void</span>                (*GMimeHeaderForeachFunc)           (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
 184                                                          <em class="parameter"><code>const <span class="type">char</span> *value</code></em>,
 185                                                          <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
 186 <p>
 187 Function signature for the callback to <a class="link" href="gmime-GMimeHeader.html#g-mime-header-list-foreach" title="g_mime_header_list_foreach ()"><code class="function">g_mime_header_list_foreach()</code></a>.
 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>name</code></em> :</span></p></td>
 194 <td>The field name.</td>
 195 </tr>
 196 <tr>
 197 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 198 <td>The field value.</td>
 199 </tr>
 200 <tr>
 201 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 202 <td>The user-supplied callback data.</td>
 203 </tr>
 204 </tbody>
 205 </table></div>
 206 </div>
 207 <hr>
 208 <div class="refsect2">
 209 <a name="g-mime-header-iter-new"></a><h3>g_mime_header_iter_new ()</h3>
 210 <pre class="programlisting"><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="returnvalue">GMimeHeaderIter</span></a> *   g_mime_header_iter_new              (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 211 <p>
 212 Dynamically allocates a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> on the heap. This is
 213 intended for use in language bindings but may also be useful in
 214 applications as well. You must free this iter with
 215 <a class="link" href="gmime-GMimeHeader.html#g-mime-header-iter-free" title="g_mime_header_iter_free ()"><code class="function">g_mime_header_iter_free()</code></a>.
 216 </p>
 217 <div class="variablelist"><table border="0">
 218 <col align="left" valign="top">
 219 <tbody><tr>
 220 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 221 <td>a newly-allocated <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a>.</td>
 222 </tr></tbody>
 223 </table></div>
 224 </div>
 225 <hr>
 226 <div class="refsect2">
 227 <a name="g-mime-header-iter-free"></a><h3>g_mime_header_iter_free ()</h3>
 228 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_header_iter_free             (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter</code></em>);</pre>
 229 <p>
 230 Frees a dynamically-allocated <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> as created by
 231 <a class="link" href="gmime-GMimeHeader.html#g-mime-header-iter-new" title="g_mime_header_iter_new ()"><code class="function">g_mime_header_iter_new()</code></a> or <a class="link" href="gmime-GMimeHeader.html#g-mime-header-iter-copy" title="g_mime_header_iter_copy ()"><code class="function">g_mime_header_iter_copy()</code></a>.
 232 </p>
 233 <div class="variablelist"><table border="0">
 234 <col align="left" valign="top">
 235 <tbody><tr>
 236 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
 237 <td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a>
 238 </td>
 239 </tr></tbody>
 240 </table></div>
 241 </div>
 242 <hr>
 243 <div class="refsect2">
 244 <a name="g-mime-header-iter-copy"></a><h3>g_mime_header_iter_copy ()</h3>
 245 <pre class="programlisting"><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="returnvalue">GMimeHeaderIter</span></a> *   g_mime_header_iter_copy             (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter</code></em>);</pre>
 246 <p>
 247 Creates a dynamically allocated header iterator as a copy of
 248 <em class="parameter"><code>iter</code></em>. You must free this iter with <a class="link" href="gmime-GMimeHeader.html#g-mime-header-iter-free" title="g_mime_header_iter_free ()"><code class="function">g_mime_header_iter_free()</code></a>.
 249 </p>
 250 <div class="variablelist"><table border="0">
 251 <col align="left" valign="top">
 252 <tbody>
 253 <tr>
 254 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
 255 <td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a>
 256 </td>
 257 </tr>
 258 <tr>
 259 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 260 <td>a newly-allocated copy of <em class="parameter"><code>iter</code></em>.</td>
 261 </tr>
 262 </tbody>
 263 </table></div>
 264 </div>
 265 <hr>
 266 <div class="refsect2">
 267 <a name="g-mime-header-iter-copy-to"></a><h3>g_mime_header_iter_copy_to ()</h3>
 268 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_header_iter_copy_to          (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *src</code></em>,
 269                                                          <em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *dest</code></em>);</pre>
 270 <p>
 271 Copies <em class="parameter"><code>src</code></em> to <em class="parameter"><code>dest</code></em>.
 272 </p>
 273 <div class="variablelist"><table border="0">
 274 <col align="left" valign="top">
 275 <tbody>
 276 <tr>
 277 <td><p><span class="term"><em class="parameter"><code>src</code></em> :</span></p></td>
 278 <td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a>
 279 </td>
 280 </tr>
 281 <tr>
 282 <td><p><span class="term"><em class="parameter"><code>dest</code></em> :</span></p></td>
 283 <td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a>
 284 </td>
 285 </tr>
 286 </tbody>
 287 </table></div>
 288 </div>
 289 <hr>
 290 <div class="refsect2">
 291 <a name="g-mime-header-iter-equal"></a><h3>g_mime_header_iter_equal ()</h3>
 292 <pre class="programlisting"><span class="returnvalue">gboolean</span>            g_mime_header_iter_equal            (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter1</code></em>,
 293                                                          <em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter2</code></em>);</pre>
 294 <p>
 295 Check that <em class="parameter"><code>iter1</code></em> and <em class="parameter"><code>iter2</code></em> reference the same header.
 296 </p>
 297 <div class="variablelist"><table border="0">
 298 <col align="left" valign="top">
 299 <tbody>
 300 <tr>
 301 <td><p><span class="term"><em class="parameter"><code>iter1</code></em> :</span></p></td>
 302 <td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a>
 303 </td>
 304 </tr>
 305 <tr>
 306 <td><p><span class="term"><em class="parameter"><code>iter2</code></em> :</span></p></td>
 307 <td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a>
 308 </td>
 309 </tr>
 310 <tr>
 311 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 312 <td>
 313 <code class="literal">TRUE</code> if <em class="parameter"><code>iter1</code></em> and <em class="parameter"><code>iter2</code></em> refer to the same header or
 314 <code class="literal">FALSE</code> otherwise.</td>
 315 </tr>
 316 </tbody>
 317 </table></div>
 318 </div>
 319 <hr>
 320 <div class="refsect2">
 321 <a name="g-mime-header-iter-first"></a><h3>g_mime_header_iter_first ()</h3>
 322 <pre class="programlisting"><span class="returnvalue">gboolean</span>            g_mime_header_iter_first            (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter</code></em>);</pre>
 323 <p>
 324 Updates <em class="parameter"><code>iter</code></em> to point to the first header.
 325 </p>
 326 <div class="variablelist"><table border="0">
 327 <col align="left" valign="top">
 328 <tbody>
 329 <tr>
 330 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
 331 <td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a>
 332 </td>
 333 </tr>
 334 <tr>
 335 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 336 <td>
 337 <code class="literal">TRUE</code> on success or <code class="literal">FALSE</code> otherwise.</td>
 338 </tr>
 339 </tbody>
 340 </table></div>
 341 </div>
 342 <hr>
 343 <div class="refsect2">
 344 <a name="g-mime-header-iter-last"></a><h3>g_mime_header_iter_last ()</h3>
 345 <pre class="programlisting"><span class="returnvalue">gboolean</span>            g_mime_header_iter_last             (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter</code></em>);</pre>
 346 <p>
 347 Updates <em class="parameter"><code>iter</code></em> to point to the last header.
 348 </p>
 349 <div class="variablelist"><table border="0">
 350 <col align="left" valign="top">
 351 <tbody>
 352 <tr>
 353 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
 354 <td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a>
 355 </td>
 356 </tr>
 357 <tr>
 358 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 359 <td>
 360 <code class="literal">TRUE</code> on success or <code class="literal">FALSE</code> otherwise.</td>
 361 </tr>
 362 </tbody>
 363 </table></div>
 364 </div>
 365 <hr>
 366 <div class="refsect2">
 367 <a name="g-mime-header-iter-next"></a><h3>g_mime_header_iter_next ()</h3>
 368 <pre class="programlisting"><span class="returnvalue">gboolean</span>            g_mime_header_iter_next             (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter</code></em>);</pre>
 369 <p>
 370 Advances to the next header.
 371 </p>
 372 <div class="variablelist"><table border="0">
 373 <col align="left" valign="top">
 374 <tbody>
 375 <tr>
 376 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
 377 <td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a>
 378 </td>
 379 </tr>
 380 <tr>
 381 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 382 <td>
 383 <code class="literal">TRUE</code> on success or <code class="literal">FALSE</code> otherwise.</td>
 384 </tr>
 385 </tbody>
 386 </table></div>
 387 </div>
 388 <hr>
 389 <div class="refsect2">
 390 <a name="g-mime-header-iter-prev"></a><h3>g_mime_header_iter_prev ()</h3>
 391 <pre class="programlisting"><span class="returnvalue">gboolean</span>            g_mime_header_iter_prev             (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter</code></em>);</pre>
 392 <p>
 393 Advances to the previous header.
 394 </p>
 395 <div class="variablelist"><table border="0">
 396 <col align="left" valign="top">
 397 <tbody>
 398 <tr>
 399 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
 400 <td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a>
 401 </td>
 402 </tr>
 403 <tr>
 404 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 405 <td>
 406 <code class="literal">TRUE</code> on success or <code class="literal">FALSE</code> otherwise.</td>
 407 </tr>
 408 </tbody>
 409 </table></div>
 410 </div>
 411 <hr>
 412 <div class="refsect2">
 413 <a name="g-mime-header-iter-is-valid"></a><h3>g_mime_header_iter_is_valid ()</h3>
 414 <pre class="programlisting"><span class="returnvalue">gboolean</span>            g_mime_header_iter_is_valid         (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter</code></em>);</pre>
 415 <p>
 416 Checks if a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> is valid. An iterator may become
 417 invalid if the <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> that the iterator refers to
 418 changes.
 419 </p>
 420 <div class="variablelist"><table border="0">
 421 <col align="left" valign="top">
 422 <tbody>
 423 <tr>
 424 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
 425 <td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a>
 426 </td>
 427 </tr>
 428 <tr>
 429 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 430 <td>
 431 <code class="literal">TRUE</code> if <em class="parameter"><code>iter</code></em> is still valid or <code class="literal">FALSE</code> otherwise.</td>
 432 </tr>
 433 </tbody>
 434 </table></div>
 435 </div>
 436 <hr>
 437 <div class="refsect2">
 438 <a name="g-mime-header-iter-get-name"></a><h3>g_mime_header_iter_get_name ()</h3>
 439 <pre class="programlisting">const <span class="returnvalue">char</span> *        g_mime_header_iter_get_name         (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter</code></em>);</pre>
 440 <p>
 441 Gets the current header's name.
 442 </p>
 443 <div class="variablelist"><table border="0">
 444 <col align="left" valign="top">
 445 <tbody>
 446 <tr>
 447 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
 448 <td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a>
 449 </td>
 450 </tr>
 451 <tr>
 452 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 453 <td>the header name or <code class="literal">NULL</code> if invalid.</td>
 454 </tr>
 455 </tbody>
 456 </table></div>
 457 </div>
 458 <hr>
 459 <div class="refsect2">
 460 <a name="g-mime-header-iter-get-value"></a><h3>g_mime_header_iter_get_value ()</h3>
 461 <pre class="programlisting">const <span class="returnvalue">char</span> *        g_mime_header_iter_get_value        (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter</code></em>);</pre>
 462 <p>
 463 Gets the current header's name.
 464 </p>
 465 <div class="variablelist"><table border="0">
 466 <col align="left" valign="top">
 467 <tbody>
 468 <tr>
 469 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
 470 <td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a>
 471 </td>
 472 </tr>
 473 <tr>
 474 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 475 <td>the header name or <code class="literal">NULL</code> if invalid.</td>
 476 </tr>
 477 </tbody>
 478 </table></div>
 479 </div>
 480 <hr>
 481 <div class="refsect2">
 482 <a name="g-mime-header-iter-set-value"></a><h3>g_mime_header_iter_set_value ()</h3>
 483 <pre class="programlisting"><span class="returnvalue">gboolean</span>            g_mime_header_iter_set_value        (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter</code></em>,
 484                                                          <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);</pre>
 485 <p>
 486 Sets the current header's value to the new value.
 487 </p>
 488 <div class="variablelist"><table border="0">
 489 <col align="left" valign="top">
 490 <tbody>
 491 <tr>
 492 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
 493 <td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a>
 494 </td>
 495 </tr>
 496 <tr>
 497 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 498 <td>new header value</td>
 499 </tr>
 500 <tr>
 501 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 502 <td>
 503 <code class="literal">TRUE</code> if the value was set or <code class="literal">FALSE</code> otherwise (indicates
 504 invalid iter).</td>
 505 </tr>
 506 </tbody>
 507 </table></div>
 508 </div>
 509 <hr>
 510 <div class="refsect2">
 511 <a name="g-mime-header-iter-remove"></a><h3>g_mime_header_iter_remove ()</h3>
 512 <pre class="programlisting"><span class="returnvalue">gboolean</span>            g_mime_header_iter_remove           (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter</code></em>);</pre>
 513 <p>
 514 Removes the current header and advances to the next header.
 515 </p>
 516 <p>
 517 Note: If you remove the last header in the list, then <em class="parameter"><code>iter</code></em> will
 518 become invalid regardless of whether or not other headers remain.
 519 </p>
 520 <div class="variablelist"><table border="0">
 521 <col align="left" valign="top">
 522 <tbody>
 523 <tr>
 524 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
 525 <td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a>
 526 </td>
 527 </tr>
 528 <tr>
 529 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 530 <td>
 531 <code class="literal">TRUE</code> on success or <code class="literal">FALSE</code> otherwise.</td>
 532 </tr>
 533 </tbody>
 534 </table></div>
 535 </div>
 536 <hr>
 537 <div class="refsect2">
 538 <a name="g-mime-header-list-new"></a><h3>g_mime_header_list_new ()</h3>
 539 <pre class="programlisting"><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="returnvalue">GMimeHeaderList</span></a> *   g_mime_header_list_new              (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 540 <p>
 541 Creates a new <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> object.
 542 </p>
 543 <div class="variablelist"><table border="0">
 544 <col align="left" valign="top">
 545 <tbody><tr>
 546 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 547 <td>a new header list object.</td>
 548 </tr></tbody>
 549 </table></div>
 550 </div>
 551 <hr>
 552 <div class="refsect2">
 553 <a name="g-mime-header-list-destroy"></a><h3>g_mime_header_list_destroy ()</h3>
 554 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_header_list_destroy          (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>);</pre>
 555 <p>
 556 Destroy the header list.
 557 </p>
 558 <div class="variablelist"><table border="0">
 559 <col align="left" valign="top">
 560 <tbody><tr>
 561 <td><p><span class="term"><em class="parameter"><code>headers</code></em> :</span></p></td>
 562 <td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a>
 563 </td>
 564 </tr></tbody>
 565 </table></div>
 566 </div>
 567 <hr>
 568 <div class="refsect2">
 569 <a name="g-mime-header-list-clear"></a><h3>g_mime_header_list_clear ()</h3>
 570 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_header_list_clear            (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>);</pre>
 571 <p>
 572 Removes all of the headers from the <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a>.
 573 </p>
 574 <div class="variablelist"><table border="0">
 575 <col align="left" valign="top">
 576 <tbody><tr>
 577 <td><p><span class="term"><em class="parameter"><code>headers</code></em> :</span></p></td>
 578 <td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a>
 579 </td>
 580 </tr></tbody>
 581 </table></div>
 582 </div>
 583 <hr>
 584 <div class="refsect2">
 585 <a name="g-mime-header-list-contains"></a><h3>g_mime_header_list_contains ()</h3>
 586 <pre class="programlisting"><span class="returnvalue">gboolean</span>            g_mime_header_list_contains         (<em class="parameter"><code>const <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>,
 587                                                          <em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre>
 588 <p>
 589 Checks whether or not a header exists.
 590 </p>
 591 <div class="variablelist"><table border="0">
 592 <col align="left" valign="top">
 593 <tbody>
 594 <tr>
 595 <td><p><span class="term"><em class="parameter"><code>headers</code></em> :</span></p></td>
 596 <td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a>
 597 </td>
 598 </tr>
 599 <tr>
 600 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
 601 <td>header name</td>
 602 </tr>
 603 <tr>
 604 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 605 <td>
 606 <code class="literal">TRUE</code> if the specified header exists or <code class="literal">FALSE</code> otherwise.</td>
 607 </tr>
 608 </tbody>
 609 </table></div>
 610 </div>
 611 <hr>
 612 <div class="refsect2">
 613 <a name="g-mime-header-list-prepend"></a><h3>g_mime_header_list_prepend ()</h3>
 614 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_header_list_prepend          (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>,
 615                                                          <em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
 616                                                          <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);</pre>
 617 <p>
 618 Prepends a header. If <em class="parameter"><code>value</code></em> is <code class="literal">NULL</code>, a space will be set aside
 619 for it (useful for setting the order of headers before values can
 620 be obtained for them) otherwise the header will be unset.
 621 </p>
 622 <div class="variablelist"><table border="0">
 623 <col align="left" valign="top">
 624 <tbody>
 625 <tr>
 626 <td><p><span class="term"><em class="parameter"><code>headers</code></em> :</span></p></td>
 627 <td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a>
 628 </td>
 629 </tr>
 630 <tr>
 631 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
 632 <td>header name</td>
 633 </tr>
 634 <tr>
 635 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 636 <td>header value</td>
 637 </tr>
 638 </tbody>
 639 </table></div>
 640 </div>
 641 <hr>
 642 <div class="refsect2">
 643 <a name="g-mime-header-list-append"></a><h3>g_mime_header_list_append ()</h3>
 644 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_header_list_append           (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>,
 645                                                          <em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
 646                                                          <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);</pre>
 647 <p>
 648 Appends a header. If <em class="parameter"><code>value</code></em> is <code class="literal">NULL</code>, a space will be set aside for it
 649 (useful for setting the order of headers before values can be
 650 obtained for them) otherwise the header will be unset.
 651 </p>
 652 <div class="variablelist"><table border="0">
 653 <col align="left" valign="top">
 654 <tbody>
 655 <tr>
 656 <td><p><span class="term"><em class="parameter"><code>headers</code></em> :</span></p></td>
 657 <td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a>
 658 </td>
 659 </tr>
 660 <tr>
 661 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
 662 <td>header name</td>
 663 </tr>
 664 <tr>
 665 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 666 <td>header value</td>
 667 </tr>
 668 </tbody>
 669 </table></div>
 670 </div>
 671 <hr>
 672 <div class="refsect2">
 673 <a name="g-mime-header-list-remove"></a><h3>g_mime_header_list_remove ()</h3>
 674 <pre class="programlisting"><span class="returnvalue">gboolean</span>            g_mime_header_list_remove           (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>,
 675                                                          <em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre>
 676 <p>
 677 Remove the specified header.
 678 </p>
 679 <div class="variablelist"><table border="0">
 680 <col align="left" valign="top">
 681 <tbody>
 682 <tr>
 683 <td><p><span class="term"><em class="parameter"><code>headers</code></em> :</span></p></td>
 684 <td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a>
 685 </td>
 686 </tr>
 687 <tr>
 688 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
 689 <td>header name</td>
 690 </tr>
 691 <tr>
 692 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 693 <td>
 694 <code class="literal">TRUE</code> if the header was successfully removed or <code class="literal">FALSE</code> if
 695 the specified header could not be found.</td>
 696 </tr>
 697 </tbody>
 698 </table></div>
 699 </div>
 700 <hr>
 701 <div class="refsect2">
 702 <a name="g-mime-header-list-set"></a><h3>g_mime_header_list_set ()</h3>
 703 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_header_list_set              (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>,
 704                                                          <em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
 705                                                          <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);</pre>
 706 <p>
 707 Set the value of the specified header. If <em class="parameter"><code>value</code></em> is <code class="literal">NULL</code> and the
 708 header, <em class="parameter"><code>name</code></em>, had not been previously set, a space will be set
 709 aside for it (useful for setting the order of headers before values
 710 can be obtained for them) otherwise the header will be unset.
 711 </p>
 712 <p>
 713 Note: If there are multiple headers with the specified field name,
 714 the first instance of the header will be replaced and further
 715 instances will be removed.
 716 </p>
 717 <div class="variablelist"><table border="0">
 718 <col align="left" valign="top">
 719 <tbody>
 720 <tr>
 721 <td><p><span class="term"><em class="parameter"><code>headers</code></em> :</span></p></td>
 722 <td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a>
 723 </td>
 724 </tr>
 725 <tr>
 726 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
 727 <td>header name</td>
 728 </tr>
 729 <tr>
 730 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 731 <td>header value</td>
 732 </tr>
 733 </tbody>
 734 </table></div>
 735 </div>
 736 <hr>
 737 <div class="refsect2">
 738 <a name="g-mime-header-list-get"></a><h3>g_mime_header_list_get ()</h3>
 739 <pre class="programlisting">const <span class="returnvalue">char</span> *        g_mime_header_list_get              (<em class="parameter"><code>const <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>,
 740                                                          <em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre>
 741 <p>
 742 Gets the value of the first header with the name requested.
 743 </p>
 744 <div class="variablelist"><table border="0">
 745 <col align="left" valign="top">
 746 <tbody>
 747 <tr>
 748 <td><p><span class="term"><em class="parameter"><code>headers</code></em> :</span></p></td>
 749 <td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a>
 750 </td>
 751 </tr>
 752 <tr>
 753 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
 754 <td>header name</td>
 755 </tr>
 756 <tr>
 757 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 758 <td>the value of the header requested.</td>
 759 </tr>
 760 </tbody>
 761 </table></div>
 762 </div>
 763 <hr>
 764 <div class="refsect2">
 765 <a name="g-mime-header-list-get-iter"></a><h3>g_mime_header_list_get_iter ()</h3>
 766 <pre class="programlisting"><span class="returnvalue">gboolean</span>            g_mime_header_list_get_iter         (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>,
 767                                                          <em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a> *iter</code></em>);</pre>
 768 <p>
 769 Initializes an iterator for traversing <em class="parameter"><code>headers</code></em>.
 770 </p>
 771 <div class="variablelist"><table border="0">
 772 <col align="left" valign="top">
 773 <tbody>
 774 <tr>
 775 <td><p><span class="term"><em class="parameter"><code>headers</code></em> :</span></p></td>
 776 <td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a>
 777 </td>
 778 </tr>
 779 <tr>
 780 <td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
 781 <td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderIter" title="struct GMimeHeaderIter"><span class="type">GMimeHeaderIter</span></a>
 782 </td>
 783 </tr>
 784 <tr>
 785 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 786 <td>a <code class="literal">TRUE</code> if successful or <code class="literal">FALSE</code> if there are no headers to
 787 traverse.</td>
 788 </tr>
 789 </tbody>
 790 </table></div>
 791 </div>
 792 <hr>
 793 <div class="refsect2">
 794 <a name="g-mime-header-list-foreach"></a><h3>g_mime_header_list_foreach ()</h3>
 795 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_header_list_foreach          (<em class="parameter"><code>const <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>,
 796                                                          <em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderForeachFunc" title="GMimeHeaderForeachFunc ()"><span class="type">GMimeHeaderForeachFunc</span></a> func</code></em>,
 797                                                          <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
 798 <p>
 799 Calls <em class="parameter"><code>func</code></em> for each header name/value pair.
 800 </p>
 801 <div class="variablelist"><table border="0">
 802 <col align="left" valign="top">
 803 <tbody>
 804 <tr>
 805 <td><p><span class="term"><em class="parameter"><code>headers</code></em> :</span></p></td>
 806 <td>A <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a>
 807 </td>
 808 </tr>
 809 <tr>
 810 <td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
 811 <td>function to be called for each header.</td>
 812 </tr>
 813 <tr>
 814 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 815 <td>User data to be passed to the func.</td>
 816 </tr>
 817 </tbody>
 818 </table></div>
 819 </div>
 820 <hr>
 821 <div class="refsect2">
 822 <a name="g-mime-header-list-register-writer"></a><h3>g_mime_header_list_register_writer ()</h3>
 823 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_header_list_register_writer  (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>,
 824                                                          <em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
 825                                                          <em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderWriter" title="GMimeHeaderWriter ()"><span class="type">GMimeHeaderWriter</span></a> writer</code></em>);</pre>
 826 <p>
 827 Changes the function used to write <em class="parameter"><code>name</code></em> headers to <em class="parameter"><code>writer</code></em> (or the
 828 default if <em class="parameter"><code>writer</code></em> is <code class="literal">NULL</code>). This is useful if you want to change
 829 the default header folding style for a particular header.
 830 </p>
 831 <div class="variablelist"><table border="0">
 832 <col align="left" valign="top">
 833 <tbody>
 834 <tr>
 835 <td><p><span class="term"><em class="parameter"><code>headers</code></em> :</span></p></td>
 836 <td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a>
 837 </td>
 838 </tr>
 839 <tr>
 840 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
 841 <td>header name</td>
 842 </tr>
 843 <tr>
 844 <td><p><span class="term"><em class="parameter"><code>writer</code></em> :</span></p></td>
 845 <td>writer function</td>
 846 </tr>
 847 </tbody>
 848 </table></div>
 849 </div>
 850 <hr>
 851 <div class="refsect2">
 852 <a name="g-mime-header-list-write-to-stream"></a><h3>g_mime_header_list_write_to_stream ()</h3>
 853 <pre class="programlisting"><span class="returnvalue">ssize_t</span>             g_mime_header_list_write_to_stream  (<em class="parameter"><code>const <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>,
 854                                                          <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>);</pre>
 855 <p>
 856 Write the headers to a stream.
 857 </p>
 858 <div class="variablelist"><table border="0">
 859 <col align="left" valign="top">
 860 <tbody>
 861 <tr>
 862 <td><p><span class="term"><em class="parameter"><code>headers</code></em> :</span></p></td>
 863 <td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a>
 864 </td>
 865 </tr>
 866 <tr>
 867 <td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
 868 <td>output stream</td>
 869 </tr>
 870 <tr>
 871 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 872 <td>the number of bytes written or <code class="literal">-1</code> on fail.</td>
 873 </tr>
 874 </tbody>
 875 </table></div>
 876 </div>
 877 <hr>
 878 <div class="refsect2">
 879 <a name="g-mime-header-list-to-string"></a><h3>g_mime_header_list_to_string ()</h3>
 880 <pre class="programlisting"><span class="returnvalue">char</span> *              g_mime_header_list_to_string        (<em class="parameter"><code>const <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>);</pre>
 881 <p>
 882 Allocates a string buffer containing the raw rfc822 headers
 883 contained in <em class="parameter"><code>headers</code></em>.
 884 </p>
 885 <div class="variablelist"><table border="0">
 886 <col align="left" valign="top">
 887 <tbody>
 888 <tr>
 889 <td><p><span class="term"><em class="parameter"><code>headers</code></em> :</span></p></td>
 890 <td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a>
 891 </td>
 892 </tr>
 893 <tr>
 894 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 895 <td>a string containing the header block.</td>
 896 </tr>
 897 </tbody>
 898 </table></div>
 899 </div>
 900 <hr>
 901 <div class="refsect2">
 902 <a name="g-mime-header-list-get-stream"></a><h3>g_mime_header_list_get_stream ()</h3>
 903 <pre class="programlisting"><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> *       g_mime_header_list_get_stream       (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>);</pre>
 904 <p>
 905 Gets the raw stream representing <em class="parameter"><code>headers</code></em>.
 906 </p>
 907 <div class="variablelist"><table border="0">
 908 <col align="left" valign="top">
 909 <tbody>
 910 <tr>
 911 <td><p><span class="term"><em class="parameter"><code>headers</code></em> :</span></p></td>
 912 <td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a>
 913 </td>
 914 </tr>
 915 <tr>
 916 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 917 <td>a <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> if set or <code class="literal">NULL</code> otherwise.</td>
 918 </tr>
 919 </tbody>
 920 </table></div>
 921 </div>
 922 <hr>
 923 <div class="refsect2">
 924 <a name="g-mime-header-list-set-stream"></a><h3>g_mime_header_list_set_stream ()</h3>
 925 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_header_list_set_stream       (<em class="parameter"><code><a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a> *headers</code></em>,
 926                                                          <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>);</pre>
 927 <p>
 928 Set the raw header stream.
 929 </p>
 930 <div class="variablelist"><table border="0">
 931 <col align="left" valign="top">
 932 <tbody>
 933 <tr>
 934 <td><p><span class="term"><em class="parameter"><code>headers</code></em> :</span></p></td>
 935 <td>a <a class="link" href="gmime-GMimeHeader.html#GMimeHeaderList" title="GMimeHeaderList"><span class="type">GMimeHeaderList</span></a>
 936 </td>
 937 </tr>
 938 <tr>
 939 <td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
 940 <td>a <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a>
 941 </td>
 942 </tr>
 943 </tbody>
 944 </table></div>
 945 </div>
 946 </div>
 947 <div class="refsect1">
 948 <a name="gmime-GMimeHeader.see-also"></a><h2>See Also</h2>
 949 <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a>
 950 </div>
 951 </div>
 952 <div class="footer">
 953 <hr>
 954           Generated by GTK-Doc V1.18</div>
 955 </body>
 956 </html>