docs/reference/html/index.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 2.6 Reference Manual</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <meta name="description" content="This manual documents the interfaces of the GMime library and has some short notes to help get you up to speed with using the library.">
   8 <link rel="home" href="index.html" title="GMime 2.6 Reference Manual">
   9 <link rel="next" href="gmime.html" title="Part I. GMime Overview">
  10 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
  11 <link rel="stylesheet" href="style.css" type="text/css">
  12 </head>
  13 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  14 <div class="book">
  15 <div class="titlepage">
  16 <div>
  17 <div><table class="navigation" id="top" width="100%" cellpadding="2" cellspacing="0"><tr><th valign="middle"><p class="title">GMime 2.6 Reference Manual</p></th></tr></table></div>
  18 <div><div class="authorgroup"><div class="author">
  19 <h3 class="author">
  20 <span class="firstname">Jeffrey</span> <span class="surname">Stedfast</span>
  21 </h3>
  22 <div class="affiliation"><div class="address"><p><br>
  23             <code class="email">&lt;<a class="email" href="mailto:fejj@gnome.org">fejj@gnome.org</a>&gt;</code><br>
  24           </p></div></div>
  25 </div></div></div>
  26 <div><p class="copyright">Copyright © 2000-2011 Jeffrey Stedfast</p></div>
  27 <div><div class="legalnotice">
  28 <a name="idp251088"></a><p>
  29         This library is free software; you can redistribute it and/or
  30         modify it under the terms of the GNU Lesser General Public
  31         License as published by the Free Software Foundation; either
  32         version 2.1 of the License, or (at your option) any later version.
  33       </p>
  34 <p>
  35         This library is distributed in the hope that it will be useful,
  36         but WITHOUT ANY WARRANTY; without even the implied warranty of
  37         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  38         Lesser General Public License for more details.
  39       </p>
  40 <p>
  41         You should have received a copy of the GNU Lesser General Public
  42         License along with this library; if not, write to the Free Software
  43         Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  44         02110-1301, USA.
  45       </p>
  46 </div></div>
  47 <div><div class="abstract">
  48 <p class="title"><b>Abstract</b></p>
  49 <p>This manual documents the interfaces of the GMime
  50       library and has some short notes to help get you up to speed
  51       with using the library.</p>
  52 </div></div>
  53 </div>
  54 <hr>
  55 </div>
  56 <div class="toc"><dl>
  57 <dt><span class="part"><a href="gmime.html">I. GMime Overview</a></span></dt>
  58 <dd><dl>
  59 <dt>
  60 <span class="refentrytitle"><a href="gmime-building.html">Compiling the GMime libraries</a></span><span class="refpurpose"> — How to compile GMime itself</span>
  61 </dt>
  62 <dt>
  63 <span class="refentrytitle"><a href="gmime-compiling.html">Compiling GMime Applications</a></span><span class="refpurpose"> —
  64 How to compile your GMime application
  65 </span>
  66 </dt>
  67 <dt>
  68 <span class="refentrytitle"><a href="gmime-changes-2-0.html">Changes from 1.0 to 2.0</a></span><span class="refpurpose"> —
  69 Incompatible changes made between version 1.0 and version 2.0
  70 </span>
  71 </dt>
  72 <dt>
  73 <span class="refentrytitle"><a href="gmime-changes-2-2.html">Changes from 2.0 to 2.2</a></span><span class="refpurpose"> — Incompatible changes made between version 2.0 and version 2.2</span>
  74 </dt>
  75 <dt>
  76 <span class="refentrytitle"><a href="gmime-changes-2-4.html">Changes from 2.2 to 2.4</a></span><span class="refpurpose"> — Changes made between version 2.2 and version 2.4</span>
  77 </dt>
  78 <dt>
  79 <span class="refentrytitle"><a href="gmime-changes-2-6.html">Changes from 2.4 to 2.6</a></span><span class="refpurpose"> — Changes made between version 2.4 and version 2.6</span>
  80 </dt>
  81 <dt>
  82 <span class="refentrytitle"><a href="gmime-resources.html">Mailing lists and bug reports</a></span><span class="refpurpose"> —
  83 Getting help with GMime
  84 </span>
  85 </dt>
  86 <dt>
  87 <span class="refentrytitle"><a href="gmime-question-index.html">Frequently Asked Questions</a></span><span class="refpurpose"> —
  88 Find answers to common questions in the GMime manual
  89 </span>
  90 </dt>
  91 </dl></dd>
  92 <dt><span class="part"><a href="fundamentals.html">II. GMime Fundamentals</a></span></dt>
  93 <dd><dl>
  94 <dt>
  95 <span class="refentrytitle"><a href="gmime-streams.html">GMime Streams</a></span><span class="refpurpose"> — How to use GMime Streams</span>
  96 </dt>
  97 <dt>
  98 <span class="refentrytitle"><a href="gmime-filters.html">GMime Stream Filters</a></span><span class="refpurpose"> — How to use GMime Stream Filters</span>
  99 </dt>
 100 <dt>
 101 <span class="refentrytitle"><a href="gmime-data-wrappers.html">GMime Data Wrappers</a></span><span class="refpurpose"> — How to use GMime Data Wrappers</span>
 102 </dt>
 103 </dl></dd>
 104 <dt><span class="part"><a href="core.html">III. GMime Core Reference</a></span></dt>
 105 <dd><dl>
 106 <dt>
 107 <span class="refentrytitle"><a href="gmime-gmime.html">gmime</a></span><span class="refpurpose"> — Initialization, shutdown and version-check routines</span>
 108 </dt>
 109 <dt>
 110 <span class="refentrytitle"><a href="gmime-gmime-charset.html">gmime-charset</a></span><span class="refpurpose"> — Charset helper functions</span>
 111 </dt>
 112 <dt>
 113 <span class="refentrytitle"><a href="gmime-gmime-iconv.html">gmime-iconv</a></span><span class="refpurpose"> — Low-level routines for converting text from one charset to another</span>
 114 </dt>
 115 <dt>
 116 <span class="refentrytitle"><a href="gmime-gmime-iconv-utils.html">gmime-iconv-utils</a></span><span class="refpurpose"> — High-level routines for converting text from one charset to another</span>
 117 </dt>
 118 <dt>
 119 <span class="refentrytitle"><a href="gmime-gmime-encodings.html">gmime-encodings</a></span><span class="refpurpose"> — MIME encoding functions</span>
 120 </dt>
 121 <dt>
 122 <span class="refentrytitle"><a href="gmime-gmime-utils.html">gmime-utils</a></span><span class="refpurpose"> — MIME utility functions</span>
 123 </dt>
 124 </dl></dd>
 125 <dt><span class="part"><a href="classes.html">IV. GMime Classes</a></span></dt>
 126 <dd><dl>
 127 <dt><span class="chapter"><a href="ch01.html">Class hierarchy</a></span></dt>
 128 <dt><span class="chapter"><a href="Streams.html">Streams</a></span></dt>
 129 <dd><dl>
 130 <dt>
 131 <span class="refentrytitle"><a href="GMimeStream.html">GMimeStream</a></span><span class="refpurpose"> — Abstract stream class</span>
 132 </dt>
 133 <dt>
 134 <span class="refentrytitle"><a href="GMimeStreamFile.html">GMimeStreamFile</a></span><span class="refpurpose"> — A Standard-C FILE-based stream</span>
 135 </dt>
 136 <dt>
 137 <span class="refentrytitle"><a href="GMimeStreamFs.html">GMimeStreamFs</a></span><span class="refpurpose"> — A low-level FileSystem stream</span>
 138 </dt>
 139 <dt>
 140 <span class="refentrytitle"><a href="GMimeStreamMem.html">GMimeStreamMem</a></span><span class="refpurpose"> — A memory-backed stream</span>
 141 </dt>
 142 <dt>
 143 <span class="refentrytitle"><a href="GMimeStreamMmap.html">GMimeStreamMmap</a></span><span class="refpurpose"> — A memory-mapped file stream</span>
 144 </dt>
 145 <dt>
 146 <span class="refentrytitle"><a href="GMimeStreamNull.html">GMimeStreamNull</a></span><span class="refpurpose"> — A null stream</span>
 147 </dt>
 148 <dt>
 149 <span class="refentrytitle"><a href="GMimeStreamFilter.html">GMimeStreamFilter</a></span><span class="refpurpose"> — A filtering stream</span>
 150 </dt>
 151 <dt>
 152 <span class="refentrytitle"><a href="GMimeStreamBuffer.html">GMimeStreamBuffer</a></span><span class="refpurpose"> — A buffered stream</span>
 153 </dt>
 154 <dt>
 155 <span class="refentrytitle"><a href="GMimeStreamPipe.html">GMimeStreamPipe</a></span><span class="refpurpose"> — A low-level pipe stream</span>
 156 </dt>
 157 <dt>
 158 <span class="refentrytitle"><a href="GMimeStreamCat.html">GMimeStreamCat</a></span><span class="refpurpose"> — A concatenated stream</span>
 159 </dt>
 160 </dl></dd>
 161 <dt><span class="chapter"><a href="Filters.html">Stream Filters</a></span></dt>
 162 <dd><dl>
 163 <dt>
 164 <span class="refentrytitle"><a href="GMimeFilter.html">GMimeFilter</a></span><span class="refpurpose"> — Abstract filter class</span>
 165 </dt>
 166 <dt>
 167 <span class="refentrytitle"><a href="GMimeFilterBasic.html">GMimeFilterBasic</a></span><span class="refpurpose"> — Basic transfer encoding filter</span>
 168 </dt>
 169 <dt>
 170 <span class="refentrytitle"><a href="GMimeFilterBest.html">GMimeFilterBest</a></span><span class="refpurpose"> — Determine the best charset/encoding to use for a stream</span>
 171 </dt>
 172 <dt>
 173 <span class="refentrytitle"><a href="GMimeFilterCharset.html">GMimeFilterCharset</a></span><span class="refpurpose"> — Charset-conversion filter</span>
 174 </dt>
 175 <dt>
 176 <span class="refentrytitle"><a href="GMimeFilterCRLF.html">GMimeFilterCRLF</a></span><span class="refpurpose"> — Convert line-endings from LF to CRLF or vise versa</span>
 177 </dt>
 178 <dt>
 179 <span class="refentrytitle"><a href="GMimeFilterEnriched.html">GMimeFilterEnriched</a></span><span class="refpurpose"> — Convert text/enriched or text/rtf to HTML</span>
 180 </dt>
 181 <dt>
 182 <span class="refentrytitle"><a href="GMimeFilterFrom.html">GMimeFilterFrom</a></span><span class="refpurpose"> — Escape MBox From_ lines</span>
 183 </dt>
 184 <dt>
 185 <span class="refentrytitle"><a href="GMimeFilterGZip.html">GMimeFilterGZip</a></span><span class="refpurpose"> — GNU Zip compression/decompression</span>
 186 </dt>
 187 <dt>
 188 <span class="refentrytitle"><a href="GMimeFilterHTML.html">GMimeFilterHTML</a></span><span class="refpurpose"> — Convert plain text into HTML</span>
 189 </dt>
 190 <dt>
 191 <span class="refentrytitle"><a href="GMimeFilterMd5.html">GMimeFilterMd5</a></span><span class="refpurpose"> — Calculate an md5sum</span>
 192 </dt>
 193 <dt>
 194 <span class="refentrytitle"><a href="GMimeFilterStrip.html">GMimeFilterStrip</a></span><span class="refpurpose"> — Strip trailing whitespace from the end of lines</span>
 195 </dt>
 196 <dt>
 197 <span class="refentrytitle"><a href="GMimeFilterWindows.html">GMimeFilterWindows</a></span><span class="refpurpose"> — Determine if text is in a Microsoft Windows codepage</span>
 198 </dt>
 199 <dt>
 200 <span class="refentrytitle"><a href="GMimeFilterYenc.html">GMimeFilterYenc</a></span><span class="refpurpose"> — yEncode or yDecode</span>
 201 </dt>
 202 </dl></dd>
 203 <dt><span class="chapter"><a href="DataWrappers.html">Data Wrappers</a></span></dt>
 204 <dd><dl><dt>
 205 <span class="refentrytitle"><a href="GMimeDataWrapper.html">GMimeDataWrapper</a></span><span class="refpurpose"> — Content objects</span>
 206 </dt></dl></dd>
 207 <dt><span class="chapter"><a href="Headers.html">Message and MIME Headers</a></span></dt>
 208 <dd><dl>
 209 <dt>
 210 <span class="refentrytitle"><a href="gmime-GMimeHeader.html">GMimeHeader</a></span><span class="refpurpose"> — Message and MIME part headers</span>
 211 </dt>
 212 <dt>
 213 <span class="refentrytitle"><a href="GMimeContentType.html">GMimeContentType</a></span><span class="refpurpose"> — Content-Type fields</span>
 214 </dt>
 215 <dt>
 216 <span class="refentrytitle"><a href="GMimeContentDisposition.html">GMimeContentDisposition</a></span><span class="refpurpose"> — Content-Disposition fields</span>
 217 </dt>
 218 <dt>
 219 <span class="refentrytitle"><a href="gmime-GMimeParam.html">GMimeParam</a></span><span class="refpurpose"> — Content-Type and Content-Disposition parameters</span>
 220 </dt>
 221 </dl></dd>
 222 <dt><span class="chapter"><a href="InternetAddresses.html">Internet Addresses</a></span></dt>
 223 <dd><dl>
 224 <dt>
 225 <span class="refentrytitle"><a href="InternetAddress.html">InternetAddress</a></span><span class="refpurpose"> — Internet addresses</span>
 226 </dt>
 227 <dt>
 228 <span class="refentrytitle"><a href="InternetAddressGroup.html">InternetAddressGroup</a></span><span class="refpurpose"> — rfc822 'group' address</span>
 229 </dt>
 230 <dt>
 231 <span class="refentrytitle"><a href="InternetAddressMailbox.html">InternetAddressMailbox</a></span><span class="refpurpose"> — rfc822 'mailbox' address</span>
 232 </dt>
 233 <dt>
 234 <span class="refentrytitle"><a href="InternetAddressList.html">InternetAddressList</a></span><span class="refpurpose"> — A list of internet addresses</span>
 235 </dt>
 236 </dl></dd>
 237 <dt><span class="chapter"><a href="MimeParts.html">MIME Messages and Parts</a></span></dt>
 238 <dd><dl>
 239 <dt>
 240 <span class="refentrytitle"><a href="GMimeObject.html">GMimeObject</a></span><span class="refpurpose"> — Abstract MIME objects</span>
 241 </dt>
 242 <dt>
 243 <span class="refentrytitle"><a href="GMimeMessage.html">GMimeMessage</a></span><span class="refpurpose"> — Messages</span>
 244 </dt>
 245 <dt>
 246 <span class="refentrytitle"><a href="GMimePart.html">GMimePart</a></span><span class="refpurpose"> — MIME parts</span>
 247 </dt>
 248 <dt>
 249 <span class="refentrytitle"><a href="GMimeMultipart.html">GMimeMultipart</a></span><span class="refpurpose"> — MIME multiparts</span>
 250 </dt>
 251 <dt>
 252 <span class="refentrytitle"><a href="GMimeMultipartEncrypted.html">GMimeMultipartEncrypted</a></span><span class="refpurpose"> — Encrypted MIME multiparts</span>
 253 </dt>
 254 <dt>
 255 <span class="refentrytitle"><a href="GMimeMultipartSigned.html">GMimeMultipartSigned</a></span><span class="refpurpose"> — Signed MIME multiparts</span>
 256 </dt>
 257 <dt>
 258 <span class="refentrytitle"><a href="GMimeMessagePart.html">GMimeMessagePart</a></span><span class="refpurpose"> — Message parts</span>
 259 </dt>
 260 <dt>
 261 <span class="refentrytitle"><a href="GMimeMessagePartial.html">GMimeMessagePartial</a></span><span class="refpurpose"> — Partial MIME parts</span>
 262 </dt>
 263 <dt>
 264 <span class="refentrytitle"><a href="gmime-GMimePartIter.html">GMimePartIter</a></span><span class="refpurpose"> — MIME part iterators</span>
 265 </dt>
 266 </dl></dd>
 267 <dt><span class="chapter"><a href="Parsers.html">Parsing Messages and MIME Parts</a></span></dt>
 268 <dd><dl><dt>
 269 <span class="refentrytitle"><a href="GMimeParser.html">GMimeParser</a></span><span class="refpurpose"> — Message and MIME part parser</span>
 270 </dt></dl></dd>
 271 <dt><span class="chapter"><a href="CryptoContexts.html">Cryptography Contexts</a></span></dt>
 272 <dd><dl>
 273 <dt>
 274 <span class="refentrytitle"><a href="GMimeCertificate.html">GMimeCertificate</a></span><span class="refpurpose"> — Digital certificates</span>
 275 </dt>
 276 <dt>
 277 <span class="refentrytitle"><a href="GMimeSignature.html">GMimeSignature</a></span><span class="refpurpose"> — Digital signatures</span>
 278 </dt>
 279 <dt>
 280 <span class="refentrytitle"><a href="GMimeCryptoContext.html">GMimeCryptoContext</a></span><span class="refpurpose"> — Encryption/signing contexts</span>
 281 </dt>
 282 <dt>
 283 <span class="refentrytitle"><a href="GMimeGpgContext.html">GMimeGpgContext</a></span><span class="refpurpose"> — GnuPG crypto contexts</span>
 284 </dt>
 285 <dt>
 286 <span class="refentrytitle"><a href="GMimePkcs7Context.html">GMimePkcs7Context</a></span><span class="refpurpose"> — PKCS7 crypto contexts</span>
 287 </dt>
 288 </dl></dd>
 289 </dl></dd>
 290 </dl></div>
 291 </div>
 292 <div class="footer">
 293 <hr>
 294           Generated by GTK-Doc V1.18</div>
 295 </body>
 296 </html>