docs/reference/html/GMimeGpgContext.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>GMimeGpgContext</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="CryptoContexts.html" title="Cryptography Contexts">
   9 <link rel="prev" href="GMimeCryptoContext.html" title="GMimeCryptoContext">
  10 <link rel="next" href="GMimePkcs7Context.html" title="GMimePkcs7Context">
  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="GMimeCryptoContext.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="CryptoContexts.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="GMimePkcs7Context.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="#GMimeGpgContext.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#GMimeGpgContext.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#GMimeGpgContext.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry">
  32 <a name="GMimeGpgContext"></a><div class="titlepage"></div>
  33 <div class="refnamediv"><table width="100%"><tr>
  34 <td valign="top">
  35 <h2><span class="refentrytitle"><a name="GMimeGpgContext.top_of_page"></a>GMimeGpgContext</span></h2>
  36 <p>GMimeGpgContext — GnuPG crypto contexts</p>
  37 </td>
  38 <td valign="top" align="right"></td>
  39 </tr></table></div>
  40 <div class="refsynopsisdiv">
  41 <a name="GMimeGpgContext.synopsis"></a><h2>Synopsis</h2>
  42 <pre class="synopsis">struct              <a class="link" href="GMimeGpgContext.html#GMimeGpgContext-struct" title="struct GMimeGpgContext">GMimeGpgContext</a>;
  43 <a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="returnvalue">GMimeCryptoContext</span></a> * <a class="link" href="GMimeGpgContext.html#g-mime-gpg-context-new" title="g_mime_gpg_context_new ()">g_mime_gpg_context_new</a>             (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimePasswordRequestFunc" title="GMimePasswordRequestFunc ()"><span class="type">GMimePasswordRequestFunc</span></a> request_passwd</code></em>,
  44                                                          <em class="parameter"><code>const <span class="type">char</span> *path</code></em>);
  45 <span class="returnvalue">gboolean</span>            <a class="link" href="GMimeGpgContext.html#g-mime-gpg-context-get-always-trust" title="g_mime_gpg_context_get_always_trust ()">g_mime_gpg_context_get_always_trust</a> (<em class="parameter"><code><a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext"><span class="type">GMimeGpgContext</span></a> *ctx</code></em>);
  46 <span class="returnvalue">void</span>                <a class="link" href="GMimeGpgContext.html#g-mime-gpg-context-set-always-trust" title="g_mime_gpg_context_set_always_trust ()">g_mime_gpg_context_set_always_trust</a> (<em class="parameter"><code><a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext"><span class="type">GMimeGpgContext</span></a> *ctx</code></em>,
  47                                                          <em class="parameter"><code><span class="type">gboolean</span> always_trust</code></em>);
  48 <span class="returnvalue">gboolean</span>            <a class="link" href="GMimeGpgContext.html#g-mime-gpg-context-get-auto-key-retrieve" title="g_mime_gpg_context_get_auto_key_retrieve ()">g_mime_gpg_context_get_auto_key_retrieve</a>
  49                                                         (<em class="parameter"><code><a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext"><span class="type">GMimeGpgContext</span></a> *ctx</code></em>);
  50 <span class="returnvalue">void</span>                <a class="link" href="GMimeGpgContext.html#g-mime-gpg-context-set-auto-key-retrieve" title="g_mime_gpg_context_set_auto_key_retrieve ()">g_mime_gpg_context_set_auto_key_retrieve</a>
  51                                                         (<em class="parameter"><code><a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext"><span class="type">GMimeGpgContext</span></a> *ctx</code></em>,
  52                                                          <em class="parameter"><code><span class="type">gboolean</span> auto_key_retrieve</code></em>);
  53 <span class="returnvalue">gboolean</span>            <a class="link" href="GMimeGpgContext.html#g-mime-gpg-context-get-use-agent" title="g_mime_gpg_context_get_use_agent ()">g_mime_gpg_context_get_use_agent</a>    (<em class="parameter"><code><a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext"><span class="type">GMimeGpgContext</span></a> *ctx</code></em>);
  54 <span class="returnvalue">void</span>                <a class="link" href="GMimeGpgContext.html#g-mime-gpg-context-set-use-agent" title="g_mime_gpg_context_set_use_agent ()">g_mime_gpg_context_set_use_agent</a>    (<em class="parameter"><code><a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext"><span class="type">GMimeGpgContext</span></a> *ctx</code></em>,
  55                                                          <em class="parameter"><code><span class="type">gboolean</span> use_agent</code></em>);
  56 </pre>
  57 </div>
  58 <div class="refsect1">
  59 <a name="GMimeGpgContext.object-hierarchy"></a><h2>Object Hierarchy</h2>
  60 <pre class="synopsis">
  61   GObject
  62    +----<a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext">GMimeCryptoContext</a>
  63          +----GMimeGpgContext
  64 </pre>
  65 </div>
  66 <div class="refsect1">
  67 <a name="GMimeGpgContext.description"></a><h2>Description</h2>
  68 <p>
  69 A <a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext"><span class="type">GMimeGpgContext</span></a> is a <a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a> that uses GnuPG to do
  70 all of the encryption and digital signatures.
  71 </p>
  72 </div>
  73 <div class="refsect1">
  74 <a name="GMimeGpgContext.details"></a><h2>Details</h2>
  75 <div class="refsect2">
  76 <a name="GMimeGpgContext-struct"></a><h3>struct GMimeGpgContext</h3>
  77 <pre class="programlisting">struct GMimeGpgContext;</pre>
  78 <p>
  79 A GnuPG crypto context.
  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-gpg-context-new"></a><h3>g_mime_gpg_context_new ()</h3>
  89 <pre class="programlisting"><a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="returnvalue">GMimeCryptoContext</span></a> * g_mime_gpg_context_new             (<em class="parameter"><code><a class="link" href="GMimeCryptoContext.html#GMimePasswordRequestFunc" title="GMimePasswordRequestFunc ()"><span class="type">GMimePasswordRequestFunc</span></a> request_passwd</code></em>,
  90                                                          <em class="parameter"><code>const <span class="type">char</span> *path</code></em>);</pre>
  91 <p>
  92 Creates a new gpg crypto context object.
  93 </p>
  94 <div class="variablelist"><table border="0">
  95 <col align="left" valign="top">
  96 <tbody>
  97 <tr>
  98 <td><p><span class="term"><em class="parameter"><code>request_passwd</code></em> :</span></p></td>
  99 <td>a <a class="link" href="GMimeCryptoContext.html#GMimePasswordRequestFunc" title="GMimePasswordRequestFunc ()"><span class="type">GMimePasswordRequestFunc</span></a>
 100 </td>
 101 </tr>
 102 <tr>
 103 <td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
 104 <td>path to gpg binary</td>
 105 </tr>
 106 <tr>
 107 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 108 <td>a new gpg crypto context object.</td>
 109 </tr>
 110 </tbody>
 111 </table></div>
 112 </div>
 113 <hr>
 114 <div class="refsect2">
 115 <a name="g-mime-gpg-context-get-always-trust"></a><h3>g_mime_gpg_context_get_always_trust ()</h3>
 116 <pre class="programlisting"><span class="returnvalue">gboolean</span>            g_mime_gpg_context_get_always_trust (<em class="parameter"><code><a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext"><span class="type">GMimeGpgContext</span></a> *ctx</code></em>);</pre>
 117 <p>
 118 Gets the always_trust flag on the gpg context.
 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"><em class="parameter"><code>ctx</code></em> :</span></p></td>
 125 <td>a <a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext"><span class="type">GMimeGpgContext</span></a>
 126 </td>
 127 </tr>
 128 <tr>
 129 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 130 <td>the always_trust flag on the gpg context.</td>
 131 </tr>
 132 </tbody>
 133 </table></div>
 134 </div>
 135 <hr>
 136 <div class="refsect2">
 137 <a name="g-mime-gpg-context-set-always-trust"></a><h3>g_mime_gpg_context_set_always_trust ()</h3>
 138 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_gpg_context_set_always_trust (<em class="parameter"><code><a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext"><span class="type">GMimeGpgContext</span></a> *ctx</code></em>,
 139                                                          <em class="parameter"><code><span class="type">gboolean</span> always_trust</code></em>);</pre>
 140 <p>
 141 Sets the <em class="parameter"><code>always_trust</code></em> flag on the gpg context which is used for
 142 encryption.
 143 </p>
 144 <div class="variablelist"><table border="0">
 145 <col align="left" valign="top">
 146 <tbody>
 147 <tr>
 148 <td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td>
 149 <td>a <a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext"><span class="type">GMimeGpgContext</span></a>
 150 </td>
 151 </tr>
 152 <tr>
 153 <td><p><span class="term"><em class="parameter"><code>always_trust</code></em> :</span></p></td>
 154 <td>always trust flag</td>
 155 </tr>
 156 </tbody>
 157 </table></div>
 158 </div>
 159 <hr>
 160 <div class="refsect2">
 161 <a name="g-mime-gpg-context-get-auto-key-retrieve"></a><h3>g_mime_gpg_context_get_auto_key_retrieve ()</h3>
 162 <pre class="programlisting"><span class="returnvalue">gboolean</span>            g_mime_gpg_context_get_auto_key_retrieve
 163                                                         (<em class="parameter"><code><a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext"><span class="type">GMimeGpgContext</span></a> *ctx</code></em>);</pre>
 164 <p>
 165 Gets the <em class="parameter"><code>auto_key_retrieve</code></em> flag on the gpg context.
 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>ctx</code></em> :</span></p></td>
 172 <td>a <a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext"><span class="type">GMimeGpgContext</span></a>
 173 </td>
 174 </tr>
 175 <tr>
 176 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 177 <td>the <em class="parameter"><code>auto_key_retrieve</code></em> flag on the gpg context.</td>
 178 </tr>
 179 </tbody>
 180 </table></div>
 181 </div>
 182 <hr>
 183 <div class="refsect2">
 184 <a name="g-mime-gpg-context-set-auto-key-retrieve"></a><h3>g_mime_gpg_context_set_auto_key_retrieve ()</h3>
 185 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_gpg_context_set_auto_key_retrieve
 186                                                         (<em class="parameter"><code><a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext"><span class="type">GMimeGpgContext</span></a> *ctx</code></em>,
 187                                                          <em class="parameter"><code><span class="type">gboolean</span> auto_key_retrieve</code></em>);</pre>
 188 <p>
 189 Sets the <em class="parameter"><code>auto_key_retrieve</code></em> flag on the gpg context which is used
 190 for signature verification.
 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>ctx</code></em> :</span></p></td>
 197 <td>a <a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext"><span class="type">GMimeGpgContext</span></a>
 198 </td>
 199 </tr>
 200 <tr>
 201 <td><p><span class="term"><em class="parameter"><code>auto_key_retrieve</code></em> :</span></p></td>
 202 <td>auto-retrieve keys from a keys server</td>
 203 </tr>
 204 </tbody>
 205 </table></div>
 206 </div>
 207 <hr>
 208 <div class="refsect2">
 209 <a name="g-mime-gpg-context-get-use-agent"></a><h3>g_mime_gpg_context_get_use_agent ()</h3>
 210 <pre class="programlisting"><span class="returnvalue">gboolean</span>            g_mime_gpg_context_get_use_agent    (<em class="parameter"><code><a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext"><span class="type">GMimeGpgContext</span></a> *ctx</code></em>);</pre>
 211 <p>
 212 Gets the use_agent flag on the gpg context.
 213 </p>
 214 <div class="variablelist"><table border="0">
 215 <col align="left" valign="top">
 216 <tbody>
 217 <tr>
 218 <td><p><span class="term"><em class="parameter"><code>ctx</code></em> :</span></p></td>
 219 <td>a <a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext"><span class="type">GMimeGpgContext</span></a>
 220 </td>
 221 </tr>
 222 <tr>
 223 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 224 <td>the use_agent flag on the gpg context, which indicates
 225 that GnuPG should attempt to use gpg-agent for credentials.</td>
 226 </tr>
 227 </tbody>
 228 </table></div>
 229 </div>
 230 <hr>
 231 <div class="refsect2">
 232 <a name="g-mime-gpg-context-set-use-agent"></a><h3>g_mime_gpg_context_set_use_agent ()</h3>
 233 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_gpg_context_set_use_agent    (<em class="parameter"><code><a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext"><span class="type">GMimeGpgContext</span></a> *ctx</code></em>,
 234                                                          <em class="parameter"><code><span class="type">gboolean</span> use_agent</code></em>);</pre>
 235 <p>
 236 Sets the <em class="parameter"><code>use_agent</code></em> flag on the gpg context, which indicates that
 237 GnuPG should attempt to use gpg-agent for credentials.
 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>ctx</code></em> :</span></p></td>
 244 <td>a <a class="link" href="GMimeGpgContext.html" title="GMimeGpgContext"><span class="type">GMimeGpgContext</span></a>
 245 </td>
 246 </tr>
 247 <tr>
 248 <td><p><span class="term"><em class="parameter"><code>use_agent</code></em> :</span></p></td>
 249 <td>always trust flag</td>
 250 </tr>
 251 </tbody>
 252 </table></div>
 253 </div>
 254 </div>
 255 <div class="refsect1">
 256 <a name="GMimeGpgContext.see-also"></a><h2>See Also</h2>
 257 <a class="link" href="GMimeCryptoContext.html" title="GMimeCryptoContext"><span class="type">GMimeCryptoContext</span></a>
 258 </div>
 259 </div>
 260 <div class="footer">
 261 <hr>
 262           Generated by GTK-Doc V1.18</div>
 263 </body>
 264 </html>