mailutils.texi
9.72 KB
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
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
\input texinfo @c -*-texinfo-*-
@c %**start of header
@setfilename mailutils.info
@settitle mailutils, Programming Manual
@c %**end of header
@c This file has the new style title page commands.
@c Run `makeinfo' rather than `texinfo-format-buffer'.
@c smallbook
@c tex
@c \overfullrule=0pt
@c end tex
@include version.texi
@c Combine indices.
@syncodeindex ky cp
@defcodeindex op
@syncodeindex op fn
@syncodeindex vr fn
@syncodeindex tp fn
@ifinfo
@dircategory GNU libraries
@direntry
* mailutils: (mailutils). API for mailboxes and mail protocols
@end direntry
@dircategory GNU utilities
@direntry
* comsatd: (mailutils)comsatd. Comsat daemon
* frm: (mailutils)frm. List headers from a mailbox
* guimb: (mailutils)guimb. Mailbox scanning and processing language
* imap4d: (mailutils)imap4d. IMAP4 daemon
* mail.local: (mailutils)mail.local. Deliver mail to the local mailbox
* mail: (mailutils)mail. Send and receive mail
* messages: (mailutils)messages. Count the number of messages in a mailbox
* pop3d: (mailutils)pop3d. POP3 daemon
* readmsg: (mailutils)readmsg. Extract messages from a folder
* sieve: (mailutils)sieve. Mail filtering utility
* mailutils-config: (mailutils)mailutils-config. Get the information about the Mailutils build.
@end direntry
This file documents Mailutils, library API.
Published by the Free Software Foundation,
59 Temple Place - Suite 330
Boston, MA 02111-1307, USA
Copyright 1999, 2000 Free Software Foundation, Inc.
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission notice
are preserved on all copies.
@ignore
Permission is granted to process this file through TeX and print the
results, provided the printed document carries copying permission
notice identical to this one except for the removal of this paragraph
(this paragraph not being relevant to the printed manual).
@end ignore
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided that the entire
resulting derived work is distributed under the terms of a permission
notice identical to this one.
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation approved
by the Foundation.
@end ifinfo
@setchapternewpage off
@titlepage
@title Mailutils, SDK.
@subtitle version @value{VERSION}, @value{UPDATED}
@author Alain Magloire et al.
@page
@vskip 0pt plus 1filll
Copyright @copyright{} 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
@sp 2
Published by the Free Software Foundation, @*
59 Temple Place - Suite 330, @*
Boston, MA 02111-1307, USA
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission notice
are preserved on all copies.
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided that the entire
resulting derived work is distributed under the terms of a permission
notice identical to this one.
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation approved
by the Foundation.
@end titlepage
@page
@summarycontents
@page
@node Top, Introduction, (dir), (dir)
@comment node-name, next, previous, up
@ifinfo
This document was produced for version @value{VERSION} of @sc{gnu}
Mailutils.
@end ifinfo
@menu
* Introduction:: GNU Mailutils
@comment * Concrete API:: Concrete API.
* Framework:: Framework.
* Authentication Library:: Auxiliary library for authenticating users.
* Sieve Library:: GNU implementation of Sieve mail filtering.
* Programs:: Programs.
* Reporting Bugs:: How to report a bug.
* News:: Where to get information about @sc{gnu} Mailutils
* Acknowledgement:: Thanks and Credits.
Indices
* Function Index:: All Mailutils Functions.
* Program Index:: All Mailutils Programs.
* Concept Index:: Index of Concepts.
@end menu
@node Introduction, Framework, Top, Top
@comment node-name, next, previous, up
@chapter Introduction
@cindex Introduction
@sc{gnu} Mailutils offers a general purpose library whose aim is to
provide a rich set of functions for accessing different mailbox formats and
mailers.
@section References
For more information on,
@itemize @bullet
@item
SMTP
@itemize @minus
@item
@cite{RFC 2821: Simple Mail Transfer Protocol}
@item
@cite{RFC 2368: The mailto URL scheme}
@end itemize
@item
POP3
@itemize @minus
@item
@cite{RFC 1939: Post Office Protocol - Version 3}
@item
@cite{RFC 1734: POP3 AUTHentication command}
@item
@cite{RFC 1957: Some Observations on Implementations of the Post Office
Protocol (POP3)}
@item
@cite{RFC 2449: POP3 Extension Mechanism}
@item
@cite{RFC 2384: POP URL Scheme}
@end itemize
@item
IMAP4
@itemize @minus
@item
@cite{RFC 2060: INTERNET MESSAGE ACCESS PROTOCOL - VERSION 4rev1}
@item
@cite{RFC 2088: IMAP4 non-synchronizing literals}
@item
@cite{RFC 2193: IMAP4 Mailbox Referrals}
@item
@cite{RFC 2221: IMAP4 Login Referrals}
@item
@cite{RFC 2342: IMAP4 Namespace}
@item
@cite{RFC 2192: IMAP URL Scheme}
@item
@cite{RFC 1731: IMAP4 Authentication Mechanisms}
@item
@cite{RFC 2245: Anonymous SASL Mechanism}
@end itemize
@item
message formats
@itemize @minus
@item
@cite{RFC 2822: Internet Message Format}
@item
@cite{RFC 2045: Multipurpose Internet Mail Extensions (MIME) Part One:
Format of Internet Message Bodies}
@item
@cite{RFC 2046: Multipurpose Internet Mail Extensions (MIME) Part Two:
Media Types}
@item
@cite{RFC 2047: Multipurpose Internet Mail Extensions (MIME) Part Three:
Message Header Extensions for Non-ASCII Text}
@item
@cite{RFC 2049: Multipurpose Internet Mail Extensions (MIME) Part Five:
Conformance Criteria and Examples}
@item
@cite{RFC 2111: Content-ID and Message-ID Uniform Resource Locators}
@end itemize
@item
miscellaneous related topics
@itemize @minus
@item
@cite{RFC 3028: Sieve: A Mail Filtering Language}
@item
@cite{RFC 2298: An Extensible Message Format for Message Disposition
Notifications}
@item
@cite{RFC 1738: Uniform Resource Locators (URL)}
@item
@cite{Internet Email Protocols: A Developer's Guide, by Kevin Johnson}
@end itemize
@end itemize
@comment @node Concrete API, Framework, Introduction, Top
@comment @comment node-name, next, previous, up
@comment @chapter Concrete API
@comment @cindex Concrete API
@comment @include c-api.texi
@node Framework, Authentication Library, Introduction, Top
@comment node-name, next, previous, up
@chapter Framework
@cindex Framework
@include framework.texi
@node Authentication Library, Sieve Library, Framework, Top
@chapter Authentication Library
@cindex Authentication Library
@cindex libmuauth
@include libmuauth.texi
@node Sieve Library, Programs, Authentication Library, Top
@chapter Sieve Library
@cindex Sieve Library
@cindex libsieve
@include libsieve.texi
@node Programs, Reporting Bugs, Sieve Library, Top
@comment node-name, next, previous, up
@chapter Programs
@cindex Programs
@include programs.texi
@page
@node Reporting Bugs, News, Programs, Top
@comment node-name, next, previous, up
@chapter Reporting Bugs
@cindex Reporting Bugs
Email bug reports to @email{bug-mailutils@@gnu.org}.
Be sure to include the word ``mailutils'' somewhere in the ``Subject:''
field.
As the purpose of bug reporting is to improve software, please be sure
to include maximum information when reporting a bug. The information
needed is:
@itemize
@item Version of the package you are using.
@item Compilation options used when configuring the package.
@item Conditions under which the bug appears.
@end itemize
The archives of bug-mailutils mailing list are available from
@url{http://mail.gnu.org/mailman/listinfo/bug-mailutils}.
@node News, Acknowledgement, Reporting Bugs, Top
@chapter Getting news about @sc{gnu} mailutils
The two places to look for any news regarding @sc{gnu} Mailutils are the
Mailutils homepage at @url{http://www.gnu.org/software/mailutils}, and the
project page at @url{http://savannah.gnu.org/projects/mailutils}.
The updated versions of this manual are available online from
@url{http://www.gnu.org/software/mailutils/manual}.
@node Acknowledgement, Function Index , News, Top
@comment node-name, next, previous, up
@chapter Acknowledgement
@cindex Acknowledgement
In no particular order,
@itemize @bullet
@item
Jakob Kaivo @email{jkaivo@@ndn.net},
@item
Jeff Bailey @email{jbailey@@gnu.org},
@item
Sean Perry @email{shaleh@@debian.org},
@item
Thomas Fletcher @email{thomasf@@qnx.com},
@item
Dave Inglis @email{dinglis@@qnx.com},
@item
Brian Edmond @email{briane@@qnx.com},
@item
Sam Roberts @email{sroberts@@uniserve.com},
@item
Sergey Poznyakoff @email{gray@@Mirddin.farlep.net},
@item
Fran@,{c}ois Pinard @email{pinard@@IRO.UMontreal.CA}.
@item
Jordi Mallach @email{jordi@@sindominio.net}
@end itemize
@page
@node Function Index, Program Index, Acknowledgement, Top
@comment node-name, next, previous, up
@unnumbered Function Index
This is an alphabetical list of all Mailutils functions.
@printindex fn
@page
@node Program Index, Concept Index, Function Index, Top
@comment node-name, next, previous, up
@unnumbered Program Index
@printindex pg
@page
@node Concept Index, , Program Index, Top
@comment node-name, next, previous, up
@unnumbered Concept Index
This is a general index of all issues discussed in this manual
@printindex cp
@page
@contents
@bye