blob: c3da4adb736ae2afab8fd5580368912683e7fde5 (
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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GMime 2.6 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<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.">
<link rel="home" href="index.html" title="GMime 2.6 Reference Manual">
<link rel="next" href="gmime.html" title="Part I. GMime Overview">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<div class="book">
<div class="titlepage">
<div>
<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>
<div><div class="authorgroup"><div class="author">
<h3 class="author">
<span class="firstname">Jeffrey</span> <span class="surname">Stedfast</span>
</h3>
<div class="affiliation"><div class="address"><p><br>
<code class="email"><<a class="email" href="mailto:fejj@gnome.org">fejj@gnome.org</a>></code><br>
</p></div></div>
</div></div></div>
<div><p class="copyright">Copyright © 2000-2011 Jeffrey Stedfast</p></div>
<div><div class="legalnotice">
<a name="idp251088"></a><p>
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.
</p>
<p>
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.
</p>
<p>
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.
</p>
</div></div>
<div><div class="abstract">
<p class="title"><b>Abstract</b></p>
<p>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.</p>
</div></div>
</div>
<hr>
</div>
<div class="toc"><dl>
<dt><span class="part"><a href="gmime.html">I. GMime Overview</a></span></dt>
<dd><dl>
<dt>
<span class="refentrytitle"><a href="gmime-building.html">Compiling the GMime libraries</a></span><span class="refpurpose"> — How to compile GMime itself</span>
</dt>
<dt>
<span class="refentrytitle"><a href="gmime-compiling.html">Compiling GMime Applications</a></span><span class="refpurpose"> —
How to compile your GMime application
</span>
</dt>
<dt>
<span class="refentrytitle"><a href="gmime-changes-2-0.html">Changes from 1.0 to 2.0</a></span><span class="refpurpose"> —
Incompatible changes made between version 1.0 and version 2.0
</span>
</dt>
<dt>
<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>
</dt>
<dt>
<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>
</dt>
<dt>
<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>
</dt>
<dt>
<span class="refentrytitle"><a href="gmime-resources.html">Mailing lists and bug reports</a></span><span class="refpurpose"> —
Getting help with GMime
</span>
</dt>
<dt>
<span class="refentrytitle"><a href="gmime-question-index.html">Frequently Asked Questions</a></span><span class="refpurpose"> —
Find answers to common questions in the GMime manual
</span>
</dt>
</dl></dd>
<dt><span class="part"><a href="fundamentals.html">II. GMime Fundamentals</a></span></dt>
<dd><dl>
<dt>
<span class="refentrytitle"><a href="gmime-streams.html">GMime Streams</a></span><span class="refpurpose"> — How to use GMime Streams</span>
</dt>
<dt>
<span class="refentrytitle"><a href="gmime-filters.html">GMime Stream Filters</a></span><span class="refpurpose"> — How to use GMime Stream Filters</span>
</dt>
<dt>
<span class="refentrytitle"><a href="gmime-data-wrappers.html">GMime Data Wrappers</a></span><span class="refpurpose"> — How to use GMime Data Wrappers</span>
</dt>
</dl></dd>
<dt><span class="part"><a href="core.html">III. GMime Core Reference</a></span></dt>
<dd><dl>
<dt>
<span class="refentrytitle"><a href="gmime-gmime.html">gmime</a></span><span class="refpurpose"> — Initialization, shutdown and version-check routines</span>
</dt>
<dt>
<span class="refentrytitle"><a href="gmime-gmime-charset.html">gmime-charset</a></span><span class="refpurpose"> — Charset helper functions</span>
</dt>
<dt>
<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>
</dt>
<dt>
<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>
</dt>
<dt>
<span class="refentrytitle"><a href="gmime-gmime-encodings.html">gmime-encodings</a></span><span class="refpurpose"> — MIME encoding functions</span>
</dt>
<dt>
<span class="refentrytitle"><a href="gmime-gmime-utils.html">gmime-utils</a></span><span class="refpurpose"> — MIME utility functions</span>
</dt>
</dl></dd>
<dt><span class="part"><a href="classes.html">IV. GMime Classes</a></span></dt>
<dd><dl>
<dt><span class="chapter"><a href="ch01.html">Class hierarchy</a></span></dt>
<dt><span class="chapter"><a href="Streams.html">Streams</a></span></dt>
<dd><dl>
<dt>
<span class="refentrytitle"><a href="GMimeStream.html">GMimeStream</a></span><span class="refpurpose"> — Abstract stream class</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeStreamFile.html">GMimeStreamFile</a></span><span class="refpurpose"> — A Standard-C FILE-based stream</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeStreamFs.html">GMimeStreamFs</a></span><span class="refpurpose"> — A low-level FileSystem stream</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeStreamMem.html">GMimeStreamMem</a></span><span class="refpurpose"> — A memory-backed stream</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeStreamMmap.html">GMimeStreamMmap</a></span><span class="refpurpose"> — A memory-mapped file stream</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeStreamNull.html">GMimeStreamNull</a></span><span class="refpurpose"> — A null stream</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeStreamFilter.html">GMimeStreamFilter</a></span><span class="refpurpose"> — A filtering stream</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeStreamBuffer.html">GMimeStreamBuffer</a></span><span class="refpurpose"> — A buffered stream</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeStreamPipe.html">GMimeStreamPipe</a></span><span class="refpurpose"> — A low-level pipe stream</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeStreamCat.html">GMimeStreamCat</a></span><span class="refpurpose"> — A concatenated stream</span>
</dt>
</dl></dd>
<dt><span class="chapter"><a href="Filters.html">Stream Filters</a></span></dt>
<dd><dl>
<dt>
<span class="refentrytitle"><a href="GMimeFilter.html">GMimeFilter</a></span><span class="refpurpose"> — Abstract filter class</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeFilterBasic.html">GMimeFilterBasic</a></span><span class="refpurpose"> — Basic transfer encoding filter</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeFilterBest.html">GMimeFilterBest</a></span><span class="refpurpose"> — Determine the best charset/encoding to use for a stream</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeFilterCharset.html">GMimeFilterCharset</a></span><span class="refpurpose"> — Charset-conversion filter</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeFilterCRLF.html">GMimeFilterCRLF</a></span><span class="refpurpose"> — Convert line-endings from LF to CRLF or vise versa</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeFilterEnriched.html">GMimeFilterEnriched</a></span><span class="refpurpose"> — Convert text/enriched or text/rtf to HTML</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeFilterFrom.html">GMimeFilterFrom</a></span><span class="refpurpose"> — Escape MBox From_ lines</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeFilterGZip.html">GMimeFilterGZip</a></span><span class="refpurpose"> — GNU Zip compression/decompression</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeFilterHTML.html">GMimeFilterHTML</a></span><span class="refpurpose"> — Convert plain text into HTML</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeFilterMd5.html">GMimeFilterMd5</a></span><span class="refpurpose"> — Calculate an md5sum</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeFilterStrip.html">GMimeFilterStrip</a></span><span class="refpurpose"> — Strip trailing whitespace from the end of lines</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeFilterWindows.html">GMimeFilterWindows</a></span><span class="refpurpose"> — Determine if text is in a Microsoft Windows codepage</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeFilterYenc.html">GMimeFilterYenc</a></span><span class="refpurpose"> — yEncode or yDecode</span>
</dt>
</dl></dd>
<dt><span class="chapter"><a href="DataWrappers.html">Data Wrappers</a></span></dt>
<dd><dl><dt>
<span class="refentrytitle"><a href="GMimeDataWrapper.html">GMimeDataWrapper</a></span><span class="refpurpose"> — Content objects</span>
</dt></dl></dd>
<dt><span class="chapter"><a href="Headers.html">Message and MIME Headers</a></span></dt>
<dd><dl>
<dt>
<span class="refentrytitle"><a href="gmime-GMimeHeader.html">GMimeHeader</a></span><span class="refpurpose"> — Message and MIME part headers</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeContentType.html">GMimeContentType</a></span><span class="refpurpose"> — Content-Type fields</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeContentDisposition.html">GMimeContentDisposition</a></span><span class="refpurpose"> — Content-Disposition fields</span>
</dt>
<dt>
<span class="refentrytitle"><a href="gmime-GMimeParam.html">GMimeParam</a></span><span class="refpurpose"> — Content-Type and Content-Disposition parameters</span>
</dt>
</dl></dd>
<dt><span class="chapter"><a href="InternetAddresses.html">Internet Addresses</a></span></dt>
<dd><dl>
<dt>
<span class="refentrytitle"><a href="InternetAddress.html">InternetAddress</a></span><span class="refpurpose"> — Internet addresses</span>
</dt>
<dt>
<span class="refentrytitle"><a href="InternetAddressGroup.html">InternetAddressGroup</a></span><span class="refpurpose"> — rfc822 'group' address</span>
</dt>
<dt>
<span class="refentrytitle"><a href="InternetAddressMailbox.html">InternetAddressMailbox</a></span><span class="refpurpose"> — rfc822 'mailbox' address</span>
</dt>
<dt>
<span class="refentrytitle"><a href="InternetAddressList.html">InternetAddressList</a></span><span class="refpurpose"> — A list of internet addresses</span>
</dt>
</dl></dd>
<dt><span class="chapter"><a href="MimeParts.html">MIME Messages and Parts</a></span></dt>
<dd><dl>
<dt>
<span class="refentrytitle"><a href="GMimeObject.html">GMimeObject</a></span><span class="refpurpose"> — Abstract MIME objects</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeMessage.html">GMimeMessage</a></span><span class="refpurpose"> — Messages</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimePart.html">GMimePart</a></span><span class="refpurpose"> — MIME parts</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeMultipart.html">GMimeMultipart</a></span><span class="refpurpose"> — MIME multiparts</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeMultipartEncrypted.html">GMimeMultipartEncrypted</a></span><span class="refpurpose"> — Encrypted MIME multiparts</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeMultipartSigned.html">GMimeMultipartSigned</a></span><span class="refpurpose"> — Signed MIME multiparts</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeMessagePart.html">GMimeMessagePart</a></span><span class="refpurpose"> — Message parts</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeMessagePartial.html">GMimeMessagePartial</a></span><span class="refpurpose"> — Partial MIME parts</span>
</dt>
<dt>
<span class="refentrytitle"><a href="gmime-GMimePartIter.html">GMimePartIter</a></span><span class="refpurpose"> — MIME part iterators</span>
</dt>
</dl></dd>
<dt><span class="chapter"><a href="Parsers.html">Parsing Messages and MIME Parts</a></span></dt>
<dd><dl><dt>
<span class="refentrytitle"><a href="GMimeParser.html">GMimeParser</a></span><span class="refpurpose"> — Message and MIME part parser</span>
</dt></dl></dd>
<dt><span class="chapter"><a href="CryptoContexts.html">Cryptography Contexts</a></span></dt>
<dd><dl>
<dt>
<span class="refentrytitle"><a href="GMimeCertificate.html">GMimeCertificate</a></span><span class="refpurpose"> — Digital certificates</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeSignature.html">GMimeSignature</a></span><span class="refpurpose"> — Digital signatures</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeCryptoContext.html">GMimeCryptoContext</a></span><span class="refpurpose"> — Encryption/signing contexts</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimeGpgContext.html">GMimeGpgContext</a></span><span class="refpurpose"> — GnuPG crypto contexts</span>
</dt>
<dt>
<span class="refentrytitle"><a href="GMimePkcs7Context.html">GMimePkcs7Context</a></span><span class="refpurpose"> — PKCS7 crypto contexts</span>
</dt>
</dl></dd>
</dl></dd>
</dl></div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|
