docs/reference/html/gmime-gmime.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>gmime</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="core.html" title="Part III. GMime Core Reference">
   9 <link rel="prev" href="core.html" title="Part III. GMime Core Reference">
  10 <link rel="next" href="gmime-gmime-charset.html" title="gmime-charset">
  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="core.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="core.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-gmime-charset.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="#gmime-gmime.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gmime-gmime.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="gmime-gmime"></a><div class="titlepage"></div>
  31 <div class="refnamediv"><table width="100%"><tr>
  32 <td valign="top">
  33 <h2><span class="refentrytitle"><a name="gmime-gmime.top_of_page"></a>gmime</span></h2>
  34 <p>gmime — Initialization, shutdown and version-check routines</p>
  35 </td>
  36 <td valign="top" align="right"></td>
  37 </tr></table></div>
  38 <div class="refsynopsisdiv">
  39 <a name="gmime-gmime.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis">#define             <a class="link" href="gmime-gmime.html#GMIME-MAJOR-VERSION:CAPS" title="GMIME_MAJOR_VERSION">GMIME_MAJOR_VERSION</a>
  41 #define             <a class="link" href="gmime-gmime.html#GMIME-MICRO-VERSION:CAPS" title="GMIME_MICRO_VERSION">GMIME_MICRO_VERSION</a>
  42 #define             <a class="link" href="gmime-gmime.html#GMIME-MINOR-VERSION:CAPS" title="GMIME_MINOR_VERSION">GMIME_MINOR_VERSION</a>
  43 #define             <a class="link" href="gmime-gmime.html#GMIME-BINARY-AGE:CAPS" title="GMIME_BINARY_AGE">GMIME_BINARY_AGE</a>
  44 #define             <a class="link" href="gmime-gmime.html#GMIME-INTERFACE-AGE:CAPS" title="GMIME_INTERFACE_AGE">GMIME_INTERFACE_AGE</a>
  45 #define             <a class="link" href="gmime-gmime.html#GMIME-CHECK-VERSION:CAPS" title="GMIME_CHECK_VERSION()">GMIME_CHECK_VERSION</a>                 (major,
  46                                                          minor,
  47                                                          micro)
  48 #define             <a class="link" href="gmime-gmime.html#GMIME-ENABLE-RFC2047-WORKAROUNDS:CAPS" title="GMIME_ENABLE_RFC2047_WORKAROUNDS">GMIME_ENABLE_RFC2047_WORKAROUNDS</a>
  49 <span class="returnvalue">void</span>                <a class="link" href="gmime-gmime.html#g-mime-init" title="g_mime_init ()">g_mime_init</a>                         (<em class="parameter"><code><span class="type">guint32</span> flags</code></em>);
  50 <span class="returnvalue">void</span>                <a class="link" href="gmime-gmime.html#g-mime-shutdown" title="g_mime_shutdown ()">g_mime_shutdown</a>                     (<em class="parameter"><code><span class="type">void</span></code></em>);
  51 extern const guint  <a class="link" href="gmime-gmime.html#gmime-major-version" title="gmime_major_version">gmime_major_version</a>;
  52 extern const guint  <a class="link" href="gmime-gmime.html#gmime-minor-version" title="gmime_minor_version">gmime_minor_version</a>;
  53 extern const guint  <a class="link" href="gmime-gmime.html#gmime-micro-version" title="gmime_micro_version">gmime_micro_version</a>;
  54 extern const guint  <a class="link" href="gmime-gmime.html#gmime-binary-age" title="gmime_binary_age">gmime_binary_age</a>;
  55 extern const guint  <a class="link" href="gmime-gmime.html#gmime-interface-age" title="gmime_interface_age">gmime_interface_age</a>;
  56 <span class="returnvalue">gboolean</span>            <a class="link" href="gmime-gmime.html#g-mime-check-version" title="g_mime_check_version ()">g_mime_check_version</a>                (<em class="parameter"><code><span class="type">guint</span> major</code></em>,
  57                                                          <em class="parameter"><code><span class="type">guint</span> minor</code></em>,
  58                                                          <em class="parameter"><code><span class="type">guint</span> micro</code></em>);
  59 </pre>
  60 </div>
  61 <div class="refsect1">
  62 <a name="gmime-gmime.description"></a><h2>Description</h2>
  63 <p>
  64 Initialization, shutdown, and version-check functions.
  65 </p>
  66 </div>
  67 <div class="refsect1">
  68 <a name="gmime-gmime.details"></a><h2>Details</h2>
  69 <div class="refsect2">
  70 <a name="GMIME-MAJOR-VERSION:CAPS"></a><h3>GMIME_MAJOR_VERSION</h3>
  71 <pre class="programlisting">#define GMIME_MAJOR_VERSION (2)
  72 </pre>
  73 <p>
  74 GMime's major version.
  75 </p>
  76 </div>
  77 <hr>
  78 <div class="refsect2">
  79 <a name="GMIME-MICRO-VERSION:CAPS"></a><h3>GMIME_MICRO_VERSION</h3>
  80 <pre class="programlisting">#define GMIME_MICRO_VERSION (15)
  81 </pre>
  82 <p>
  83 GMime's micro version.
  84 </p>
  85 </div>
  86 <hr>
  87 <div class="refsect2">
  88 <a name="GMIME-MINOR-VERSION:CAPS"></a><h3>GMIME_MINOR_VERSION</h3>
  89 <pre class="programlisting">#define GMIME_MINOR_VERSION (6)
  90 </pre>
  91 <p>
  92 GMime's minor version.
  93 </p>
  94 </div>
  95 <hr>
  96 <div class="refsect2">
  97 <a name="GMIME-BINARY-AGE:CAPS"></a><h3>GMIME_BINARY_AGE</h3>
  98 <pre class="programlisting">#define GMIME_BINARY_AGE    (615)
  99 </pre>
 100 <p>
 101 GMime's binary age.
 102 </p>
 103 </div>
 104 <hr>
 105 <div class="refsect2">
 106 <a name="GMIME-INTERFACE-AGE:CAPS"></a><h3>GMIME_INTERFACE_AGE</h3>
 107 <pre class="programlisting">#define GMIME_INTERFACE_AGE (15)
 108 </pre>
 109 <p>
 110 GMime's interface age.
 111 </p>
 112 </div>
 113 <hr>
 114 <div class="refsect2">
 115 <a name="GMIME-CHECK-VERSION:CAPS"></a><h3>GMIME_CHECK_VERSION()</h3>
 116 <pre class="programlisting">#define             GMIME_CHECK_VERSION(major,minor,micro)</pre>
 117 <p>
 118 Check whether a GMime version equal to or greater than
 119 <em class="parameter"><code>major</code></em>.<em class="parameter"><code>minor</code></em>.<em class="parameter"><code>micro</code></em> is present.
 120 </p>
 121 <div class="variablelist"><table border="0">
 122 <col align="left" valign="top">
 123 <tbody>
 124 <tr>
 125 <td><p><span class="term"><em class="parameter"><code>major</code></em> :</span></p></td>
 126 <td>Minimum major version</td>
 127 </tr>
 128 <tr>
 129 <td><p><span class="term"><em class="parameter"><code>minor</code></em> :</span></p></td>
 130 <td>Minimum minor version</td>
 131 </tr>
 132 <tr>
 133 <td><p><span class="term"><em class="parameter"><code>micro</code></em> :</span></p></td>
 134 <td>Minimum micro version</td>
 135 </tr>
 136 </tbody>
 137 </table></div>
 138 </div>
 139 <hr>
 140 <div class="refsect2">
 141 <a name="GMIME-ENABLE-RFC2047-WORKAROUNDS:CAPS"></a><h3>GMIME_ENABLE_RFC2047_WORKAROUNDS</h3>
 142 <pre class="programlisting">#define GMIME_ENABLE_RFC2047_WORKAROUNDS  (1 &lt;&lt; 0)
 143 </pre>
 144 <p>
 145 Initialization flag to enable workarounds for badly formed rfc2047
 146 encoded-words.
 147 </p>
 148 </div>
 149 <hr>
 150 <div class="refsect2">
 151 <a name="g-mime-init"></a><h3>g_mime_init ()</h3>
 152 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_init                         (<em class="parameter"><code><span class="type">guint32</span> flags</code></em>);</pre>
 153 <p>
 154 Initializes GMime.
 155 </p>
 156 <p>
 157 Note: Calls <a class="link" href="gmime-gmime-charset.html#g-mime-charset-map-init" title="g_mime_charset_map_init ()"><code class="function">g_mime_charset_map_init()</code></a> and <a class="link" href="gmime-gmime-iconv.html#g-mime-iconv-init" title="g_mime_iconv_init ()"><code class="function">g_mime_iconv_init()</code></a> as
 158 well.
 159 </p>
 160 <div class="variablelist"><table border="0">
 161 <col align="left" valign="top">
 162 <tbody><tr>
 163 <td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
 164 <td>initialization flags</td>
 165 </tr></tbody>
 166 </table></div>
 167 </div>
 168 <hr>
 169 <div class="refsect2">
 170 <a name="g-mime-shutdown"></a><h3>g_mime_shutdown ()</h3>
 171 <pre class="programlisting"><span class="returnvalue">void</span>                g_mime_shutdown                     (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 172 <p>
 173 Frees internally allocated tables created in <a class="link" href="gmime-gmime.html#g-mime-init" title="g_mime_init ()"><code class="function">g_mime_init()</code></a>. Also
 174 calls <a class="link" href="gmime-gmime-charset.html#g-mime-charset-map-shutdown" title="g_mime_charset_map_shutdown ()"><code class="function">g_mime_charset_map_shutdown()</code></a> and <a class="link" href="gmime-gmime-iconv.html#g-mime-iconv-shutdown" title="g_mime_iconv_shutdown ()"><code class="function">g_mime_iconv_shutdown()</code></a>.
 175 </p>
 176 </div>
 177 <hr>
 178 <div class="refsect2">
 179 <a name="gmime-major-version"></a><h3>gmime_major_version</h3>
 180 <pre class="programlisting">extern const guint gmime_major_version;
 181 </pre>
 182 <p>
 183 GMime's major version.
 184 </p>
 185 </div>
 186 <hr>
 187 <div class="refsect2">
 188 <a name="gmime-minor-version"></a><h3>gmime_minor_version</h3>
 189 <pre class="programlisting">extern const guint gmime_minor_version;
 190 </pre>
 191 <p>
 192 GMime's minor version.
 193 </p>
 194 </div>
 195 <hr>
 196 <div class="refsect2">
 197 <a name="gmime-micro-version"></a><h3>gmime_micro_version</h3>
 198 <pre class="programlisting">extern const guint gmime_micro_version;
 199 </pre>
 200 <p>
 201 GMime's micro version.
 202 </p>
 203 </div>
 204 <hr>
 205 <div class="refsect2">
 206 <a name="gmime-binary-age"></a><h3>gmime_binary_age</h3>
 207 <pre class="programlisting">extern const guint gmime_binary_age;
 208 </pre>
 209 <p>
 210 GMime's binary age.
 211 </p>
 212 </div>
 213 <hr>
 214 <div class="refsect2">
 215 <a name="gmime-interface-age"></a><h3>gmime_interface_age</h3>
 216 <pre class="programlisting">extern const guint gmime_interface_age;
 217 </pre>
 218 <p>
 219 GMime's interface age.
 220 </p>
 221 </div>
 222 <hr>
 223 <div class="refsect2">
 224 <a name="g-mime-check-version"></a><h3>g_mime_check_version ()</h3>
 225 <pre class="programlisting"><span class="returnvalue">gboolean</span>            g_mime_check_version                (<em class="parameter"><code><span class="type">guint</span> major</code></em>,
 226                                                          <em class="parameter"><code><span class="type">guint</span> minor</code></em>,
 227                                                          <em class="parameter"><code><span class="type">guint</span> micro</code></em>);</pre>
 228 <p>
 229 Checks that the GMime library version meets the requirements of the
 230 required version.
 231 </p>
 232 <div class="variablelist"><table border="0">
 233 <col align="left" valign="top">
 234 <tbody>
 235 <tr>
 236 <td><p><span class="term"><em class="parameter"><code>major</code></em> :</span></p></td>
 237 <td>Minimum major version</td>
 238 </tr>
 239 <tr>
 240 <td><p><span class="term"><em class="parameter"><code>minor</code></em> :</span></p></td>
 241 <td>Minimum minor version</td>
 242 </tr>
 243 <tr>
 244 <td><p><span class="term"><em class="parameter"><code>micro</code></em> :</span></p></td>
 245 <td>Minimum micro version</td>
 246 </tr>
 247 <tr>
 248 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 249 <td>
 250 <code class="literal">TRUE</code> if the requirement is met or <code class="literal">FALSE</code> otherwise.</td>
 251 </tr>
 252 </tbody>
 253 </table></div>
 254 </div>
 255 </div>
 256 </div>
 257 <div class="footer">
 258 <hr>
 259           Generated by GTK-Doc V1.18</div>
 260 </body>
 261 </html>