docs/reference/html/GMimeMessagePartial.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>GMimeMessagePartial</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="GMimeMessagePart.html" title="GMimeMessagePart">
  10 <link rel="next" href="gmime-GMimePartIter.html" title="GMimePartIter">
  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="GMimeMessagePart.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="gmime-GMimePartIter.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="#GMimeMessagePartial.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#GMimeMessagePartial.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#GMimeMessagePartial.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry">
  32 <a name="GMimeMessagePartial"></a><div class="titlepage"></div>
  33 <div class="refnamediv"><table width="100%"><tr>
  34 <td valign="top">
  35 <h2><span class="refentrytitle"><a name="GMimeMessagePartial.top_of_page"></a>GMimeMessagePartial</span></h2>
  36 <p>GMimeMessagePartial — Partial MIME parts</p>
  37 </td>
  38 <td valign="top" align="right"></td>
  39 </tr></table></div>
  40 <div class="refsynopsisdiv">
  41 <a name="GMimeMessagePartial.synopsis"></a><h2>Synopsis</h2>
  42 <pre class="synopsis">struct              <a class="link" href="GMimeMessagePartial.html#GMimeMessagePartial-struct" title="struct GMimeMessagePartial">GMimeMessagePartial</a>;
  43 <a class="link" href="GMimeMessagePartial.html" title="GMimeMessagePartial"><span class="returnvalue">GMimeMessagePartial</span></a> * <a class="link" href="GMimeMessagePartial.html#g-mime-message-partial-new" title="g_mime_message_partial_new ()">g_mime_message_partial_new</a>        (<em class="parameter"><code>const <span class="type">char</span> *id</code></em>,
  44                                                          <em class="parameter"><code><span class="type">int</span> number</code></em>,
  45                                                          <em class="parameter"><code><span class="type">int</span> total</code></em>);
  46 const <span class="returnvalue">char</span> *        <a class="link" href="GMimeMessagePartial.html#g-mime-message-partial-get-id" title="g_mime_message_partial_get_id ()">g_mime_message_partial_get_id</a>       (<em class="parameter"><code><a class="link" href="GMimeMessagePartial.html" title="GMimeMessagePartial"><span class="type">GMimeMessagePartial</span></a> *partial</code></em>);
  47 <span class="returnvalue">int</span>                 <a class="link" href="GMimeMessagePartial.html#g-mime-message-partial-get-number" title="g_mime_message_partial_get_number ()">g_mime_message_partial_get_number</a>   (<em class="parameter"><code><a class="link" href="GMimeMessagePartial.html" title="GMimeMessagePartial"><span class="type">GMimeMessagePartial</span></a> *partial</code></em>);
  48 <span class="returnvalue">int</span>                 <a class="link" href="GMimeMessagePartial.html#g-mime-message-partial-get-total" title="g_mime_message_partial_get_total ()">g_mime_message_partial_get_total</a>    (<em class="parameter"><code><a class="link" href="GMimeMessagePartial.html" title="GMimeMessagePartial"><span class="type">GMimeMessagePartial</span></a> *partial</code></em>);
  49 <a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="returnvalue">GMimeMessage</span></a> *      <a class="link" href="GMimeMessagePartial.html#g-mime-message-partial-reconstruct-message" title="g_mime_message_partial_reconstruct_message ()">g_mime_message_partial_reconstruct_message</a>
  50                                                         (<em class="parameter"><code><a class="link" href="GMimeMessagePartial.html" title="GMimeMessagePartial"><span class="type">GMimeMessagePartial</span></a> **partials</code></em>,
  51                                                          <em class="parameter"><code><span class="type">size_t</span> num</code></em>);
  52 <a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="returnvalue">GMimeMessage</span></a> **     <a class="link" href="GMimeMessagePartial.html#g-mime-message-partial-split-message" title="g_mime_message_partial_split_message ()">g_mime_message_partial_split_message</a>
  53                                                         (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>,
  54                                                          <em class="parameter"><code><span class="type">size_t</span> max_size</code></em>,
  55                                                          <em class="parameter"><code><span class="type">size_t</span> *nparts</code></em>);
  56 </pre>
  57 </div>
  58 <div class="refsect1">
  59 <a name="GMimeMessagePartial.object-hierarchy"></a><h2>Object Hierarchy</h2>
  60 <pre class="synopsis">
  61   GObject
  62    +----<a class="link" href="GMimeObject.html" title="GMimeObject">GMimeObject</a>
  63          +----<a class="link" href="GMimePart.html" title="GMimePart">GMimePart</a>
  64                +----GMimeMessagePartial
  65 </pre>
  66 </div>
  67 <div class="refsect1">
  68 <a name="GMimeMessagePartial.description"></a><h2>Description</h2>
  69 <p>
  70 A <a class="link" href="GMimeMessagePartial.html" title="GMimeMessagePartial"><span class="type">GMimeMessagePartial</span></a> represents the message/partial MIME part.
  71 </p>
  72 </div>
  73 <div class="refsect1">
  74 <a name="GMimeMessagePartial.details"></a><h2>Details</h2>
  75 <div class="refsect2">
  76 <a name="GMimeMessagePartial-struct"></a><h3>struct GMimeMessagePartial</h3>
  77 <pre class="programlisting">struct GMimeMessagePartial;</pre>
  78 <p>
  79 A message/partial MIME part.
  80 </p>
  81 <div class="variablelist"><table border="0">
  82 <col align="left" valign="top">
  83 <tbody></tbody>
  84 </table></div>
  85 </div>
  86 <hr>
  87 <div class="refsect2">
  88 <a name="g-mime-message-partial-new"></a><h3>g_mime_message_partial_new ()</h3>
  89 <pre class="programlisting"><a class="link" href="GMimeMessagePartial.html" title="GMimeMessagePartial"><span class="returnvalue">GMimeMessagePartial</span></a> * g_mime_message_partial_new        (<em class="parameter"><code>const <span class="type">char</span> *id</code></em>,
  90                                                          <em class="parameter"><code><span class="type">int</span> number</code></em>,
  91                                                          <em class="parameter"><code><span class="type">int</span> total</code></em>);</pre>
  92 <p>
  93 Creates a new MIME message/partial object.
  94 </p>
  95 <div class="variablelist"><table border="0">
  96 <col align="left" valign="top">
  97 <tbody>
  98 <tr>
  99 <td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
 100 <td>message/partial part id</td>
 101 </tr>
 102 <tr>
 103 <td><p><span class="term"><em class="parameter"><code>number</code></em> :</span></p></td>
 104 <td>message/partial part number</td>
 105 </tr>
 106 <tr>
 107 <td><p><span class="term"><em class="parameter"><code>total</code></em> :</span></p></td>
 108 <td>total number of message/partial parts</td>
 109 </tr>
 110 <tr>
 111 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 112 <td>an empty MIME message/partial object.</td>
 113 </tr>
 114 </tbody>
 115 </table></div>
 116 </div>
 117 <hr>
 118 <div class="refsect2">
 119 <a name="g-mime-message-partial-get-id"></a><h3>g_mime_message_partial_get_id ()</h3>
 120 <pre class="programlisting">const <span class="returnvalue">char</span> *        g_mime_message_partial_get_id       (<em class="parameter"><code><a class="link" href="GMimeMessagePartial.html" title="GMimeMessagePartial"><span class="type">GMimeMessagePartial</span></a> *partial</code></em>);</pre>
 121 <p>
 122 Gets the message/partial id parameter value.
 123 </p>
 124 <div class="variablelist"><table border="0">
 125 <col align="left" valign="top">
 126 <tbody>
 127 <tr>
 128 <td><p><span class="term"><em class="parameter"><code>partial</code></em> :</span></p></td>
 129 <td>message/partial object</td>
 130 </tr>
 131 <tr>
 132 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 133 <td>the message/partial id or <code class="literal">NULL</code> on fail.</td>
 134 </tr>
 135 </tbody>
 136 </table></div>
 137 </div>
 138 <hr>
 139 <div class="refsect2">
 140 <a name="g-mime-message-partial-get-number"></a><h3>g_mime_message_partial_get_number ()</h3>
 141 <pre class="programlisting"><span class="returnvalue">int</span>                 g_mime_message_partial_get_number   (<em class="parameter"><code><a class="link" href="GMimeMessagePartial.html" title="GMimeMessagePartial"><span class="type">GMimeMessagePartial</span></a> *partial</code></em>);</pre>
 142 <p>
 143 Gets the message/partial part number.
 144 </p>
 145 <div class="variablelist"><table border="0">
 146 <col align="left" valign="top">
 147 <tbody>
 148 <tr>
 149 <td><p><span class="term"><em class="parameter"><code>partial</code></em> :</span></p></td>
 150 <td>message/partial object</td>
 151 </tr>
 152 <tr>
 153 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 154 <td>the message/partial part number or <code class="literal">-1</code> on fail.</td>
 155 </tr>
 156 </tbody>
 157 </table></div>
 158 </div>
 159 <hr>
 160 <div class="refsect2">
 161 <a name="g-mime-message-partial-get-total"></a><h3>g_mime_message_partial_get_total ()</h3>
 162 <pre class="programlisting"><span class="returnvalue">int</span>                 g_mime_message_partial_get_total    (<em class="parameter"><code><a class="link" href="GMimeMessagePartial.html" title="GMimeMessagePartial"><span class="type">GMimeMessagePartial</span></a> *partial</code></em>);</pre>
 163 <p>
 164 Gets the total number of message/partial parts needed to
 165 reconstruct the original message.
 166 </p>
 167 <div class="variablelist"><table border="0">
 168 <col align="left" valign="top">
 169 <tbody>
 170 <tr>
 171 <td><p><span class="term"><em class="parameter"><code>partial</code></em> :</span></p></td>
 172 <td>message/partial object</td>
 173 </tr>
 174 <tr>
 175 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 176 <td>the total number of message/partial parts needed to
 177 reconstruct the original message or -1 on fail.</td>
 178 </tr>
 179 </tbody>
 180 </table></div>
 181 </div>
 182 <hr>
 183 <div class="refsect2">
 184 <a name="g-mime-message-partial-reconstruct-message"></a><h3>g_mime_message_partial_reconstruct_message ()</h3>
 185 <pre class="programlisting"><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="returnvalue">GMimeMessage</span></a> *      g_mime_message_partial_reconstruct_message
 186                                                         (<em class="parameter"><code><a class="link" href="GMimeMessagePartial.html" title="GMimeMessagePartial"><span class="type">GMimeMessagePartial</span></a> **partials</code></em>,
 187                                                          <em class="parameter"><code><span class="type">size_t</span> num</code></em>);</pre>
 188 <p>
 189 Reconstructs the GMimeMessage from the given message/partial parts
 190 in <em class="parameter"><code>partials</code></em>.
 191 </p>
 192 <div class="variablelist"><table border="0">
 193 <col align="left" valign="top">
 194 <tbody>
 195 <tr>
 196 <td><p><span class="term"><em class="parameter"><code>partials</code></em> :</span></p></td>
 197 <td>an array of message/partial mime parts</td>
 198 </tr>
 199 <tr>
 200 <td><p><span class="term"><em class="parameter"><code>num</code></em> :</span></p></td>
 201 <td>the number of elements in <em class="parameter"><code>partials</code></em>
 202 </td>
 203 </tr>
 204 <tr>
 205 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 206 <td>a GMimeMessage object on success or <code class="literal">NULL</code> on fail.</td>
 207 </tr>
 208 </tbody>
 209 </table></div>
 210 </div>
 211 <hr>
 212 <div class="refsect2">
 213 <a name="g-mime-message-partial-split-message"></a><h3>g_mime_message_partial_split_message ()</h3>
 214 <pre class="programlisting"><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="returnvalue">GMimeMessage</span></a> **     g_mime_message_partial_split_message
 215                                                         (<em class="parameter"><code><a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> *message</code></em>,
 216                                                          <em class="parameter"><code><span class="type">size_t</span> max_size</code></em>,
 217                                                          <em class="parameter"><code><span class="type">size_t</span> *nparts</code></em>);</pre>
 218 <p>
 219 Splits <em class="parameter"><code>message</code></em> into an array of <a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> objects each
 220 containing a single <a class="link" href="GMimeMessagePartial.html" title="GMimeMessagePartial"><span class="type">GMimeMessagePartial</span></a> object containing
 221 <em class="parameter"><code>max_size</code></em> bytes or fewer. <em class="parameter"><code>nparts</code></em> is set to the number of
 222 <a class="link" href="GMimeMessagePartial.html" title="GMimeMessagePartial"><span class="type">GMimeMessagePartial</span></a> objects created.
 223 </p>
 224 <div class="variablelist"><table border="0">
 225 <col align="left" valign="top">
 226 <tbody>
 227 <tr>
 228 <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
 229 <td>message object</td>
 230 </tr>
 231 <tr>
 232 <td><p><span class="term"><em class="parameter"><code>max_size</code></em> :</span></p></td>
 233 <td>max size</td>
 234 </tr>
 235 <tr>
 236 <td><p><span class="term"><em class="parameter"><code>nparts</code></em> :</span></p></td>
 237 <td>number of parts</td>
 238 </tr>
 239 <tr>
 240 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 241 <td>an array of <a class="link" href="GMimeMessage.html" title="GMimeMessage"><span class="type">GMimeMessage</span></a> objects and sets <em class="parameter"><code>nparts</code></em> to th
 242 number of messages returned or <code class="literal">NULL</code> on fail.</td>
 243 </tr>
 244 </tbody>
 245 </table></div>
 246 </div>
 247 </div>
 248 </div>
 249 <div class="footer">
 250 <hr>
 251           Generated by GTK-Doc V1.18</div>
 252 </body>
 253 </html>