mailutils.texi
8.78 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
\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
@syncodeindex pg cp
@syncodeindex tp cp
@defcodeindex op
@syncodeindex op fn
@syncodeindex vr fn
@ifinfo
@direntry
* mailutils: (libmailutils). The GNU mailutils library API.
@end direntry
This file documents @sc{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, library API.
@subtitle version @value{VERSION}, @value{UPDATED}
@author Alain Magloire et al.
@page
@vskip 0pt plus 1filll
Copyright @copyright{} 1999, 2000 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
@node Top, Introduction, (dir), (dir)
@comment node-name, next, previous, up
@ifinfo
This document was produced for version @value{VERSION} of @sc{gnu}
@sc{mailutils}.
@end ifinfo
@menu
* Introduction:: GNU @sc{mailutils}
* Mailbox:: Mailbox API.
* Mailer:: Protocol Use to Send Mail.
* Message:: Message API.
* Headers:: Headers API.
* Body:: Body API.
* URL:: Unified Ressource Locator.
* Authenticator:: Authenticator.
* Mime:: Mime API.
* Encoding:: Encoding API.
* Reporting Bugs:: Reporting Bugs.
* Acknowledgement:: Thanks and Credits.
* Concept Index ::
* Index:: All @sc{Mailutils} Functions.
@end menu
@node Introduction, Mailbox, Top, Top
@comment node-name, next, previous, up
@chapter Introduction
@cindex Introduction
@sc{gnu} @sc{Mailutils} offers a general purpose library aimed to provide
a rich set of functions for accessing different mailbox formats and mailers.
@example
@group
mailbox_t url_t
-/var/mail- +---//---->+-----------------+ +-->+-----------+
( alain ) | | url_t *-|----+ | port |
----------- | +-----------------+ | hostname |
( jakob *-)----+ | auth_t *-|----+ | file |
----------- +-----------------+ | | ... |
( jeff ) +---|-* message_t[0] | | +-----------+
----------- | | message_t[1] | |
( sean ) | | ... | | auth_t
---------- | +-----------------+ +-->+----------+
| | user |
message_t | | passwd |
+--------------+<------+ header_t +----------+
| header_t *-|-----------------------+-->+---------------+
+--------------+ body_t | | name/val[0] |
| body_t[0] *-|----->+-------------+ | | ... |
| body_t[1] | | header_t *-|--+ +---------------+
| ... | +-------------+
+--------------+ | content |
| next_body |
+-------------+
@end group
@end example
@comment @example
@comment @group
@comment USER Client
@comment -------------------
@comment | |
@comment +-------------+ +-------------+
@comment | |
@comment /-----------\ /-----------\
@comment | mailbox_t | | mailer_t |
@comment \-----------/ \-----------/
@comment | |
@comment +--------------------+------------------+
@comment |
@comment /------------------\
@comment | message_t |
@comment \------------------/
@comment | body_t | header_t|
@comment +------------------+
@comment |
@comment +--------------------+----------------+
@comment | |
@comment ------- ////////////////
@comment (_______) // LAN //
@comment (_______) ////////////////
@comment (_______)
@comment @end group
@comment @end example
For example writing a simple @command{from} command that will list @emph{From}
and @emph{Subject} of a folder.
@example
@include sfrom.c.texi
@end example
@node Mailbox, Mailer, Introduction, Top
@comment node-name, next, previous, up
@chapter Mailbox
@cindex Mailbox
@include mailbox.texi
@node Mailer, Message, Mailbox, Top
@comment node-name, next, previous, up
@chapter Mailer
@cindex Mailer
@include mailer.texi
@node Message, Headers , Mailer, Top
@comment node-name, next, previous, up
@chapter Message
@cindex Message
@include message.texi
@node Headers , Body, Message, Top
@comment node-name, next, previous, up
@chapter Headers
@cindex Headers
@include headers.texi
@node Body, URL, Headers , Top
@comment node-name, next, previous, up
@chapter Body
@cindex Body
@include body.texi
@node URL, Authenticator, Body, Top
@comment node-name, next, previous, up
@chapter URL
@cindex URL
@include url.texi
@node Authenticator, Mime , URL, Top
@comment node-name, next, previous, up
@chapter Authenticator
@cindex Authenticator
@include auth.texi
@node Mime , Encoding, Authenticator, Top
@comment node-name, next, previous, up
@chapter Mime
@cindex Mime
@include mime.texi
@node Encoding, Reporting Bugs, Mime , Top
@comment node-name, next, previous, up
@chapter Encoding
@cindex Encoding
@include encoding.texi
@node Reporting Bugs, Acknowledgement, Encoding, 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.
@node Acknowledgement, Concept Index , Reporting Bugs, Top
@comment node-name, next, previous, up
@chapter Acknowledgement
@cindex Acknowledgement
In no particular order,
Jakob Kaivo @email{jkaivo@@ndn.net},
Jeff Bailey @email{jbailey@@gnu.org},
Sean Perry @email{shaleh@@debian.org},
Thomas Fletcher @email{thomasf@@qnx.com}.
@page
@node Concept Index , Index, Acknowledgement, 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
@node Index, , Concept Index , Top
@unnumbered Index
This is an alphabetical list of all @sc{mailutils} functions.
@printindex fn
@contents
@bye