summaryrefslogtreecommitdiff
path: root/docs/reference/gmime-docs.sgml
blob: c60ee89b9f446726e727de505a37b27548a9b851 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY gmime-Init SYSTEM "xml/gmime.xml">
<!ENTITY GMimeParam SYSTEM "xml/gmime-param.xml">
<!ENTITY GMimeHeader SYSTEM "xml/gmime-header.xml">
<!ENTITY GMimeContentType SYSTEM "xml/gmime-content-type.xml">
<!ENTITY GMimeDisposition SYSTEM "xml/gmime-disposition.xml">
<!ENTITY GMimeObject SYSTEM "xml/gmime-object.xml">
<!ENTITY GMimeDataWrapper SYSTEM "xml/gmime-data-wrapper.xml">
<!ENTITY GMimeMultipart SYSTEM "xml/gmime-multipart.xml">
<!ENTITY GMimeMultipartEncrypted SYSTEM "xml/gmime-multipart-encrypted.xml">
<!ENTITY GMimeMultipartSigned SYSTEM "xml/gmime-multipart-signed.xml">
<!ENTITY GMimePart SYSTEM "xml/gmime-part.xml">
<!ENTITY GMimePartIter SYSTEM "xml/gmime-part-iter.xml">
<!ENTITY GMimeMessage SYSTEM "xml/gmime-message.xml">
<!ENTITY GMimeMessagePart SYSTEM "xml/gmime-message-part.xml">
<!ENTITY GMimeMessagePartial SYSTEM "xml/gmime-message-partial.xml">
<!ENTITY gmime-utils SYSTEM "xml/gmime-utils.xml">
<!ENTITY gmime-encodings SYSTEM "xml/gmime-encodings.xml">
<!ENTITY InternetAddress SYSTEM "xml/internet-address.xml">
<!ENTITY InternetAddressGroup SYSTEM "xml/internet-address-group.xml">
<!ENTITY InternetAddressMailbox SYSTEM "xml/internet-address-mailbox.xml">
<!ENTITY InternetAddressList SYSTEM "xml/internet-address-list.xml">
<!ENTITY GMimeParser SYSTEM "xml/gmime-parser.xml">
<!ENTITY gmime-charset SYSTEM "xml/gmime-charset.xml">
<!ENTITY gmime-iconv SYSTEM "xml/gmime-iconv.xml">
<!ENTITY gmime-iconv-utils SYSTEM "xml/gmime-iconv-utils.xml">
<!ENTITY GMimeStream SYSTEM "xml/gmime-stream.xml">
<!ENTITY GMimeStreamBuffer SYSTEM "xml/gmime-stream-buffer.xml">
<!ENTITY GMimeStreamCat SYSTEM "xml/gmime-stream-cat.xml">
<!ENTITY GMimeStreamFile SYSTEM "xml/gmime-stream-file.xml">
<!ENTITY GMimeStreamFs SYSTEM "xml/gmime-stream-fs.xml">
<!ENTITY GMimeStreamGIO SYSTEM "xml/gmime-stream-gio.xml">
<!ENTITY GMimeStreamMem SYSTEM "xml/gmime-stream-mem.xml">
<!ENTITY GMimeStreamMmap SYSTEM "xml/gmime-stream-mmap.xml">
<!ENTITY GMimeStreamNull SYSTEM "xml/gmime-stream-null.xml">
<!ENTITY GMimeStreamPipe SYSTEM "xml/gmime-stream-pipe.xml">
<!ENTITY GMimeStreamFilter SYSTEM "xml/gmime-stream-filter.xml">
<!ENTITY GMimeFilter SYSTEM "xml/gmime-filter.xml">
<!ENTITY GMimeFilterBasic SYSTEM "xml/gmime-filter-basic.xml">
<!ENTITY GMimeFilterBest SYSTEM "xml/gmime-filter-best.xml">
<!ENTITY GMimeFilterCharset SYSTEM "xml/gmime-filter-charset.xml">
<!ENTITY GMimeFilterCRLF SYSTEM "xml/gmime-filter-crlf.xml">
<!ENTITY GMimeFilterEnriched SYSTEM "xml/gmime-filter-enriched.xml">
<!ENTITY GMimeFilterFrom SYSTEM "xml/gmime-filter-from.xml">
<!ENTITY GMimeFilterGZip SYSTEM "xml/gmime-filter-gzip.xml">
<!ENTITY GMimeFilterHTML SYSTEM "xml/gmime-filter-html.xml">
<!ENTITY GMimeFilterMd5 SYSTEM "xml/gmime-filter-md5.xml">
<!ENTITY GMimeFilterStrip SYSTEM "xml/gmime-filter-strip.xml">
<!ENTITY GMimeFilterWindows SYSTEM "xml/gmime-filter-windows.xml">
<!ENTITY GMimeFilterYenc SYSTEM "xml/gmime-filter-yenc.xml">
<!ENTITY GMimeCertificate SYSTEM "xml/gmime-certificate.xml">
<!ENTITY GMimeSignature SYSTEM "xml/gmime-signature.xml">
<!ENTITY GMimeCryptoContext SYSTEM "xml/gmime-crypto-context.xml">
<!ENTITY GMimeGpgContext SYSTEM "xml/gmime-gpg-context.xml">
<!ENTITY GMimePkcs7Context SYSTEM "xml/gmime-pkcs7-context.xml">

<!ENTITY index-Class-Tree SYSTEM "tree_index.sgml">

