Skip to content

John McEleney / mailutils

Go to a project
Toggle navigation
Toggle navigation pinning
Commit c5fe2fd2 c5fe2fd2670a170f0f907cef692297f49bcdf596 by Alain Magloire
Options

A bunch of typo correction from Thomas.

1 parent 2e878c30
Expand all
Inline Side-by-side
Showing 21 changed files with 44 additions and 43 deletions
1 @example 1 @example
2 @code{/* Prefix @emph{address_} is reserve */} 2 @code{/* Prefix @emph{address_} is reserved */}
3 @code{#include <mailutils/address.h>} 3 @code{#include <mailutils/address.h>}
4 4
5 @end example 5 @end example
...@@ -91,7 +91,7 @@ The @var{addr} is destroyed. ...@@ -91,7 +91,7 @@ The @var{addr} is destroyed.
91 91
92 @deftypefun int address_get_email (address_t *@var{addr}, size_t @var{no}, char* @var{buf}, size_t @var{len}, size_t* @var{n}) 92 @deftypefun int address_get_email (address_t *@var{addr}, size_t @var{no}, char* @var{buf}, size_t @var{len}, size_t* @var{n})
93 93
94 Acesses the @var{no}th email address component of the address list. This 94 Accesses the @var{no}th email address component of the address list. This
95 address is the plain email address, correctly quoted, suitable for 95 address is the plain email address, correctly quoted, suitable for
96 using in an smtp dialog, for example, or as the address part of 96 using in an smtp dialog, for example, or as the address part of
97 a contact book entry. 97 a contact book entry.
...@@ -105,7 +105,7 @@ The return value is @code{0} on success and a code number on error conditions: ...@@ -105,7 +105,7 @@ The return value is @code{0} on success and a code number on error conditions:
105 105
106 @deftypefun int address_get_personal (address_t *@var{addr}, size_t @var{no}, char* @var{buf}, size_t @var{len}, size_t* @var{n}) 106 @deftypefun int address_get_personal (address_t *@var{addr}, size_t @var{no}, char* @var{buf}, size_t @var{len}, size_t* @var{n})
107 107
108 Acesses the display-name describing the @var{no}th email address. This 108 Accesses the display-name describing the @var{no}th email address. This
109 display-name is optional, so may not be present. If it is not present, but 109 display-name is optional, so may not be present. If it is not present, but
110 there is an RFC822 comment after the address, that comment will be 110 there is an RFC822 comment after the address, that comment will be
111 returned as the personal phrase, as this is a common usage of the comment 111 returned as the personal phrase, as this is a common usage of the comment
...@@ -127,7 +127,7 @@ The return value is @code{0} on success and a code number on error conditions: ...@@ -127,7 +127,7 @@ The return value is @code{0} on success and a code number on error conditions:
127 127
128 @deftypefun int address_get_comments (address_t *@var{addr}, size_t @var{no}, char* @var{buf}, size_t @var{len}, size_t* @var{n}) 128 @deftypefun int address_get_comments (address_t *@var{addr}, size_t @var{no}, char* @var{buf}, size_t @var{len}, size_t* @var{n})
129 129
130 Acesses the comments extracted while parsing the @var{no}th email address. 130 Accesses the comments extracted while parsing the @var{no}th email address.
131 These comments have no defined meaning, and are not currently collected. 131 These comments have no defined meaning, and are not currently collected.
132 132
133 The return value is @code{0} on success and a code number on error conditions: 133 The return value is @code{0} on success and a code number on error conditions:
...@@ -140,7 +140,7 @@ The return value is @code{0} on success and a code number on error conditions: ...@@ -140,7 +140,7 @@ The return value is @code{0} on success and a code number on error conditions:
140 140
141 @deftypefun int address_get_email (address_t *@var{addr}, size_t @var{no}, char* @var{buf}, size_t @var{len}, size_t* @var{n}) 141 @deftypefun int address_get_email (address_t *@var{addr}, size_t @var{no}, char* @var{buf}, size_t @var{len}, size_t* @var{n})
142 142
143 Acesses the email addr-spec extracted while 143 Accesses the email addr-spec extracted while
144 parsing the @var{no}th email address. This will be @code{0} 144 parsing the @var{no}th email address. This will be @code{0}
145 length for a unix-mbox. 145 length for a unix-mbox.
146 146
...@@ -153,7 +153,7 @@ The return value is @code{0} on success and a code number on error conditions: ...@@ -153,7 +153,7 @@ The return value is @code{0} on success and a code number on error conditions:
153 153
154 @deftypefun int address_get_local_part (address_t *@var{addr}, size_t @var{no}, char* @var{buf}, size_t @var{len}, size_t* @var{n}) 154 @deftypefun int address_get_local_part (address_t *@var{addr}, size_t @var{no}, char* @var{buf}, size_t @var{len}, size_t* @var{n})
155 155
156 Acesses the local-part of an email addr-spec extracted while 156 Accesses the local-part of an email addr-spec extracted while
157 parsing the @var{no}th email address. 157 parsing the @var{no}th email address.
158 158
159 The return value is @code{0} on success and a code number on error conditions: 159 The return value is @code{0} on success and a code number on error conditions:
...@@ -165,7 +165,7 @@ The return value is @code{0} on success and a code number on error conditions: ...@@ -165,7 +165,7 @@ The return value is @code{0} on success and a code number on error conditions:
165 165
166 @deftypefun int address_get_domain (address_t *@var{addr}, size_t @var{no}, char* @var{buf}, size_t @var{len}, size_t* @var{n}) 166 @deftypefun int address_get_domain (address_t *@var{addr}, size_t @var{no}, char* @var{buf}, size_t @var{len}, size_t* @var{n})
167 167
168 Acesses the domain of an email addr-spec extracted while 168 Accesses the domain of an email addr-spec extracted while
169 parsing the @var{no}th email address. This will be @code{0} 169 parsing the @var{no}th email address. This will be @code{0}
170 length for a unix-mbox. 170 length for a unix-mbox.
171 171
...@@ -178,7 +178,7 @@ The return value is @code{0} on success and a code number on error conditions: ...@@ -178,7 +178,7 @@ The return value is @code{0} on success and a code number on error conditions:
178 178
179 @deftypefun int address_get_route (address_t *@var{addr}, size_t @var{no}, char* @var{buf}, size_t @var{len}, size_t* @var{n}) 179 @deftypefun int address_get_route (address_t *@var{addr}, size_t @var{no}, char* @var{buf}, size_t @var{len}, size_t* @var{n})
180 180
181 Acesses the route of an email addr-spec extracted while 181 Accesses the route of an email addr-spec extracted while
182 parsing the @var{no}th email address. This is a rarely used RFC822 address 182 parsing the @var{no}th email address. This is a rarely used RFC822 address
183 syntax, but is legal in SMTP as well. The entire route is returned as 183 syntax, but is legal in SMTP as well. The entire route is returned as
184 a string, those wishing to parse it should look at <mailutils/parse822.h>. 184 a string, those wishing to parse it should look at <mailutils/parse822.h>.
......
1 @example 1 @example
2 @code{/* Prefix @emph{attribute_} is reserve */} 2 @code{/* Prefix @emph{attribute_} is reserved */}
3 @code{#include <mailutils/attribute.h>} 3 @code{#include <mailutils/attribute.h>}
4 4
5 @end example 5 @end example
......
1 @example 1 @example
2 @code{/* Prefix @emph{auth_} is reserve */} 2 @code{/* Prefix @emph{auth_} is reserved */}
3 @code{#include <mailutils/auth.h>} 3 @code{#include <mailutils/auth.h>}
4 4
5 @end example 5 @end example
6 6
7 There are many ways to authenticate to a server, to be flexible the 7 There are many ways to authenticate to a server. To be flexible the
8 authentication process is provided by two objects @code{auth_t} and 8 authentication process is provided by two objects @code{auth_t} and
9 @code{ticket_t}. The @code{auth_t} can implement different protocol like 9 @code{ticket_t}. The @code{auth_t} can implement different protocol like
10 APOP, MD5-AUTH, One Time Passwd etc .. By default if a mailbox 10 APOP, MD5-AUTH, One Time Passwd etc .. By default if a mailbox
11 does not understand or know how to authenticate it falls back to 11 does not understand or know how to authenticate it falls back to
12 user/passwd authentication. The @code{ticket_t} is away to 12 user/passwd authentication. The @code{ticket_t} is a way for
13 Mailboxes and Mailers provide a way to authenticate when the URL does not 13 Mailboxes and Mailers provide a way to authenticate when the URL does not
14 contain enough information. The default action is to call function 14 contain enough information. The default action is to call the function
15 @code{auth_authenticate} who will get the @emph{user} and @emph{passwd} 15 @code{auth_authenticate} which will get the @emph{user} and @emph{passwd}
16 if not set, this function can be override by a custom method. 16 if not set, this function can be overriden by a custom method.
17 17
18 @deftypefun int auth_create (auth_t *@var{pauth}, void *@var{owner}) 18 @deftypefun int auth_create (auth_t *@var{pauth}, void *@var{owner})
19 @end deftypefun 19 @end deftypefun
......
1 @example 1 @example
2 @code{/* Prefix @emph{body_} is reserve */} 2 @code{/* Prefix @emph{body_} is reserved */}
3 @code{#include <mailutils/body.h>} 3 @code{#include <mailutils/body.h>}
4 4
5 @end example 5 @end example
......
1 @example 1 @example
2 @code{/* Prefix @emph{envelope_} is reserve */} 2 @code{/* Prefix @emph{envelope_} is reserved */}
3 @code{#include <mailutils/envelope.h>} 3 @code{#include <mailutils/envelope.h>}
4 4
5 @end example 5 @end example
......
...@@ -16,10 +16,10 @@ ...@@ -16,10 +16,10 @@
16 16
17 @end menu 17 @end menu
18 18
19 Where ever the mail is and whatever format it is store in, the same operations 19 Whereever the mail is and whatever format it is stored in, the same operations
20 to manipulate emails are common. To unified the C API, GNU mailutils offers 20 to manipulate emails are common. To unified the C API, GNU mailutils offers
21 an heteroclite set of objects that work in aggregation to do operations on 21 a heteroclite set of objects that work in aggregation to do operations on
22 emails. Each object do a specific task and delegate non related tasks to 22 emails. Each object do a specific task and delegates non related tasks to
23 others. The object comes alive by specifying a @emph{URL} parameter when 23 others. The object comes alive by specifying a @emph{URL} parameter when
24 created, it will indicate the storage format or protocol 24 created, it will indicate the storage format or protocol
25 (POP3, IMAP4, MH, MAILDIR, etc ..). 25 (POP3, IMAP4, MH, MAILDIR, etc ..).
......
1 @example 1 @example
2 @code{/* Prefix @emph{header_} is reserve */} 2 @code{/* Prefix @emph{header_} is reserved */}
3 @code{#include <mailutils/header.h>} 3 @code{#include <mailutils/header.h>}
4 4
5 @end example 5 @end example
......
1 @example 1 @example
2 @code{/* Prefix @emph{imap4_} is reserve */} 2 @code{/* Prefix @emph{imap4_} is reserved */}
3 @code{#include <mailutils/imap4.h>} 3 @code{#include <mailutils/imap4.h>}
4 4
5 @end example 5 @end example
......
1 @example 1 @example
2 @code{/* Prefix @emph{iterator_} is reserve */} 2 @code{/* Prefix @emph{iterator_} is reserved */}
3 @code{#include <mailutils/iterator.h>} 3 @code{#include <mailutils/iterator.h>}
4 4
5 @end example 5 @end example
......
1 @example 1 @example
2 @code{/* Prefix @emph{locker_} is reserve */} 2 @code{/* Prefix @emph{locker_} is reserved */}
3 @code{#include <mailutils/locker.h>} 3 @code{#include <mailutils/locker.h>}
4 4
5 @end example 5 @end example
......
1 @example 1 @example
2 @code{/* Prefix @emph{mailbox_} is reserve */} 2 @code{/* Prefix @emph{mailbox_} is reserved */}
3 @code{#include <mailutils/mailbox.h>} 3 @code{#include <mailutils/mailbox.h>}
4 4
5 @end example 5 @end example
6 6
7 @deftp {Data Type} mailbox_t 7 @deftp {Data Type} mailbox_t
8 The @code{mailbox_t} object is used to hold information and it is an opaque 8 The @code{mailbox_t} object is used to hold information and it is an opaque
9 data structure to the user. Functions are provided to retrieve the information. 9 data structure to the user. Functions are provided to retrieve information
10 from the data structure.
10 @end deftp 11 @end deftp
11 @example 12 @example
12 @group 13 @group
...@@ -64,9 +65,9 @@ Not enough memory to allocate resources. ...@@ -64,9 +65,9 @@ Not enough memory to allocate resources.
64 @end deftypefun 65 @end deftypefun
65 66
66 @deftypefun int mailbox_create_default (mailbox_t *@var{pmbox}, const char *@var{name}) 67 @deftypefun int mailbox_create_default (mailbox_t *@var{pmbox}, const char *@var{name})
67 The environment variable @emph{$MAIL} or the string formed by 68 Create a mailbox with @code{mailbox_create ()} based on the environment
69 variable @emph{$MAIL} or the string formed by
68 @emph{_PATH_MAILDIR}/@var{user}" or @emph{$LOGNAME} if @var{user} is null, 70 @emph{_PATH_MAILDIR}/@var{user}" or @emph{$LOGNAME} if @var{user} is null,
69 for a default mailbox and calls @code{mailbox_create}.
70 @end deftypefun 71 @end deftypefun
71 72
72 @deftypefun void mailbox_destroy (mailbox_t *@var{pmbox}) 73 @deftypefun void mailbox_destroy (mailbox_t *@var{pmbox})
......
1 @example 1 @example
2 @code{/* Prefix @emph{maildir_} is reserve */} 2 @code{/* Prefix @emph{maildir_} is reserved */}
3 @code{#include <mailutils/maildir.h>} 3 @code{#include <mailutils/maildir.h>}
4 4
5 @end example 5 @end example
......
1 @example 1 @example
2 @code{/* Prefix @emph{mailer_} is reserve */} 2 @code{/* Prefix @emph{mailer_} is reserved */}
3 @code{#include <mailutils/mailer.h>} 3 @code{#include <mailutils/mailer.h>}
4 4
5 @end example 5 @end example
......
...@@ -104,7 +104,7 @@ This document was produced for version @value{VERSION} of @sc{gnu} ...@@ -104,7 +104,7 @@ This document was produced for version @value{VERSION} of @sc{gnu}
104 @end ifinfo 104 @end ifinfo
105 @menu 105 @menu
106 * Introduction:: GNU @sc{mailutils} 106 * Introduction:: GNU @sc{mailutils}
107 * C API:: C API. 107 * Concrete API:: Concrete API.
108 * Framework:: Framework. 108 * Framework:: Framework.
109 * Programs:: Programs. 109 * Programs:: Programs.
110 * Reporting Bugs:: Reporting Bugs. 110 * Reporting Bugs:: Reporting Bugs.
...@@ -114,7 +114,7 @@ This document was produced for version @value{VERSION} of @sc{gnu} ...@@ -114,7 +114,7 @@ This document was produced for version @value{VERSION} of @sc{gnu}
114 114
115 @end menu 115 @end menu
116 116
117 @node Introduction, C API, Top, Top 117 @node Introduction, Concrete API, Top, Top
118 @comment node-name, next, previous, up 118 @comment node-name, next, previous, up
119 @chapter Introduction 119 @chapter Introduction
120 @cindex Introduction 120 @cindex Introduction
...@@ -217,14 +217,14 @@ Misc ...@@ -217,14 +217,14 @@ Misc
217 @cite{Internet Email Protocols a Developer's Guide by Kevin Johnson} 217 @cite{Internet Email Protocols a Developer's Guide by Kevin Johnson}
218 @end itemize 218 @end itemize
219 219
220 @node C API, Framework, Introduction, Top 220 @node Concrete API, Framework, Introduction, Top
221 @comment node-name, next, previous, up 221 @comment node-name, next, previous, up
222 @chapter C API 222 @chapter Concrete API
223 @cindex C API 223 @cindex Concrete API
224 224
225 @include c-api.texi 225 @include c-api.texi
226 226
227 @node Framework, Programs, C API, Top 227 @node Framework, Programs, Concrete API, Top
228 @comment node-name, next, previous, up 228 @comment node-name, next, previous, up
229 @chapter Framework 229 @chapter Framework
230 @cindex Framework 230 @cindex Framework
......
1 @example 1 @example
2 @code{/* Prefix @emph{mbox_} is reserve */} 2 @code{/* Prefix @emph{mbox_} is reserved */}
3 @code{#include <mailutils/mbox.h>} 3 @code{#include <mailutils/mbox.h>}
4 4
5 @end example 5 @end example
......
1 @example 1 @example
2 @code{/* Prefix @emph{mh_} is reserve */} 2 @code{/* Prefix @emph{mh_} is reserved */}
3 @code{#include <mailutils/mh.h>} 3 @code{#include <mailutils/mh.h>}
4 4
5 @end example 5 @end example
......
1 @example 1 @example
2 @code{/* Prefix @emph{nntp_} is reserve */} 2 @code{/* Prefix @emph{nntp_} is reserved */}
3 @code{#include <mailutils/nntp.h>} 3 @code{#include <mailutils/nntp.h>}
4 4
5 @end example 5 @end example
......
1 @example 1 @example
2 @code{/* Prefix @emph{parse822_} is reserve */} 2 @code{/* Prefix @emph{parse822_} is reserved */}
3 @code{#include <mailutils/parse822.h>} 3 @code{#include <mailutils/parse822.h>}
4 4
5 @end example 5 @end example
......
1 @example 1 @example
2 @code{/* Prefix @emph{sendmail_} is reserve */} 2 @code{/* Prefix @emph{sendmail_} is reserved */}
3 @code{#include <mailutils/sendmail.h>} 3 @code{#include <mailutils/sendmail.h>}
4 4
5 @end example 5 @end example
6 6
7 Spawning Sedmail daemon to deliver mail. Not implemented. 7 Spawning Sendmail daemon to deliver mail. Not implemented.
......
1 @example 1 @example
2 @code{/* Prefix @emph{smtp_} is reserve */} 2 @code{/* Prefix @emph{smtp_} is reserved */}
3 @code{#include <mailutils/smtp.h>} 3 @code{#include <mailutils/smtp.h>}
4 4
5 @end example 5 @end example
......