docs/reference/html/GMimeMessage.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>GMimeMessage</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GMime 2.6 Reference Manual">
   8 <link rel="up" href="MimeParts.html" title="MIME Messages and Parts">
   9 <link rel="prev" href="GMimeObject.html" title="GMimeObject">
  10 <link rel="next" href="GMimePart.html" title="GMimePart">
  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="GMimeObject.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="MimeParts.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GMime 2.6 Reference Manual</th>
  21 <td><a accesskey="n" href="GMimePart.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="#GMimeMessage.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#GMimeMessage.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#GMimeMessage.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry">
  32 <a name="GMimeMessage"></a><div class="titlepage"></div>
  33 <div class="refnamediv"><table width="100%"><tr>
  34 <td valign="top">
  35 <h2><span class="refentrytitle"><a name="GMimeMessage.top_of_page"></a>GMimeMessage</span></h2>
  36 <p>GMimeMessage — Messages</p>
  37 </td>
  38 <td valign="top" align="right"></td>
  39 </tr></table></div>
  40 <div class="refsynopsisdiv">
  41 <a name="GMimeMessage.synopsis"></a><h2>Synopsis</h2>
  42 <pre class="synopsis">enum                <a class="link" href="GMimeMessage.html#GMimeRecipientType" title="enum GMimeRecipientType">GMimeRecipientType</a>;
  43 struct              <a class="link" href="GMimeMessage.html#GMimeMessage-struct" title="struct GMimeMessage">GMimeMessage</a>;
  44 <a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="returnvalue">GMimeMessage</span></a> *      <a class="link" href="GMimeMessage.html#g-mime-message-new" title="g_mime_message_new ()">g_mime_message_new</a>                  (<em class="parameter"><code><span class="type">gboolean</span> pretty_headers</code></em>);
  45 <span class="returnvalue">void</span>                <a class="link" href="GMimeMessage.html#g-mime-message-set-sender" title="g_mime_message_set_sender ()">g_mime_message_set_sender</a>           (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>,
  46                                                          <em class="parameter"><code>const <span class="type">char</span> *sender</code></em>);
  47 const <span class="returnvalue">char</span> *        <a class="link" href="GMimeMessage.html#g-mime-message-get-sender" title="g_mime_message_get_sender ()">g_mime_message_get_sender</a>           (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>);
  48 <span class="returnvalue">void</span>                <a class="link" href="GMimeMessage.html#g-mime-message-set-reply-to" title="g_mime_message_set_reply_to ()">g_mime_message_set_reply_to</a>         (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>,
  49                                                          <em class="parameter"><code>const <span class="type">char</span> *reply_to</code></em>);
  50 const <span class="returnvalue">char</span> *        <a class="link" href="GMimeMessage.html#g-mime-message-get-reply-to" title="g_mime_message_get_reply_to ()">g_mime_message_get_reply_to</a>         (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>);
  51 <span class="returnvalue">void</span>                <a class="link" href="GMimeMessage.html#g-mime-message-add-recipient" title="g_mime_message_add_recipient ()">g_mime_message_add_recipient</a>        (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>,
  52                                                          <em class="parameter"><code><a class="link" href="GMimeMessage.html#GMimeRecipientType" title="enum GMimeRecipientType"><span class="type">GMimeRecipientType</span></a> type</code></em>,
  53                                                          <em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
  54                                                          <em class="parameter"><code>const <span class="type">char</span> *addr</code></em>);
  55 <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="returnvalue">InternetAddressList</span></a> * <a class="link" href="GMimeMessage.html#g-mime-message-get-recipients" title="g_mime_message_get_recipients ()">g_mime_message_get_recipients</a>     (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>,
  56                                                          <em class="parameter"><code><a class="link" href="GMimeMessage.html#GMimeRecipientType" title="enum GMimeRecipientType"><span class="type">GMimeRecipientType</span></a> type</code></em>);
  57 <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="returnvalue">InternetAddressList</span></a> * <a class="link" href="GMimeMessage.html#g-mime-message-get-all-recipients" title="g_mime_message_get_all_recipients ()">g_mime_message_get_all_recipients</a> (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>);
  58 <span class="returnvalue">void</span>                <a class="link" href="GMimeMessage.html#g-mime-message-set-subject" title="g_mime_message_set_subject ()">g_mime_message_set_subject</a>          (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>,
  59                                                          <em class="parameter"><code>const <span class="type">char</span> *subject</code></em>);
  60 const <span class="returnvalue">char</span> *        <a class="link" href="GMimeMessage.html#g-mime-message-get-subject" title="g_mime_message_get_subject ()">g_mime_message_get_subject</a>          (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>);
  61 <span class="returnvalue">void</span>                <a class="link" href="GMimeMessage.html#g-mime-message-set-date" title="g_mime_message_set_date ()">g_mime_message_set_date</a>             (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>,
  62                                                          <em class="parameter"><code><span class="type">time_t</span> date</code></em>,
  63                                                          <em class="parameter"><code><span class="type">int</span> tz_offset</code></em>);
  64 <span class="returnvalue">void</span>                <a class="link" href="GMimeMessage.html#g-mime-message-get-date" title="g_mime_message_get_date ()">g_mime_message_get_date</a>             (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>,
  65                                                          <em class="parameter"><code><span class="type">time_t</span> *date</code></em>,
  66                                                          <em class="parameter"><code><span class="type">int</span> *tz_offset</code></em>);
  67 <span class="returnvalue">void</span>                <a class="link" href="GMimeMessage.html#g-mime-message-set-date-as-string" title="g_mime_message_set_date_as_string ()">g_mime_message_set_date_as_string</a>   (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>,
  68                                                          <em class="parameter"><code>const <span class="type">char</span> *str</code></em>);
  69 <span class="returnvalue">char</span> *              <a class="link" href="GMimeMessage.html#g-mime-message-get-date-as-string" title="g_mime_message_get_date_as_string ()">g_mime_message_get_date_as_string</a>   (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>);
  70 <span class="returnvalue">void</span>                <a class="link" href="GMimeMessage.html#g-mime-message-set-message-id" title="g_mime_message_set_message_id ()">g_mime_message_set_message_id</a>       (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>,
  71                                                          <em class="parameter"><code>const <span class="type">char</span> *message_id</code></em>);
  72 const <span class="returnvalue">char</span> *        <a class="link" href="GMimeMessage.html#g-mime-message-get-message-id" title="g_mime_message_get_message_id ()">g_mime_message_get_message_id</a>       (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>);
  73 <span class="returnvalue">void</span>                <a class="link" href="GMimeMessage.html#g-mime-message-set-mime-part" title="g_mime_message_set_mime_part ()">g_mime_message_set_mime_part</a>        (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>,
  74                                                          <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *mime_part</code></em>);
  75 <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> *       <a class="link" href="GMimeMessage.html#g-mime-message-get-mime-part" title="g_mime_message_get_mime_part ()">g_mime_message_get_mime_part</a>        (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>);
  76 <span class="returnvalue">void</span>                <a class="link" href="GMimeMessage.html#g-mime-message-foreach" title="g_mime_message_foreach ()">g_mime_message_foreach</a>              (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>,
  77                                                          <em class="parameter"><code><a class="link" href="GMimeObject.html#GMimeObjectForeachFunc" title="GMimeObjectForeachFunc ()"><span class="type">GMimeObjectForeachFunc</span></a> callback</code></em>,
  78                                                          <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
  79 <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> *       <a class="link" href="GMimeMessage.html#g-mime-message-get-body" title="g_mime_message_get_body ()">g_mime_message_get_body</a>             (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>);
  80 </pre>
  81 </div>
  82 <div class="refsect1">
  83 <a name="GMimeMessage.object-hierarchy"></a><h2>Object Hierarchy</h2>
  84 <pre class="synopsis">
  85   GObject
  86    +----<a class="link" href="GMimeObject.html" title="GMimeObject">GMimeObject</a>
  87          +----GMimeMessage
  88 </pre>
  89 </div>
  90 <div class="refsect1">
  91 <a name="GMimeMessage.description"></a><h2>Description</h2>
  92 <p>
  93 A <a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> represents an rfc822 message.
  94 </p>
  95 </div>
  96 <div class="refsect1">
  97 <a name="GMimeMessage.details"></a><h2>Details</h2>
  98 <div class="refsect2">
  99 <a name="GMimeRecipientType"></a><h3>enum GMimeRecipientType</h3>
 100 <pre class="programlisting">typedef enum {
 101         GMIME_RECIPIENT_TYPE_TO,
 102         GMIME_RECIPIENT_TYPE_CC,
 103         GMIME_RECIPIENT_TYPE_BCC
 104 } GMimeRecipientType;
 105 </pre>
 106 <p>
 107 A message recipient type.
 108 </p>
 109 <div class="variablelist"><table border="0">
 110 <col align="left" valign="top">
 111 <tbody>
 112 <tr>
 113 <td><p><a name="GMIME-RECIPIENT-TYPE-TO:CAPS"></a><span class="term"><code class="literal">GMIME_RECIPIENT_TYPE_TO</code></span></p></td>
 114 <td>Represents the recipients in the To: header.
 115 </td>
 116 </tr>
 117 <tr>
 118 <td><p><a name="GMIME-RECIPIENT-TYPE-CC:CAPS"></a><span class="term"><code class="literal">GMIME_RECIPIENT_TYPE_CC</code></span></p></td>
 119 <td>Represents the recipients in the Cc: header.
 120 </td>
 121 </tr>
 122 <tr>
 123 <td><p><a name="GMIME-RECIPIENT-TYPE-BCC:CAPS"></a><span class="term"><code class="literal">GMIME_RECIPIENT_TYPE_BCC</code></span></p></td>
 124 <td>Represents the recipients in the Bcc: header.
 125 </td>
 126 </tr>
 127 </tbody>
 128 </table></div>
 129 </div>
 130 <hr>
 131 <div class="refsect2">
 132 <a name="GMimeMessage-struct"></a><h3>struct GMimeMessage</h3>
 133 <pre class="programlisting">struct GMimeMessage;</pre>
 134 <p>
 135 A MIME Message object.
 136 </p>
 137 <div class="variablelist"><table border="0">
 138 <col align="left" valign="top">
 139 <tbody></tbody>
 140 </table></div>
 141 </div>
 142 <hr>
 143 <div class="refsect2">
 144 <a name="g-mime-message-new"></a><h3>g_mime_message_new ()</h3>
 145 <pre class="programlisting"><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="returnvalue">GMimeMessage</span></a> *      g_mime_message_new                  (<em class="parameter"><code><span class="type">gboolean</span> pretty_headers</code></em>);</pre>
 146 <p>
 147 If <em class="parameter"><code>pretty_headers</code></em> is <code class="literal">TRUE</code>, then the standard rfc822 headers are
 148 initialized so as to put headers in a nice friendly order. This is
 149 strictly a cosmetic thing, so if you are unsure, it is safe to say
 150 no (<code class="literal">FALSE</code>).
 151 </p>
 152 <div class="variablelist"><table border="0">
 153 <col align="left" valign="top">
 154 <tbody>
 155 <tr>
 156 <td><p><span class="term"><em class="parameter"><code>pretty_headers</code></em> :</span></p></td>
 157 <td>make pretty headers</td>
 158 </tr>
 159 <tr>
 160 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 161 <td>an empty <a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> object.</td>
 162 </tr>
 163 </tbody>
 164 </table></div>
 165 </div>
 166 <hr>
 167 <div class="refsect2">
 168 <a name="g-mime-message-set-sender"></a><h3>g_mime_message_set_sender ()</h3>
 169 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_message_set_sender           (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>,
 170                                                          <em class="parameter"><code>const <span class="type">char</span> *sender</code></em>);</pre>
 171 <p>
 172 Set the sender's name and address on the MIME Message.
 173 (ex: "\"Joe Sixpack\" &lt;joe<em class="parameter"><code>sixpack.org</code></em>&gt;")
 174 </p>
 175 <div class="variablelist"><table border="0">
 176 <col align="left" valign="top">
 177 <tbody>
 178 <tr>
 179 <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
 180 <td>MIME Message to change</td>
 181 </tr>
 182 <tr>
 183 <td><p><span class="term"><em class="parameter"><code>sender</code></em> :</span></p></td>
 184 <td>The name and address of the sender</td>
 185 </tr>
 186 </tbody>
 187 </table></div>
 188 </div>
 189 <hr>
 190 <div class="refsect2">
 191 <a name="g-mime-message-get-sender"></a><h3>g_mime_message_get_sender ()</h3>
 192 <pre class="programlisting">const <span class="returnvalue">char</span> *        g_mime_message_get_sender           (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>);</pre>
 193 <p>
 194 Gets the email address of the sender from <em class="parameter"><code>message</code></em>.
 195 </p>
 196 <div class="variablelist"><table border="0">
 197 <col align="left" valign="top">
 198 <tbody>
 199 <tr>
 200 <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
 201 <td>MIME Message</td>
 202 </tr>
 203 <tr>
 204 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 205 <td>the sender's name and address of the MIME Message.</td>
 206 </tr>
 207 </tbody>
 208 </table></div>
 209 </div>
 210 <hr>
 211 <div class="refsect2">
 212 <a name="g-mime-message-set-reply-to"></a><h3>g_mime_message_set_reply_to ()</h3>
 213 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_message_set_reply_to         (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>,
 214                                                          <em class="parameter"><code>const <span class="type">char</span> *reply_to</code></em>);</pre>
 215 <p>
 216 Set the sender's Reply-To address on the MIME Message.
 217 </p>
 218 <div class="variablelist"><table border="0">
 219 <col align="left" valign="top">
 220 <tbody>
 221 <tr>
 222 <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
 223 <td>MIME Message to change</td>
 224 </tr>
 225 <tr>
 226 <td><p><span class="term"><em class="parameter"><code>reply_to</code></em> :</span></p></td>
 227 <td>The Reply-To address</td>
 228 </tr>
 229 </tbody>
 230 </table></div>
 231 </div>
 232 <hr>
 233 <div class="refsect2">
 234 <a name="g-mime-message-get-reply-to"></a><h3>g_mime_message_get_reply_to ()</h3>
 235 <pre class="programlisting">const <span class="returnvalue">char</span> *        g_mime_message_get_reply_to         (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>);</pre>
 236 <p>
 237 Gets the Reply-To address from <em class="parameter"><code>message</code></em>.
 238 </p>
 239 <div class="variablelist"><table border="0">
 240 <col align="left" valign="top">
 241 <tbody>
 242 <tr>
 243 <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
 244 <td>MIME Message</td>
 245 </tr>
 246 <tr>
 247 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 248 <td>the sender's Reply-To address from the MIME Message.</td>
 249 </tr>
 250 </tbody>
 251 </table></div>
 252 </div>
 253 <hr>
 254 <div class="refsect2">
 255 <a name="g-mime-message-add-recipient"></a><h3>g_mime_message_add_recipient ()</h3>
 256 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_message_add_recipient        (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>,
 257                                                          <em class="parameter"><code><a class="link" href="GMimeMessage.html#GMimeRecipientType" title="enum GMimeRecipientType"><span class="type">GMimeRecipientType</span></a> type</code></em>,
 258                                                          <em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
 259                                                          <em class="parameter"><code>const <span class="type">char</span> *addr</code></em>);</pre>
 260 <p>
 261 Add a recipient of a chosen type to the MIME Message.
 262 </p>
 263 <div class="variablelist"><table border="0">
 264 <col align="left" valign="top">
 265 <tbody>
 266 <tr>
 267 <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
 268 <td>MIME Message to change</td>
 269 </tr>
 270 <tr>
 271 <td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
 272 <td>A <a class="link" href="GMimeMessage.html#GMimeRecipientType" title="enum GMimeRecipientType"><span class="type">GMimeRecipientType</span></a>
 273 </td>
 274 </tr>
 275 <tr>
 276 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
 277 <td>The recipient's name (or <code class="literal">NULL</code>)</td>
 278 </tr>
 279 <tr>
 280 <td><p><span class="term"><em class="parameter"><code>addr</code></em> :</span></p></td>
 281 <td>The recipient's address</td>
 282 </tr>
 283 </tbody>
 284 </table></div>
 285 </div>
 286 <hr>
 287 <div class="refsect2">
 288 <a name="g-mime-message-get-recipients"></a><h3>g_mime_message_get_recipients ()</h3>
 289 <pre class="programlisting"><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="returnvalue">InternetAddressList</span></a> * g_mime_message_get_recipients     (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>,
 290                                                          <em class="parameter"><code><a class="link" href="GMimeMessage.html#GMimeRecipientType" title="enum GMimeRecipientType"><span class="type">GMimeRecipientType</span></a> type</code></em>);</pre>
 291 <p>
 292 Gets a list of recipients of type <em class="parameter"><code>type</code></em> from <em class="parameter"><code>message</code></em>.
 293 </p>
 294 <div class="variablelist"><table border="0">
 295 <col align="left" valign="top">
 296 <tbody>
 297 <tr>
 298 <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
 299 <td>MIME Message</td>
 300 </tr>
 301 <tr>
 302 <td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
 303 <td>A <a class="link" href="GMimeMessage.html#GMimeRecipientType" title="enum GMimeRecipientType"><span class="type">GMimeRecipientType</span></a>
 304 </td>
 305 </tr>
 306 <tr>
 307 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 308 <td>a list of recipients of a chosen type from the MIME
 309 Message.</td>
 310 </tr>
 311 </tbody>
 312 </table></div>
 313 </div>
 314 <hr>
 315 <div class="refsect2">
 316 <a name="g-mime-message-get-all-recipients"></a><h3>g_mime_message_get_all_recipients ()</h3>
 317 <pre class="programlisting"><a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="returnvalue">InternetAddressList</span></a> * g_mime_message_get_all_recipients (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>);</pre>
 318 <p>
 319 Gets the complete list of recipients for <em class="parameter"><code>message</code></em>.
 320 </p>
 321 <div class="variablelist"><table border="0">
 322 <col align="left" valign="top">
 323 <tbody>
 324 <tr>
 325 <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
 326 <td>MIME Message</td>
 327 </tr>
 328 <tr>
 329 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 330 <td>a newly allocated <a class="link" href="InternetAddressList.html" title="InternetAddressList"><span class="type">InternetAddressList</span></a> containing all
 331 recipients of the message or <code class="literal">NULL</code> if no recipients are set.</td>
 332 </tr>
 333 </tbody>
 334 </table></div>
 335 </div>
 336 <hr>
 337 <div class="refsect2">
 338 <a name="g-mime-message-set-subject"></a><h3>g_mime_message_set_subject ()</h3>
 339 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_message_set_subject          (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>,
 340                                                          <em class="parameter"><code>const <span class="type">char</span> *subject</code></em>);</pre>
 341 <p>
 342 Set the unencoded UTF-8 Subject field on a MIME Message.
 343 </p>
 344 <div class="variablelist"><table border="0">
 345 <col align="left" valign="top">
 346 <tbody>
 347 <tr>
 348 <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
 349 <td>MIME Message</td>
 350 </tr>
 351 <tr>
 352 <td><p><span class="term"><em class="parameter"><code>subject</code></em> :</span></p></td>
 353 <td>Subject string</td>
 354 </tr>
 355 </tbody>
 356 </table></div>
 357 </div>
 358 <hr>
 359 <div class="refsect2">
 360 <a name="g-mime-message-get-subject"></a><h3>g_mime_message_get_subject ()</h3>
 361 <pre class="programlisting">const <span class="returnvalue">char</span> *        g_mime_message_get_subject          (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>);</pre>
 362 <p>
 363 Gets the message's subject.
 364 </p>
 365 <div class="variablelist"><table border="0">
 366 <col align="left" valign="top">
 367 <tbody>
 368 <tr>
 369 <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
 370 <td>MIME Message</td>
 371 </tr>
 372 <tr>
 373 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 374 <td>the unencoded UTF-8 Subject field on a MIME Message.</td>
 375 </tr>
 376 </tbody>
 377 </table></div>
 378 </div>
 379 <hr>
 380 <div class="refsect2">
 381 <a name="g-mime-message-set-date"></a><h3>g_mime_message_set_date ()</h3>
 382 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_message_set_date             (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>,
 383                                                          <em class="parameter"><code><span class="type">time_t</span> date</code></em>,
 384                                                          <em class="parameter"><code><span class="type">int</span> tz_offset</code></em>);</pre>
 385 <p>
 386 Sets the Date header on a MIME Message.
 387 </p>
 388 <div class="variablelist"><table border="0">
 389 <col align="left" valign="top">
 390 <tbody>
 391 <tr>
 392 <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
 393 <td>MIME Message</td>
 394 </tr>
 395 <tr>
 396 <td><p><span class="term"><em class="parameter"><code>date</code></em> :</span></p></td>
 397 <td>a date to be used in the Date header</td>
 398 </tr>
 399 <tr>
 400 <td><p><span class="term"><em class="parameter"><code>tz_offset</code></em> :</span></p></td>
 401 <td>timezone offset (in +/- hours)</td>
 402 </tr>
 403 </tbody>
 404 </table></div>
 405 </div>
 406 <hr>
 407 <div class="refsect2">
 408 <a name="g-mime-message-get-date"></a><h3>g_mime_message_get_date ()</h3>
 409 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_message_get_date             (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>,
 410                                                          <em class="parameter"><code><span class="type">time_t</span> *date</code></em>,
 411                                                          <em class="parameter"><code><span class="type">int</span> *tz_offset</code></em>);</pre>
 412 <p>
 413 Stores the date in time_t format in <em class="parameter"><code>date</code></em>. If <em class="parameter"><code>tz_offset</code></em> is
 414 non-<code class="literal">NULL</code>, then the timezone offset in will be stored in
 415 <em class="parameter"><code>tz_offset</code></em>.
 416 </p>
 417 <div class="variablelist"><table border="0">
 418 <col align="left" valign="top">
 419 <tbody>
 420 <tr>
 421 <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
 422 <td>MIME Message</td>
 423 </tr>
 424 <tr>
 425 <td><p><span class="term"><em class="parameter"><code>date</code></em> :</span></p></td>
 426 <td>pointer to a date in time_t</td>
 427 </tr>
 428 <tr>
 429 <td><p><span class="term"><em class="parameter"><code>tz_offset</code></em> :</span></p></td>
 430 <td>pointer to timezone offset (in +/- hours)</td>
 431 </tr>
 432 </tbody>
 433 </table></div>
 434 </div>
 435 <hr>
 436 <div class="refsect2">
 437 <a name="g-mime-message-set-date-as-string"></a><h3>g_mime_message_set_date_as_string ()</h3>
 438 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_message_set_date_as_string   (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>,
 439                                                          <em class="parameter"><code>const <span class="type">char</span> *str</code></em>);</pre>
 440 <p>
 441 Sets the sent-date of the message.
 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>message</code></em> :</span></p></td>
 448 <td>MIME Message</td>
 449 </tr>
 450 <tr>
 451 <td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
 452 <td>a date string</td>
 453 </tr>
 454 </tbody>
 455 </table></div>
 456 </div>
 457 <hr>
 458 <div class="refsect2">
 459 <a name="g-mime-message-get-date-as-string"></a><h3>g_mime_message_get_date_as_string ()</h3>
 460 <pre class="programlisting"><span class="returnvalue">char</span> *              g_mime_message_get_date_as_string   (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>);</pre>
 461 <p>
 462 Gets the message's sent-date in string format.
 463 </p>
 464 <div class="variablelist"><table border="0">
 465 <col align="left" valign="top">
 466 <tbody>
 467 <tr>
 468 <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
 469 <td>MIME Message</td>
 470 </tr>
 471 <tr>
 472 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 473 <td>a newly allocated string containing the Date header value.</td>
 474 </tr>
 475 </tbody>
 476 </table></div>
 477 </div>
 478 <hr>
 479 <div class="refsect2">
 480 <a name="g-mime-message-set-message-id"></a><h3>g_mime_message_set_message_id ()</h3>
 481 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_message_set_message_id       (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>,
 482                                                          <em class="parameter"><code>const <span class="type">char</span> *message_id</code></em>);</pre>
 483 <p>
 484 Set the Message-Id on a message.
 485 </p>
 486 <div class="variablelist"><table border="0">
 487 <col align="left" valign="top">
 488 <tbody>
 489 <tr>
 490 <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
 491 <td>MIME Message</td>
 492 </tr>
 493 <tr>
 494 <td><p><span class="term"><em class="parameter"><code>message_id</code></em> :</span></p></td>
 495 <td>message-id (addr-spec portion)</td>
 496 </tr>
 497 </tbody>
 498 </table></div>
 499 </div>
 500 <hr>
 501 <div class="refsect2">
 502 <a name="g-mime-message-get-message-id"></a><h3>g_mime_message_get_message_id ()</h3>
 503 <pre class="programlisting">const <span class="returnvalue">char</span> *        g_mime_message_get_message_id       (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>);</pre>
 504 <p>
 505 Gets the Message-Id header of <em class="parameter"><code>message</code></em>.
 506 </p>
 507 <div class="variablelist"><table border="0">
 508 <col align="left" valign="top">
 509 <tbody>
 510 <tr>
 511 <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
 512 <td>MIME Message</td>
 513 </tr>
 514 <tr>
 515 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 516 <td>the Message-Id of a message.</td>
 517 </tr>
 518 </tbody>
 519 </table></div>
 520 </div>
 521 <hr>
 522 <div class="refsect2">
 523 <a name="g-mime-message-set-mime-part"></a><h3>g_mime_message_set_mime_part ()</h3>
 524 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_message_set_mime_part        (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>,
 525                                                          <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *mime_part</code></em>);</pre>
 526 <p>
 527 Set the root-level MIME part of the message.
 528 </p>
 529 <div class="variablelist"><table border="0">
 530 <col align="left" valign="top">
 531 <tbody>
 532 <tr>
 533 <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
 534 <td>MIME Message</td>
 535 </tr>
 536 <tr>
 537 <td><p><span class="term"><em class="parameter"><code>mime_part</code></em> :</span></p></td>
 538 <td>The root-level MIME Part</td>
 539 </tr>
 540 </tbody>
 541 </table></div>
 542 </div>
 543 <hr>
 544 <div class="refsect2">
 545 <a name="g-mime-message-get-mime-part"></a><h3>g_mime_message_get_mime_part ()</h3>
 546 <pre class="programlisting"><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> *       g_mime_message_get_mime_part        (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>);</pre>
 547 <p>
 548 Gets the toplevel MIME part contained within <em class="parameter"><code>message</code></em>.
 549 </p>
 550 <div class="variablelist"><table border="0">
 551 <col align="left" valign="top">
 552 <tbody>
 553 <tr>
 554 <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
 555 <td>MIME Message</td>
 556 </tr>
 557 <tr>
 558 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 559 <td>the toplevel MIME part of <em class="parameter"><code>message</code></em>.</td>
 560 </tr>
 561 </tbody>
 562 </table></div>
 563 </div>
 564 <hr>
 565 <div class="refsect2">
 566 <a name="g-mime-message-foreach"></a><h3>g_mime_message_foreach ()</h3>
 567 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_message_foreach              (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>,
 568                                                          <em class="parameter"><code><a class="link" href="GMimeObject.html#GMimeObjectForeachFunc" title="GMimeObjectForeachFunc ()"><span class="type">GMimeObjectForeachFunc</span></a> callback</code></em>,
 569                                                          <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
 570 <p>
 571 Recursively calls <em class="parameter"><code>callback</code></em> on each of the mime parts in the mime message.
 572 </p>
 573 <div class="variablelist"><table border="0">
 574 <col align="left" valign="top">
 575 <tbody>
 576 <tr>
 577 <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
 578 <td>a <a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a>
 579 </td>
 580 </tr>
 581 <tr>
 582 <td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
 583 <td>function to call on each of the mime parts contained by the mime message</td>
 584 </tr>
 585 <tr>
 586 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 587 <td>user-supplied callback data</td>
 588 </tr>
 589 </tbody>
 590 </table></div>
 591 </div>
 592 <hr>
 593 <div class="refsect2">
 594 <a name="g-mime-message-get-body"></a><h3>g_mime_message_get_body ()</h3>
 595 <pre class="programlisting"><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> *       g_mime_message_get_body             (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>);</pre>
 596 <p>
 597 Attempts to identify the MIME part containing the body of the
 598 message.
 599 </p>
 600 <div class="variablelist"><table border="0">
 601 <col align="left" valign="top">
 602 <tbody>
 603 <tr>
 604 <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
 605 <td>MIME Message</td>
 606 </tr>
 607 <tr>
 608 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 609 <td>a <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> containing the textual content that appears
 610 to be the main body of the message.
 611 Note: This function is NOT guarenteed to always work as it
 612 makes some assumptions that are not necessarily true. It is
 613 recommended that you traverse the MIME structure yourself.</td>
 614 </tr>
 615 </tbody>
 616 </table></div>
 617 </div>
 618 </div>
 619 </div>
 620 <div class="footer">
 621 <hr>
 622           Generated by GTK-Doc V1.18</div>
 623 </body>
 624 </html>