docs/reference/html/GMimeMultipartEncrypted.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>GMimeMultipartEncrypted</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="GMimeMultipart.html" title="GMimeMultipart">
  10 <link rel="next" href="GMimeMultipartSigned.html" title="GMimeMultipartSigned">
  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="GMimeMultipart.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="GMimeMultipartSigned.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="#GMimeMultipartEncrypted.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#GMimeMultipartEncrypted.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#GMimeMultipartEncrypted.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry">
  32 <a name="GMimeMultipartEncrypted"></a><div class="titlepage"></div>
  33 <div class="refnamediv"><table width="100%"><tr>
  34 <td valign="top">
  35 <h2><span class="refentrytitle"><a name="GMimeMultipartEncrypted.top_of_page"></a>GMimeMultipartEncrypted</span></h2>
  36 <p>GMimeMultipartEncrypted — Encrypted MIME multiparts</p>
  37 </td>
  38 <td valign="top" align="right"></td>
  39 </tr></table></div>
  40 <div class="refsynopsisdiv">
  41 <a name="GMimeMultipartEncrypted.synopsis"></a><h2>Synopsis</h2>
  42 <pre class="synopsis">struct              <a class="link" href="GMimeMultipartEncrypted.html#GMimeMultipartEncrypted-struct" title="struct GMimeMultipartEncrypted">GMimeMultipartEncrypted</a>;
  43 <a class="link" href="GMimeMultipartEncrypted.html" title="GMimeMultipartEncrypted"><span class="returnvalue">GMimeMultipartEncrypted</span></a> * <a class="link" href="GMimeMultipartEncrypted.html#g-mime-multipart-encrypted-new" title="g_mime_multipart_encrypted_new ()">g_mime_multipart_encrypted_new</a>
  44                                                         (<em class="parameter"><code><span class="type">void</span></code></em>);
  45 <span class="returnvalue">int</span>                 <a class="link" href="GMimeMultipartEncrypted.html#g-mime-multipart-encrypted-encrypt" title="g_mime_multipart_encrypted_encrypt ()">g_mime_multipart_encrypted_encrypt</a>  (<em class="parameter"><code><a class="link" href="GMimeMultipartEncrypted.html" title="GMimeMultipartEncrypted"><span class="type">GMimeMultipartEncrypted</span></a> *mpe</code></em>,
  46                                                          <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *content</code></em>,
  47                                                          <em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>,
  48                                                          <em class="parameter"><code><span class="type">gboolean</span> sign</code></em>,
  49                                                          <em class="parameter"><code>const <span class="type">char</span> *userid</code></em>,
  50                                                          <em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="type">GMimeDigestAlgo</span></a> digest</code></em>,
  51                                                          <em class="parameter"><code><span class="type">GPtrArray</span> *recipients</code></em>,
  52                                                          <em class="parameter"><code><span class="type">GError</span> **err</code></em>);
  53 <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> *       <a class="link" href="GMimeMultipartEncrypted.html#g-mime-multipart-encrypted-decrypt" title="g_mime_multipart_encrypted_decrypt ()">g_mime_multipart_encrypted_decrypt</a>  (<em class="parameter"><code><a class="link" href="GMimeMultipartEncrypted.html" title="GMimeMultipartEncrypted"><span class="type">GMimeMultipartEncrypted</span></a> *mpe</code></em>,
  54                                                          <em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>,
  55                                                          <em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> **result</code></em>,
  56                                                          <em class="parameter"><code><span class="type">GError</span> **err</code></em>);
  57 </pre>
  58 </div>
  59 <div class="refsect1">
  60 <a name="GMimeMultipartEncrypted.object-hierarchy"></a><h2>Object Hierarchy</h2>
  61 <pre class="synopsis">
  62   GObject
  63    +----<a class="link" href="GMimeObject.html" title="GMimeObject">GMimeObject</a>
  64          +----<a class="link" href="GMimeMultipart.html" title="GMimeMultipart">GMimeMultipart</a>
  65                +----GMimeMultipartEncrypted
  66 </pre>
  67 </div>
  68 <div class="refsect1">
  69 <a name="GMimeMultipartEncrypted.description"></a><h2>Description</h2>
  70 <p>
  71 A <a class="link" href="GMimeMultipartEncrypted.html" title="GMimeMultipartEncrypted"><span class="type">GMimeMultipartEncrypted</span></a> part is a special subclass of
  72 <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a> to make it easier to manipulate the
  73 multipart/encrypted MIME type.
  74 </p>
  75 </div>
  76 <div class="refsect1">
  77 <a name="GMimeMultipartEncrypted.details"></a><h2>Details</h2>
  78 <div class="refsect2">
  79 <a name="GMimeMultipartEncrypted-struct"></a><h3>struct GMimeMultipartEncrypted</h3>
  80 <pre class="programlisting">struct GMimeMultipartEncrypted;</pre>
  81 <p>
  82 A multipart/encrypted MIME part.
  83 </p>
  84 <div class="variablelist"><table border="0">
  85 <col align="left" valign="top">
  86 <tbody></tbody>
  87 </table></div>
  88 </div>
  89 <hr>
  90 <div class="refsect2">
  91 <a name="g-mime-multipart-encrypted-new"></a><h3>g_mime_multipart_encrypted_new ()</h3>
  92 <pre class="programlisting"><a class="link" href="GMimeMultipartEncrypted.html" title="GMimeMultipartEncrypted"><span class="returnvalue">GMimeMultipartEncrypted</span></a> * g_mime_multipart_encrypted_new
  93                                                         (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
  94 <p>
  95 Creates a new MIME multipart/encrypted object.
  96 </p>
  97 <div class="variablelist"><table border="0">
  98 <col align="left" valign="top">
  99 <tbody><tr>
 100 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 101 <td>an empty MIME multipart/encrypted object.</td>
 102 </tr></tbody>
 103 </table></div>
 104 </div>
 105 <hr>
 106 <div class="refsect2">
 107 <a name="g-mime-multipart-encrypted-encrypt"></a><h3>g_mime_multipart_encrypted_encrypt ()</h3>
 108 <pre class="programlisting"><span class="returnvalue">int</span>                 g_mime_multipart_encrypted_encrypt  (<em class="parameter"><code><a class="link" href="GMimeMultipartEncrypted.html" title="GMimeMultipartEncrypted"><span class="type">GMimeMultipartEncrypted</span></a> *mpe</code></em>,
 109                                                          <em class="parameter"><code><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> *content</code></em>,
 110                                                          <em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>,
 111                                                          <em class="parameter"><code><span class="type">gboolean</span> sign</code></em>,
 112                                                          <em class="parameter"><code>const <span class="type">char</span> *userid</code></em>,
 113                                                          <em class="parameter"><code><a class="link" href="GMimeCertificate.html#GMimeDigestAlgo" title="enum GMimeDigestAlgo"><span class="type">GMimeDigestAlgo</span></a> digest</code></em>,
 114                                                          <em class="parameter"><code><span class="type">GPtrArray</span> *recipients</code></em>,
 115                                                          <em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre>
 116 <p>
 117 Attempts to encrypt (and conditionally sign) the <em class="parameter"><code>content</code></em> MIME part
 118 to the public keys of <em class="parameter"><code>recipients</code></em> using the <em class="parameter"><code>ctx</code></em> encryption
 119 context. If successful, the encrypted <a class="link" href="GMimeObject.html" title="GMimeObject"><span class="type">GMimeObject</span></a> is set as the
 120 encrypted part of the multipart/encrypted object <em class="parameter"><code>mpe</code></em>.
 121 </p>
 122 <div class="variablelist"><table border="0">
 123 <col align="left" valign="top">
 124 <tbody>
 125 <tr>
 126 <td><p><span class="term"><em class="parameter"><code>mpe</code></em> :</span></p></td>
 127 <td>multipart/encrypted object</td>
 128 </tr>
 129 <tr>
 130 <td><p><span class="term"><em class="parameter"><code>content</code></em> :</span></p></td>
 131 <td>MIME part to encrypt</td>
 132 </tr>
 133 <tr>
 134 <td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td>
 135 <td>encryption context</td>
 136 </tr>
 137 <tr>
 138 <td><p><span class="term"><em class="parameter"><code>sign</code></em> :</span></p></td>
 139 <td>
 140 <code class="literal">TRUE</code> if the content should also be signed or <code class="literal">FALSE</code> otherwise</td>
 141 </tr>
 142 <tr>
 143 <td><p><span class="term"><em class="parameter"><code>userid</code></em> :</span></p></td>
 144 <td>user id to use for signing (only used if <em class="parameter"><code>sign</code></em> is <code class="literal">TRUE</code>)</td>
 145 </tr>
 146 <tr>
 147 <td><p><span class="term"><em class="parameter"><code>digest</code></em> :</span></p></td>
 148 <td>digest algorithm to use when signing</td>
 149 </tr>
 150 <tr>
 151 <td><p><span class="term"><em class="parameter"><code>recipients</code></em> :</span></p></td>
 152 <td>an array of recipients to encrypt to</td>
 153 </tr>
 154 <tr>
 155 <td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
 156 <td>a <span class="type">GError</span>
 157 </td>
 158 </tr>
 159 <tr>
 160 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 161 <td>
 162 <code class="literal">0</code> on success or <code class="literal">-1</code> on fail. If the encryption fails, an
 163 exception will be set on <em class="parameter"><code>err</code></em> to provide information as to why the
 164 failure occured.</td>
 165 </tr>
 166 </tbody>
 167 </table></div>
 168 </div>
 169 <hr>
 170 <div class="refsect2">
 171 <a name="g-mime-multipart-encrypted-decrypt"></a><h3>g_mime_multipart_encrypted_decrypt ()</h3>
 172 <pre class="programlisting"><a class="link" href="GMimeObject.html" title="GMimeObject"><span class="returnvalue">GMimeObject</span></a> *       g_mime_multipart_encrypted_decrypt  (<em class="parameter"><code><a class="link" href="GMimeMultipartEncrypted.html" title="GMimeMultipartEncrypted"><span class="type">GMimeMultipartEncrypted</span></a> *mpe</code></em>,
 173                                                          <em class="parameter"><code><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> *ctx</code></em>,
 174                                                          <em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> **result</code></em>,
 175                                                          <em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre>
 176 <p>
 177 Attempts to decrypt the encrypted MIME part contained within the
 178 multipart/encrypted object <em class="parameter"><code>mpe</code></em> using the <em class="parameter"><code>ctx</code></em> decryption context.
 179 </p>
 180 <p>
 181 If <em class="parameter"><code>result</code></em> is non-<code class="literal">NULL</code>, then on a successful decrypt operation, it will be
 182 updated to point to a newly-allocated <a class="link" href="GMimeCryptoContext.html#GMimeDecryptResult" title="struct GMimeDecryptResult"><span class="type">GMimeDecryptResult</span></a> with signature
 183 status information as well as a list of recipients that the part was
 184 encrypted to.
 185 </p>
 186 <div class="variablelist"><table border="0">
 187 <col align="left" valign="top">
 188 <tbody>
 189 <tr>
 190 <td><p><span class="term"><em class="parameter"><code>mpe</code></em> :</span></p></td>
 191 <td>multipart/encrypted object</td>
 192 </tr>
 193 <tr>
 194 <td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td>
 195 <td>decryption context</td>
 196 </tr>
 197 <tr>
 198 <td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
 199 <td>a <span class="type">GMimeDecryptionResult</span>
 200 </td>
 201 </tr>
 202 <tr>
 203 <td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
 204 <td>a <span class="type">GError</span>
 205 </td>
 206 </tr>
 207 <tr>
 208 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 209 <td>the decrypted MIME part on success or <code class="literal">NULL</code> on fail. If the
 210 decryption fails, an exception will be set on <em class="parameter"><code>err</code></em> to provide
 211 information as to why the failure occured.</td>
 212 </tr>
 213 </tbody>
 214 </table></div>
 215 </div>
 216 </div>
 217 <div class="refsect1">
 218 <a name="GMimeMultipartEncrypted.see-also"></a><h2>See Also</h2>
 219 <a class="link" href="GMimeMultipart.html" title="GMimeMultipart"><span class="type">GMimeMultipart</span></a>
 220 </div>
 221 </div>
 222 <div class="footer">
 223 <hr>
 224           Generated by GTK-Doc V1.18</div>
 225 </body>
 226 </html>