<!ENTITY gmime-Building SYSTEM "building.sgml">
<!ENTITY gmime-Compiling SYSTEM "compiling.sgml">
<!ENTITY gmime-Resources SYSTEM "resources.sgml">
<!ENTITY gmime-Questions SYSTEM "question_index.sgml">
<!ENTITY gmime-Changes-2-0 SYSTEM "changes-2.0.sgml">
<!ENTITY gmime-Changes-2-2 SYSTEM "changes-2.2.sgml">
<!ENTITY gmime-Changes-2-4 SYSTEM "changes-2.4.sgml">
<!ENTITY gmime-Changes-2-6 SYSTEM "changes-2.6.sgml">

<!ENTITY gmime-Streams SYSTEM "streams.sgml">
<!ENTITY gmime-Filters SYSTEM "filters.sgml">
<!ENTITY gmime-DataWrappers SYSTEM "data-wrappers.sgml">
]>

<book id="index">
  <bookinfo>
    <title>GMime 2.6 Reference Manual</title>
    <authorgroup>
      <author>
        <firstname>Jeffrey</firstname>
        <surname>Stedfast</surname>
        <affiliation>
          <address>
            <email>fejj@gnome.org</email>
          </address>
        </affiliation>
      </author>
    </authorgroup>
    <copyright>
      <year>2000-2011</year>
      <holder>Jeffrey Stedfast</holder>
    </copyright>

    <legalnotice>
      <para>
        This library is free software; you can redistribute it and/or
        modify it under the terms of the GNU Lesser General Public
        License as published by the Free Software Foundation; either
        version 2.1 of the License, or (at your option) any later version.
      </para>
      <para>
        This library is distributed in the hope that it will be useful,
        but WITHOUT ANY WARRANTY; without even the implied warranty of
        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
        Lesser General Public License for more details.
      </para>
      <para>
        You should have received a copy of the GNU Lesser General Public
        License along with this library; if not, write to the Free Software
        Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
        02110-1301, USA.
      </para>
    </legalnotice>

    <abstract>
      <para>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.</para>
    </abstract>
  </bookinfo>

  <part id="gmime">
    <title>GMime Overview</title>
    <partintro>
      <para>
GMime is a powerful MIME (Multipurpose Internet Mail Extension)
utility library. It is meant for creating, editing, and parsing MIME
messages and structures. GMime is released under the 2.1 version of
the GNU Lesser General Public License. GMime is based on GLib 2.0's
GObject system allowing for a lot of flexibility.
      </para>
      <para>
GMime depends on the following libraries:
        <variablelist>
          <varlistentry>
            <term>GLib</term>
            <listitem>
              <para>
A general-purpose utility library, not specific to graphical user interfaces.
GLib provides many useful data types, macros, type conversions,
string utilities, file utilities, a main loop abstraction, and so on.
              </para>
            </listitem>
          </varlistentry>
        </variablelist>
      </para>
    </partintro>
    &gmime-Building;
    &gmime-Compiling;
    &gmime-Changes-2-0;
    &gmime-Changes-2-2;
    &gmime-Changes-2-4;
    &gmime-Changes-2-6;
    &gmime-Resources;
    &gmime-Questions;
  </part>

  <part id="fundamentals">
    <title>GMime Fundamentals</title>
    &gmime-Streams;
    &gmime-Filters;
    &gmime-DataWrappers;
  </part>

  <part id="core">
    <title>GMime Core Reference</title>
    &gmime-Init;
    &gmime-charset;
    &gmime-iconv;
    &gmime-iconv-utils;
    &gmime-encodings;
    &gmime-utils;
  </part>

  <part id="classes">
    <title>GMime Classes</title>
    <chapter>
      <title>Class hierarchy</title>
      &index-Class-Tree;
    </chapter>

    <chapter id="Streams">
      <title>Streams</title>
      &GMimeStream;
      &GMimeStreamFile;
      &GMimeStreamFs;
      &GMimeStreamMem;
      &GMimeStreamMmap;
      &GMimeStreamNull;
      &GMimeStreamFilter;
      &GMimeStreamBuffer;
      &GMimeStreamPipe;
      &GMimeStreamCat;
    </chapter>

    <chapter id="Filters">
      <title>Stream Filters</title>
      &GMimeFilter;
      &GMimeFilterBasic;
      &GMimeFilterBest;
      &GMimeFilterCharset;
      &GMimeFilterCRLF;
      &GMimeFilterEnriched;
      &GMimeFilterFrom;
      &GMimeFilterGZip;
      &GMimeFilterHTML;
      &GMimeFilterMd5;
      &GMimeFilterStrip;
      &GMimeFilterWindows;
      &GMimeFilterYenc;
    </chapter>

    <chapter id="DataWrappers">
      <title>Data Wrappers</title>
      &GMimeDataWrapper;
    </chapter>

    <chapter id="Headers">
      <title>Message and MIME Headers</title>
      &GMimeHeader;
      &GMimeContentType;
      &GMimeDisposition;
      &GMimeParam;
    </chapter>

    <chapter id="InternetAddresses">
      <title>Internet Addresses</title>
      &InternetAddress;
      &InternetAddressGroup;
      &InternetAddressMailbox;
      &InternetAddressList;
    </chapter>

    <chapter id="MimeParts">
      <title>MIME Messages and Parts</title>
      &GMimeObject;
      &GMimeMessage;
      &GMimePart;
      &GMimeMultipart;
      &GMimeMultipartEncrypted;
      &GMimeMultipartSigned;
      &GMimeMessagePart;
      &GMimeMessagePartial;
      &GMimePartIter;
    </chapter>

    <chapter id="Parsers">
      <title>Parsing Messages and MIME Parts</title>
      &GMimeParser;
    </chapter>

    <chapter id="CryptoContexts">
      <title>Cryptography Contexts</title>
      &GMimeCertificate;
      &GMimeSignature;
      &GMimeCryptoContext;
      &GMimeGpgContext;
      &GMimePkcs7Context;
    </chapter>
  </part>
</book>