1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>GMimeSignature</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="GMimeCertificate.html" title="GMimeCertificate">
10 <link rel="next" href="GMimeCryptoContext.html" title="GMimeCryptoContext">
11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
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">
17 <td><a accesskey="p" href="GMimeCertificate.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="GMimeCryptoContext.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#GMimeSignature.synopsis" class="shortcut">Top</a>
26 <a href="#GMimeSignature.description" class="shortcut">Description</a>
28 <a href="#GMimeSignature.object-hierarchy" class="shortcut">Object Hierarchy</a>
31 <div class="refentry">
32 <a name="GMimeSignature"></a><div class="titlepage"></div>
33 <div class="refnamediv"><table width="100%"><tr>
35 <h2><span class="refentrytitle"><a name="GMimeSignature.top_of_page"></a>GMimeSignature</span></h2>
36 <p>GMimeSignature — Digital signatures</p>
38 <td valign="top" align="right"></td>
40 <div class="refsynopsisdiv">
41 <a name="GMimeSignature.synopsis"></a><h2>Synopsis</h2>
42 <a name="GMimeSignatureList"></a><pre class="synopsis">enum <a class="link" href="GMimeSignature.html#GMimeSignatureStatus" title="enum GMimeSignatureStatus">GMimeSignatureStatus</a>;
43 enum <a class="link" href="GMimeSignature.html#GMimeSignatureError" title="enum GMimeSignatureError">GMimeSignatureError</a>;
44 struct <a class="link" href="GMimeSignature.html#GMimeSignature-struct" title="struct GMimeSignature">GMimeSignature</a>;
45 <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="returnvalue">GMimeSignature</span></a> * <a class="link" href="GMimeSignature.html#g-mime-signature-new" title="g_mime_signature_new ()">g_mime_signature_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
46 <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="returnvalue">GMimeCertificate</span></a> * <a class="link" href="GMimeSignature.html#g-mime-signature-get-certificate" title="g_mime_signature_get_certificate ()">g_mime_signature_get_certificate</a> (<em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>);
47 <span class="returnvalue">void</span> <a class="link" href="GMimeSignature.html#g-mime-signature-set-certificate" title="g_mime_signature_set_certificate ()">g_mime_signature_set_certificate</a> (<em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>,
48 <em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>);
49 <a class="link" href="GMimeSignature.html#GMimeSignatureStatus" title="enum GMimeSignatureStatus"><span class="returnvalue">GMimeSignatureStatus</span></a> <a class="link" href="GMimeSignature.html#g-mime-signature-get-status" title="g_mime_signature_get_status ()">g_mime_signature_get_status</a> (<em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>);
50 <span class="returnvalue">void</span> <a class="link" href="GMimeSignature.html#g-mime-signature-set-status" title="g_mime_signature_set_status ()">g_mime_signature_set_status</a> (<em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>,
51 <em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureStatus" title="enum GMimeSignatureStatus"><span class="type">GMimeSignatureStatus</span></a> status</code></em>);
52 <a class="link" href="GMimeSignature.html#GMimeSignatureError" title="enum GMimeSignatureError"><span class="returnvalue">GMimeSignatureError</span></a> <a class="link" href="GMimeSignature.html#g-mime-signature-get-errors" title="g_mime_signature_get_errors ()">g_mime_signature_get_errors</a> (<em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>);
53 <span class="returnvalue">void</span> <a class="link" href="GMimeSignature.html#g-mime-signature-set-errors" title="g_mime_signature_set_errors ()">g_mime_signature_set_errors</a> (<em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>,
54 <em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureError" title="enum GMimeSignatureError"><span class="type">GMimeSignatureError</span></a> errors</code></em>);
55 <span class="returnvalue">time_t</span> <a class="link" href="GMimeSignature.html#g-mime-signature-get-created" title="g_mime_signature_get_created ()">g_mime_signature_get_created</a> (<em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>);
56 <span class="returnvalue">void</span> <a class="link" href="GMimeSignature.html#g-mime-signature-set-created" title="g_mime_signature_set_created ()">g_mime_signature_set_created</a> (<em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>,
57 <em class="parameter"><code><span class="type">time_t</span> created</code></em>);
58 <span class="returnvalue">time_t</span> <a class="link" href="GMimeSignature.html#g-mime-signature-get-expires" title="g_mime_signature_get_expires ()">g_mime_signature_get_expires</a> (<em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>);
59 <span class="returnvalue">void</span> <a class="link" href="GMimeSignature.html#g-mime-signature-set-expires" title="g_mime_signature_set_expires ()">g_mime_signature_set_expires</a> (<em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>,
60 <em class="parameter"><code><span class="type">time_t</span> expires</code></em>);
62 struct <a class="link" href="GMimeSignature.html#GMimeSignatureList-struct" title="struct GMimeSignatureList">GMimeSignatureList</a>;
63 <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="returnvalue">GMimeSignatureList</span></a> * <a class="link" href="GMimeSignature.html#g-mime-signature-list-new" title="g_mime_signature_list_new ()">g_mime_signature_list_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
64 <span class="returnvalue">int</span> <a class="link" href="GMimeSignature.html#g-mime-signature-list-length" title="g_mime_signature_list_length ()">g_mime_signature_list_length</a> (<em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *list</code></em>);
65 <span class="returnvalue">void</span> <a class="link" href="GMimeSignature.html#g-mime-signature-list-clear" title="g_mime_signature_list_clear ()">g_mime_signature_list_clear</a> (<em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *list</code></em>);
66 <span class="returnvalue">int</span> <a class="link" href="GMimeSignature.html#g-mime-signature-list-add" title="g_mime_signature_list_add ()">g_mime_signature_list_add</a> (<em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *list</code></em>,
67 <em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>);
68 <span class="returnvalue">void</span> <a class="link" href="GMimeSignature.html#g-mime-signature-list-insert" title="g_mime_signature_list_insert ()">g_mime_signature_list_insert</a> (<em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *list</code></em>,
69 <em class="parameter"><code><span class="type">int</span> index</code></em>,
70 <em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>);
71 <span class="returnvalue">gboolean</span> <a class="link" href="GMimeSignature.html#g-mime-signature-list-remove" title="g_mime_signature_list_remove ()">g_mime_signature_list_remove</a> (<em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *list</code></em>,
72 <em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>);
73 <span class="returnvalue">gboolean</span> <a class="link" href="GMimeSignature.html#g-mime-signature-list-remove-at" title="g_mime_signature_list_remove_at ()">g_mime_signature_list_remove_at</a> (<em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *list</code></em>,
74 <em class="parameter"><code><span class="type">int</span> index</code></em>);
75 <span class="returnvalue">gboolean</span> <a class="link" href="GMimeSignature.html#g-mime-signature-list-contains" title="g_mime_signature_list_contains ()">g_mime_signature_list_contains</a> (<em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *list</code></em>,
76 <em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>);
77 <span class="returnvalue">int</span> <a class="link" href="GMimeSignature.html#g-mime-signature-list-index-of" title="g_mime_signature_list_index_of ()">g_mime_signature_list_index_of</a> (<em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *list</code></em>,
78 <em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>);
79 <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="returnvalue">GMimeSignature</span></a> * <a class="link" href="GMimeSignature.html#g-mime-signature-list-get-signature" title="g_mime_signature_list_get_signature ()">g_mime_signature_list_get_signature</a> (<em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *list</code></em>,
80 <em class="parameter"><code><span class="type">int</span> index</code></em>);
81 <span class="returnvalue">void</span> <a class="link" href="GMimeSignature.html#g-mime-signature-list-set-signature" title="g_mime_signature_list_set_signature ()">g_mime_signature_list_set_signature</a> (<em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *list</code></em>,
82 <em class="parameter"><code><span class="type">int</span> index</code></em>,
83 <em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>);
86 <div class="refsect1">
87 <a name="GMimeSignature.object-hierarchy"></a><h2>Object Hierarchy</h2>
88 <pre class="synopsis">
92 <pre class="synopsis">
94 +----GMimeSignatureList
97 <div class="refsect1">
98 <a name="GMimeSignature.description"></a><h2>Description</h2>
100 A <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> is an object containing useful information about a
101 digital signature as used in signing and encrypting data.
104 <div class="refsect1">
105 <a name="GMimeSignature.details"></a><h2>Details</h2>
106 <div class="refsect2">
107 <a name="GMimeSignatureStatus"></a><h3>enum GMimeSignatureStatus</h3>
108 <pre class="programlisting">typedef enum {
109 GMIME_SIGNATURE_STATUS_GOOD,
110 GMIME_SIGNATURE_STATUS_ERROR,
111 GMIME_SIGNATURE_STATUS_BAD
112 } GMimeSignatureStatus;
115 A value representing the signature status for a particular
116 <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a>.
118 <div class="variablelist"><table border="0">
119 <col align="left" valign="top">
122 <td><p><a name="GMIME-SIGNATURE-STATUS-GOOD:CAPS"></a><span class="term"><code class="literal">GMIME_SIGNATURE_STATUS_GOOD</code></span></p></td>
127 <td><p><a name="GMIME-SIGNATURE-STATUS-ERROR:CAPS"></a><span class="term"><code class="literal">GMIME_SIGNATURE_STATUS_ERROR</code></span></p></td>
128 <td>An error occurred.
132 <td><p><a name="GMIME-SIGNATURE-STATUS-BAD:CAPS"></a><span class="term"><code class="literal">GMIME_SIGNATURE_STATUS_BAD</code></span></p></td>
140 <div class="refsect2">
141 <a name="GMimeSignatureError"></a><h3>enum GMimeSignatureError</h3>
142 <pre class="programlisting">typedef enum {
143 GMIME_SIGNATURE_ERROR_NONE = 0,
144 GMIME_SIGNATURE_ERROR_EXPSIG = (1 << 0), /* expired signature */
145 GMIME_SIGNATURE_ERROR_NO_PUBKEY = (1 << 1), /* no public key */
146 GMIME_SIGNATURE_ERROR_EXPKEYSIG = (1 << 2), /* expired key */
147 GMIME_SIGNATURE_ERROR_REVKEYSIG = (1 << 3), /* revoked key */
148 GMIME_SIGNATURE_ERROR_UNSUPP_ALGO = (1 << 4) /* unsupported algorithm */
149 } GMimeSignatureError;
152 Possible errors that a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> could have.
154 <div class="variablelist"><table border="0">
155 <col align="left" valign="top">
158 <td><p><a name="GMIME-SIGNATURE-ERROR-NONE:CAPS"></a><span class="term"><code class="literal">GMIME_SIGNATURE_ERROR_NONE</code></span></p></td>
163 <td><p><a name="GMIME-SIGNATURE-ERROR-EXPSIG:CAPS"></a><span class="term"><code class="literal">GMIME_SIGNATURE_ERROR_EXPSIG</code></span></p></td>
164 <td>Expired signature.
168 <td><p><a name="GMIME-SIGNATURE-ERROR-NO-PUBKEY:CAPS"></a><span class="term"><code class="literal">GMIME_SIGNATURE_ERROR_NO_PUBKEY</code></span></p></td>
169 <td>No public key found.
173 <td><p><a name="GMIME-SIGNATURE-ERROR-EXPKEYSIG:CAPS"></a><span class="term"><code class="literal">GMIME_SIGNATURE_ERROR_EXPKEYSIG</code></span></p></td>
174 <td>Expired signature key.
178 <td><p><a name="GMIME-SIGNATURE-ERROR-REVKEYSIG:CAPS"></a><span class="term"><code class="literal">GMIME_SIGNATURE_ERROR_REVKEYSIG</code></span></p></td>
179 <td>Revoked signature key.
183 <td><p><a name="GMIME-SIGNATURE-ERROR-UNSUPP-ALGO:CAPS"></a><span class="term"><code class="literal">GMIME_SIGNATURE_ERROR_UNSUPP_ALGO</code></span></p></td>
184 <td>Unsupported algorithm.
191 <div class="refsect2">
192 <a name="GMimeSignature-struct"></a><h3>struct GMimeSignature</h3>
193 <pre class="programlisting">struct GMimeSignature;</pre>
195 An object containing useful information about a signature.
197 <div class="variablelist"><table border="0">
198 <col align="left" valign="top">
203 <div class="refsect2">
204 <a name="g-mime-signature-new"></a><h3>g_mime_signature_new ()</h3>
205 <pre class="programlisting"><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="returnvalue">GMimeSignature</span></a> * g_mime_signature_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
207 Creates a new <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> object.
209 <div class="variablelist"><table border="0">
210 <col align="left" valign="top">
212 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
213 <td>a new <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> object.</td>
218 <div class="refsect2">
219 <a name="g-mime-signature-get-certificate"></a><h3>g_mime_signature_get_certificate ()</h3>
220 <pre class="programlisting"><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="returnvalue">GMimeCertificate</span></a> * g_mime_signature_get_certificate (<em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>);</pre>
222 Get the signature's certificate.
224 <div class="variablelist"><table border="0">
225 <col align="left" valign="top">
228 <td><p><span class="term"><em class="parameter"><code>sig</code></em> :</span></p></td>
229 <td>a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a>
233 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
234 <td>the signature's certificate.</td>
240 <div class="refsect2">
241 <a name="g-mime-signature-set-certificate"></a><h3>g_mime_signature_set_certificate ()</h3>
242 <pre class="programlisting"><span class="returnvalue">void</span> g_mime_signature_set_certificate (<em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>,
243 <em class="parameter"><code><a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a> *cert</code></em>);</pre>
245 Set the signature's certificate.
247 <div class="variablelist"><table border="0">
248 <col align="left" valign="top">
251 <td><p><span class="term"><em class="parameter"><code>sig</code></em> :</span></p></td>
252 <td>a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a>
256 <td><p><span class="term"><em class="parameter"><code>cert</code></em> :</span></p></td>
257 <td>a <a class="link" href="GMimeCertificate.html" title="GMimeCertificate"><span class="type">GMimeCertificate</span></a>
264 <div class="refsect2">
265 <a name="g-mime-signature-get-status"></a><h3>g_mime_signature_get_status ()</h3>
266 <pre class="programlisting"><a class="link" href="GMimeSignature.html#GMimeSignatureStatus" title="enum GMimeSignatureStatus"><span class="returnvalue">GMimeSignatureStatus</span></a> g_mime_signature_get_status (<em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>);</pre>
268 Get the signature status.
270 <div class="variablelist"><table border="0">
271 <col align="left" valign="top">
274 <td><p><span class="term"><em class="parameter"><code>sig</code></em> :</span></p></td>
275 <td>a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a>
279 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
280 <td>the signature status.</td>
286 <div class="refsect2">
287 <a name="g-mime-signature-set-status"></a><h3>g_mime_signature_set_status ()</h3>
288 <pre class="programlisting"><span class="returnvalue">void</span> g_mime_signature_set_status (<em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>,
289 <em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureStatus" title="enum GMimeSignatureStatus"><span class="type">GMimeSignatureStatus</span></a> status</code></em>);</pre>
291 Set the status on the signature.
293 <div class="variablelist"><table border="0">
294 <col align="left" valign="top">
297 <td><p><span class="term"><em class="parameter"><code>sig</code></em> :</span></p></td>
298 <td>a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a>
302 <td><p><span class="term"><em class="parameter"><code>status</code></em> :</span></p></td>
303 <td>a <a class="link" href="GMimeSignature.html#GMimeSignatureStatus" title="enum GMimeSignatureStatus"><span class="type">GMimeSignatureStatus</span></a>
310 <div class="refsect2">
311 <a name="g-mime-signature-get-errors"></a><h3>g_mime_signature_get_errors ()</h3>
312 <pre class="programlisting"><a class="link" href="GMimeSignature.html#GMimeSignatureError" title="enum GMimeSignatureError"><span class="returnvalue">GMimeSignatureError</span></a> g_mime_signature_get_errors (<em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>);</pre>
314 Get the signature errors. If the <a class="link" href="GMimeSignature.html#GMimeSignatureStatus" title="enum GMimeSignatureStatus"><span class="type">GMimeSignatureStatus</span></a> returned from
315 <a class="link" href="GMimeSignature.html#g-mime-signature-get-status" title="g_mime_signature_get_status ()"><code class="function">g_mime_signature_get_status()</code></a> is not <a class="link" href="GMimeSignature.html#GMIME-SIGNATURE-STATUS-GOOD:CAPS"><span class="type">GMIME_SIGNATURE_STATUS_GOOD</span></a>, then the
316 errors may provide a clue as to why.
318 <div class="variablelist"><table border="0">
319 <col align="left" valign="top">
322 <td><p><span class="term"><em class="parameter"><code>sig</code></em> :</span></p></td>
323 <td>a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a>
327 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
328 <td>a bitfield of errors.</td>
334 <div class="refsect2">
335 <a name="g-mime-signature-set-errors"></a><h3>g_mime_signature_set_errors ()</h3>
336 <pre class="programlisting"><span class="returnvalue">void</span> g_mime_signature_set_errors (<em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>,
337 <em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureError" title="enum GMimeSignatureError"><span class="type">GMimeSignatureError</span></a> errors</code></em>);</pre>
339 Set the errors on the signature.
341 <div class="variablelist"><table border="0">
342 <col align="left" valign="top">
345 <td><p><span class="term"><em class="parameter"><code>sig</code></em> :</span></p></td>
346 <td>a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a>
350 <td><p><span class="term"><em class="parameter"><code>errors</code></em> :</span></p></td>
351 <td>a <a class="link" href="GMimeSignature.html#GMimeSignatureError" title="enum GMimeSignatureError"><span class="type">GMimeSignatureError</span></a>
358 <div class="refsect2">
359 <a name="g-mime-signature-get-created"></a><h3>g_mime_signature_get_created ()</h3>
360 <pre class="programlisting"><span class="returnvalue">time_t</span> g_mime_signature_get_created (<em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>);</pre>
362 Get the creation date of the signature.
364 <div class="variablelist"><table border="0">
365 <col align="left" valign="top">
368 <td><p><span class="term"><em class="parameter"><code>sig</code></em> :</span></p></td>
369 <td>a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a>
373 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
374 <td>the creation date of the signature or <code class="literal">-1</code> if unknown.</td>
380 <div class="refsect2">
381 <a name="g-mime-signature-set-created"></a><h3>g_mime_signature_set_created ()</h3>
382 <pre class="programlisting"><span class="returnvalue">void</span> g_mime_signature_set_created (<em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>,
383 <em class="parameter"><code><span class="type">time_t</span> created</code></em>);</pre>
385 Set the creation date of the signature.
387 <div class="variablelist"><table border="0">
388 <col align="left" valign="top">
391 <td><p><span class="term"><em class="parameter"><code>sig</code></em> :</span></p></td>
392 <td>a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a>
396 <td><p><span class="term"><em class="parameter"><code>created</code></em> :</span></p></td>
397 <td>creation date</td>
403 <div class="refsect2">
404 <a name="g-mime-signature-get-expires"></a><h3>g_mime_signature_get_expires ()</h3>
405 <pre class="programlisting"><span class="returnvalue">time_t</span> g_mime_signature_get_expires (<em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>);</pre>
407 Get the expiration date of the signature.
409 <div class="variablelist"><table border="0">
410 <col align="left" valign="top">
413 <td><p><span class="term"><em class="parameter"><code>sig</code></em> :</span></p></td>
414 <td>a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a>
418 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
419 <td>the expiration date of the signature or <code class="literal">-1</code> if unknown.</td>
425 <div class="refsect2">
426 <a name="g-mime-signature-set-expires"></a><h3>g_mime_signature_set_expires ()</h3>
427 <pre class="programlisting"><span class="returnvalue">void</span> g_mime_signature_set_expires (<em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>,
428 <em class="parameter"><code><span class="type">time_t</span> expires</code></em>);</pre>
430 Set the expiration date of the signature.
432 <div class="variablelist"><table border="0">
433 <col align="left" valign="top">
436 <td><p><span class="term"><em class="parameter"><code>sig</code></em> :</span></p></td>
437 <td>a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a>
441 <td><p><span class="term"><em class="parameter"><code>expires</code></em> :</span></p></td>
442 <td>expiration date</td>
448 <div class="refsect2">
449 <a name="GMimeSignatureList-struct"></a><h3>struct GMimeSignatureList</h3>
450 <pre class="programlisting">struct GMimeSignatureList;</pre>
452 A collection of <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> objects.
454 <div class="variablelist"><table border="0">
455 <col align="left" valign="top">
460 <div class="refsect2">
461 <a name="g-mime-signature-list-new"></a><h3>g_mime_signature_list_new ()</h3>
462 <pre class="programlisting"><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="returnvalue">GMimeSignatureList</span></a> * g_mime_signature_list_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
464 Creates a new <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a>.
466 <div class="variablelist"><table border="0">
467 <col align="left" valign="top">
469 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
470 <td>a new <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a>.</td>
475 <div class="refsect2">
476 <a name="g-mime-signature-list-length"></a><h3>g_mime_signature_list_length ()</h3>
477 <pre class="programlisting"><span class="returnvalue">int</span> g_mime_signature_list_length (<em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *list</code></em>);</pre>
479 Gets the length of the list.
481 <div class="variablelist"><table border="0">
482 <col align="left" valign="top">
485 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
486 <td>a <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a>
490 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
491 <td>the number of <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> objects in the list.</td>
497 <div class="refsect2">
498 <a name="g-mime-signature-list-clear"></a><h3>g_mime_signature_list_clear ()</h3>
499 <pre class="programlisting"><span class="returnvalue">void</span> g_mime_signature_list_clear (<em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *list</code></em>);</pre>
501 Clears the list of addresses.
503 <div class="variablelist"><table border="0">
504 <col align="left" valign="top">
506 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
507 <td>a <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a>
513 <div class="refsect2">
514 <a name="g-mime-signature-list-add"></a><h3>g_mime_signature_list_add ()</h3>
515 <pre class="programlisting"><span class="returnvalue">int</span> g_mime_signature_list_add (<em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *list</code></em>,
516 <em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>);</pre>
518 Adds a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> to the <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a>.
520 <div class="variablelist"><table border="0">
521 <col align="left" valign="top">
524 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
525 <td>a <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a>
529 <td><p><span class="term"><em class="parameter"><code>sig</code></em> :</span></p></td>
530 <td>a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a>
534 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
535 <td>the index of the added <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a>.</td>
541 <div class="refsect2">
542 <a name="g-mime-signature-list-insert"></a><h3>g_mime_signature_list_insert ()</h3>
543 <pre class="programlisting"><span class="returnvalue">void</span> g_mime_signature_list_insert (<em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *list</code></em>,
544 <em class="parameter"><code><span class="type">int</span> index</code></em>,
545 <em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>);</pre>
547 Inserts a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> into the <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> at the specified
550 <div class="variablelist"><table border="0">
551 <col align="left" valign="top">
554 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
555 <td>a <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a>
559 <td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td>
560 <td>index to insert at</td>
563 <td><p><span class="term"><em class="parameter"><code>sig</code></em> :</span></p></td>
564 <td>a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a>
571 <div class="refsect2">
572 <a name="g-mime-signature-list-remove"></a><h3>g_mime_signature_list_remove ()</h3>
573 <pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_signature_list_remove (<em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *list</code></em>,
574 <em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>);</pre>
576 Removes a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> from the <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a>.
578 <div class="variablelist"><table border="0">
579 <col align="left" valign="top">
582 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
583 <td>a <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a>
587 <td><p><span class="term"><em class="parameter"><code>sig</code></em> :</span></p></td>
588 <td>a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a>
592 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
594 <code class="literal">TRUE</code> if the specified <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> was removed or <code class="literal">FALSE</code>
601 <div class="refsect2">
602 <a name="g-mime-signature-list-remove-at"></a><h3>g_mime_signature_list_remove_at ()</h3>
603 <pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_signature_list_remove_at (<em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *list</code></em>,
604 <em class="parameter"><code><span class="type">int</span> index</code></em>);</pre>
606 Removes a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> from the <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> at the specified
609 <div class="variablelist"><table border="0">
610 <col align="left" valign="top">
613 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
614 <td>a <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a>
618 <td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td>
619 <td>index to remove</td>
622 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
624 <code class="literal">TRUE</code> if an <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> was removed or <code class="literal">FALSE</code> otherwise.</td>
630 <div class="refsect2">
631 <a name="g-mime-signature-list-contains"></a><h3>g_mime_signature_list_contains ()</h3>
632 <pre class="programlisting"><span class="returnvalue">gboolean</span> g_mime_signature_list_contains (<em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *list</code></em>,
633 <em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>);</pre>
635 Checks whether or not the specified <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> is contained within
636 the <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a>.
638 <div class="variablelist"><table border="0">
639 <col align="left" valign="top">
642 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
643 <td>a <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a>
647 <td><p><span class="term"><em class="parameter"><code>sig</code></em> :</span></p></td>
648 <td>a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a>
652 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
654 <code class="literal">TRUE</code> if the specified <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> is contained within the
655 specified <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> or <code class="literal">FALSE</code> otherwise.</td>
661 <div class="refsect2">
662 <a name="g-mime-signature-list-index-of"></a><h3>g_mime_signature_list_index_of ()</h3>
663 <pre class="programlisting"><span class="returnvalue">int</span> g_mime_signature_list_index_of (<em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *list</code></em>,
664 <em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>);</pre>
666 Gets the index of the specified <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> inside the
667 <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a>.
669 <div class="variablelist"><table border="0">
670 <col align="left" valign="top">
673 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
674 <td>a <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a>
678 <td><p><span class="term"><em class="parameter"><code>sig</code></em> :</span></p></td>
679 <td>a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a>
683 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
684 <td>the index of the requested <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> within the
685 <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> or <code class="literal">-1</code> if it is not contained within the
686 <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a>.</td>
692 <div class="refsect2">
693 <a name="g-mime-signature-list-get-signature"></a><h3>g_mime_signature_list_get_signature ()</h3>
694 <pre class="programlisting"><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="returnvalue">GMimeSignature</span></a> * g_mime_signature_list_get_signature (<em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *list</code></em>,
695 <em class="parameter"><code><span class="type">int</span> index</code></em>);</pre>
697 Gets the <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> at the specified index.
699 <div class="variablelist"><table border="0">
700 <col align="left" valign="top">
703 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
704 <td>a <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a>
708 <td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td>
709 <td>index of <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> to get</td>
712 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
713 <td>the <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> at the specified index or <code class="literal">NULL</code> if
714 the index is out of range.</td>
720 <div class="refsect2">
721 <a name="g-mime-signature-list-set-signature"></a><h3>g_mime_signature_list_set_signature ()</h3>
722 <pre class="programlisting"><span class="returnvalue">void</span> g_mime_signature_list_set_signature (<em class="parameter"><code><a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a> *list</code></em>,
723 <em class="parameter"><code><span class="type">int</span> index</code></em>,
724 <em class="parameter"><code><a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> *sig</code></em>);</pre>
726 Sets the <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> at the specified index to <em class="parameter"><code>sig</code></em>.
728 <div class="variablelist"><table border="0">
729 <col align="left" valign="top">
732 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
733 <td>a <a class="link" href="GMimeSignature.html#GMimeSignatureList"><span class="type">GMimeSignatureList</span></a>
737 <td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td>
738 <td>index of <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a> to set</td>
741 <td><p><span class="term"><em class="parameter"><code>sig</code></em> :</span></p></td>
742 <td>a <a class="link" href="GMimeSignature.html" title="GMimeSignature"><span class="type">GMimeSignature</span></a>
752 Generated by GTK-Doc V1.18</div>