docs/reference/gmime-docs.sgml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
   4 <!ENTITY gmime-Init SYSTEM "xml/gmime.xml">
   5 <!ENTITY GMimeParam SYSTEM "xml/gmime-param.xml">
   6 <!ENTITY GMimeHeader SYSTEM "xml/gmime-header.xml">
   7 <!ENTITY GMimeContentType SYSTEM "xml/gmime-content-type.xml">
   8 <!ENTITY GMimeDisposition SYSTEM "xml/gmime-disposition.xml">
   9 <!ENTITY GMimeObject SYSTEM "xml/gmime-object.xml">
  10 <!ENTITY GMimeDataWrapper SYSTEM "xml/gmime-data-wrapper.xml">
  11 <!ENTITY GMimeMultipart SYSTEM "xml/gmime-multipart.xml">
  12 <!ENTITY GMimeMultipartEncrypted SYSTEM "xml/gmime-multipart-encrypted.xml">
  13 <!ENTITY GMimeMultipartSigned SYSTEM "xml/gmime-multipart-signed.xml">
  14 <!ENTITY GMimePart SYSTEM "xml/gmime-part.xml">
  15 <!ENTITY GMimePartIter SYSTEM "xml/gmime-part-iter.xml">
  16 <!ENTITY GMimeMessage SYSTEM "xml/gmime-message.xml">
  17 <!ENTITY GMimeMessagePart SYSTEM "xml/gmime-message-part.xml">
  18 <!ENTITY GMimeMessagePartial SYSTEM "xml/gmime-message-partial.xml">
  19 <!ENTITY gmime-utils SYSTEM "xml/gmime-utils.xml">
  20 <!ENTITY gmime-encodings SYSTEM "xml/gmime-encodings.xml">
  21 <!ENTITY InternetAddress SYSTEM "xml/internet-address.xml">
  22 <!ENTITY InternetAddressGroup SYSTEM "xml/internet-address-group.xml">
  23 <!ENTITY InternetAddressMailbox SYSTEM "xml/internet-address-mailbox.xml">
  24 <!ENTITY InternetAddressList SYSTEM "xml/internet-address-list.xml">
  25 <!ENTITY GMimeParser SYSTEM "xml/gmime-parser.xml">
  26 <!ENTITY gmime-charset SYSTEM "xml/gmime-charset.xml">
  27 <!ENTITY gmime-iconv SYSTEM "xml/gmime-iconv.xml">
  28 <!ENTITY gmime-iconv-utils SYSTEM "xml/gmime-iconv-utils.xml">
  29 <!ENTITY GMimeStream SYSTEM "xml/gmime-stream.xml">
  30 <!ENTITY GMimeStreamBuffer SYSTEM "xml/gmime-stream-buffer.xml">
  31 <!ENTITY GMimeStreamCat SYSTEM "xml/gmime-stream-cat.xml">
  32 <!ENTITY GMimeStreamFile SYSTEM "xml/gmime-stream-file.xml">
  33 <!ENTITY GMimeStreamFs SYSTEM "xml/gmime-stream-fs.xml">
  34 <!ENTITY GMimeStreamGIO SYSTEM "xml/gmime-stream-gio.xml">
  35 <!ENTITY GMimeStreamMem SYSTEM "xml/gmime-stream-mem.xml">
  36 <!ENTITY GMimeStreamMmap SYSTEM "xml/gmime-stream-mmap.xml">
  37 <!ENTITY GMimeStreamNull SYSTEM "xml/gmime-stream-null.xml">
  38 <!ENTITY GMimeStreamPipe SYSTEM "xml/gmime-stream-pipe.xml">
  39 <!ENTITY GMimeStreamFilter SYSTEM "xml/gmime-stream-filter.xml">
  40 <!ENTITY GMimeFilter SYSTEM "xml/gmime-filter.xml">
  41 <!ENTITY GMimeFilterBasic SYSTEM "xml/gmime-filter-basic.xml">
  42 <!ENTITY GMimeFilterBest SYSTEM "xml/gmime-filter-best.xml">
  43 <!ENTITY GMimeFilterCharset SYSTEM "xml/gmime-filter-charset.xml">
  44 <!ENTITY GMimeFilterCRLF SYSTEM "xml/gmime-filter-crlf.xml">
  45 <!ENTITY GMimeFilterEnriched SYSTEM "xml/gmime-filter-enriched.xml">
  46 <!ENTITY GMimeFilterFrom SYSTEM "xml/gmime-filter-from.xml">
  47 <!ENTITY GMimeFilterGZip SYSTEM "xml/gmime-filter-gzip.xml">
  48 <!ENTITY GMimeFilterHTML SYSTEM "xml/gmime-filter-html.xml">
  49 <!ENTITY GMimeFilterMd5 SYSTEM "xml/gmime-filter-md5.xml">
  50 <!ENTITY GMimeFilterStrip SYSTEM "xml/gmime-filter-strip.xml">
  51 <!ENTITY GMimeFilterWindows SYSTEM "xml/gmime-filter-windows.xml">
  52 <!ENTITY GMimeFilterYenc SYSTEM "xml/gmime-filter-yenc.xml">
  53 <!ENTITY GMimeCertificate SYSTEM "xml/gmime-certificate.xml">
  54 <!ENTITY GMimeSignature SYSTEM "xml/gmime-signature.xml">
  55 <!ENTITY GMimeCryptoContext SYSTEM "xml/gmime-crypto-context.xml">
  56 <!ENTITY GMimeGpgContext SYSTEM "xml/gmime-gpg-context.xml">
  57 <!ENTITY GMimePkcs7Context SYSTEM "xml/gmime-pkcs7-context.xml">
  58
  59 <!ENTITY index-Class-Tree SYSTEM "tree_index.sgml">
  60
  61 <!ENTITY gmime-Building SYSTEM "building.sgml">
  62 <!ENTITY gmime-Compiling SYSTEM "compiling.sgml">
  63 <!ENTITY gmime-Resources SYSTEM "resources.sgml">
  64 <!ENTITY gmime-Questions SYSTEM "question_index.sgml">
  65 <!ENTITY gmime-Changes-2-0 SYSTEM "changes-2.0.sgml">
  66 <!ENTITY gmime-Changes-2-2 SYSTEM "changes-2.2.sgml">
  67 <!ENTITY gmime-Changes-2-4 SYSTEM "changes-2.4.sgml">
  68 <!ENTITY gmime-Changes-2-6 SYSTEM "changes-2.6.sgml">
  69
  70 <!ENTITY gmime-Streams SYSTEM "streams.sgml">
  71 <!ENTITY gmime-Filters SYSTEM "filters.sgml">
  72 <!ENTITY gmime-DataWrappers SYSTEM "data-wrappers.sgml">
  73 ]>
  74
  75 <book id="index">
  76   <bookinfo>
  77     <title>GMime 2.6 Reference Manual</title>
  78     <authorgroup>
  79       <author>
  80         <firstname>Jeffrey</firstname>
  81         <surname>Stedfast</surname>
  82         <affiliation>
  83           <address>
  84             <email>fejj@gnome.org</email>
  85           </address>
  86         </affiliation>
  87       </author>
  88     </authorgroup>
  89     <copyright>
  90       <year>2000-2011</year>
  91       <holder>Jeffrey Stedfast</holder>
  92     </copyright>
  93
  94     <legalnotice>
  95       <para>
  96         This library is free software; you can redistribute it and/or
  97         modify it under the terms of the GNU Lesser General Public
  98         License as published by the Free Software Foundation; either
  99         version 2.1 of the License, or (at your option) any later version.
 100       </para>
 101       <para>
 102         This library is distributed in the hope that it will be useful,
 103         but WITHOUT ANY WARRANTY; without even the implied warranty of
 104         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 105         Lesser General Public License for more details.
 106       </para>
 107       <para>
 108         You should have received a copy of the GNU Lesser General Public
 109         License along with this library; if not, write to the Free Software
 110         Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 111         02110-1301, USA.
 112       </para>
 113     </legalnotice>
 114
 115     <abstract>
 116       <para>This manual documents the interfaces of the GMime
 117       library and has some short notes to help get you up to speed
 118       with using the library.</para>
 119     </abstract>
 120   </bookinfo>
 121
 122   <part id="gmime">
 123     <title>GMime Overview</title>
 124     <partintro>
 125       <para>
 126 GMime is a powerful MIME (Multipurpose Internet Mail Extension)
 127 utility library. It is meant for creating, editing, and parsing MIME
 128 messages and structures. GMime is released under the 2.1 version of
 129 the GNU Lesser General Public License. GMime is based on GLib 2.0's
 130 GObject system allowing for a lot of flexibility.
 131       </para>
 132       <para>
 133 GMime depends on the following libraries:
 134         <variablelist>
 135           <varlistentry>
 136             <term>GLib</term>
 137             <listitem>
 138               <para>
 139 A general-purpose utility library, not specific to graphical user interfaces.
 140 GLib provides many useful data types, macros, type conversions,
 141 string utilities, file utilities, a main loop abstraction, and so on.
 142               </para>
 143             </listitem>
 144           </varlistentry>
 145         </variablelist>
 146       </para>
 147     </partintro>
 148     &gmime-Building;
 149     &gmime-Compiling;
 150     &gmime-Changes-2-0;
 151     &gmime-Changes-2-2;
 152     &gmime-Changes-2-4;
 153     &gmime-Changes-2-6;
 154     &gmime-Resources;
 155     &gmime-Questions;
 156   </part>
 157
 158   <part id="fundamentals">
 159     <title>GMime Fundamentals</title>
 160     &gmime-Streams;
 161     &gmime-Filters;
 162     &gmime-DataWrappers;
 163   </part>
 164
 165   <part id="core">
 166     <title>GMime Core Reference</title>
 167     &gmime-Init;
 168     &gmime-charset;
 169     &gmime-iconv;
 170     &gmime-iconv-utils;
 171     &gmime-encodings;
 172     &gmime-utils;
 173   </part>
 174
 175   <part id="classes">
 176     <title>GMime Classes</title>
 177     <chapter>
 178       <title>Class hierarchy</title>
 179       &index-Class-Tree;
 180     </chapter>
 181
 182     <chapter id="Streams">
 183       <title>Streams</title>
 184       &GMimeStream;
 185       &GMimeStreamFile;
 186       &GMimeStreamFs;
 187       &GMimeStreamMem;
 188       &GMimeStreamMmap;
 189       &GMimeStreamNull;
 190       &GMimeStreamFilter;
 191       &GMimeStreamBuffer;
 192       &GMimeStreamPipe;
 193       &GMimeStreamCat;
 194     </chapter>
 195
 196     <chapter id="Filters">
 197       <title>Stream Filters</title>
 198       &GMimeFilter;
 199       &GMimeFilterBasic;
 200       &GMimeFilterBest;
 201       &GMimeFilterCharset;
 202       &GMimeFilterCRLF;
 203       &GMimeFilterEnriched;
 204       &GMimeFilterFrom;
 205       &GMimeFilterGZip;
 206       &GMimeFilterHTML;
 207       &GMimeFilterMd5;
 208       &GMimeFilterStrip;
 209       &GMimeFilterWindows;
 210       &GMimeFilterYenc;
 211     </chapter>
 212
 213     <chapter id="DataWrappers">
 214       <title>Data Wrappers</title>
 215       &GMimeDataWrapper;
 216     </chapter>
 217
 218     <chapter id="Headers">
 219       <title>Message and MIME Headers</title>
 220       &GMimeHeader;
 221       &GMimeContentType;
 222       &GMimeDisposition;
 223       &GMimeParam;
 224     </chapter>
 225
 226     <chapter id="InternetAddresses">
 227       <title>Internet Addresses</title>
 228       &InternetAddress;
 229       &InternetAddressGroup;
 230       &InternetAddressMailbox;
 231       &InternetAddressList;
 232     </chapter>
 233
 234     <chapter id="MimeParts">
 235       <title>MIME Messages and Parts</title>
 236       &GMimeObject;
 237       &GMimeMessage;
 238       &GMimePart;
 239       &GMimeMultipart;
 240       &GMimeMultipartEncrypted;
 241       &GMimeMultipartSigned;
 242       &GMimeMessagePart;
 243       &GMimeMessagePartial;
 244       &GMimePartIter;
 245     </chapter>
 246
 247     <chapter id="Parsers">
 248       <title>Parsing Messages and MIME Parts</title>
 249       &GMimeParser;
 250     </chapter>
 251
 252     <chapter id="CryptoContexts">
 253       <title>Cryptography Contexts</title>
 254       &GMimeCertificate;
 255       &GMimeSignature;
 256       &GMimeCryptoContext;
 257       &GMimeGpgContext;
 258       &GMimePkcs7Context;
 259     </chapter>
 260   </part>
 261 </book>