Patch from shaleh to make the verbs and tense agree.
Showing
6 changed files
with
39 additions
and
38 deletions
... | @@ -7,15 +7,15 @@ parsed. | ... | @@ -7,15 +7,15 @@ parsed. |
7 | @end deftypefun | 7 | @end deftypefun |
8 | 8 | ||
9 | @deftypefun void header_destroy (header_t *@var{hdr}, void *@var{owner}) | 9 | @deftypefun void header_destroy (header_t *@var{hdr}, void *@var{owner}) |
10 | The ressources allocate for @var{hdr} are freed. | 10 | The resources allocated for @var{hdr} are freed. |
11 | @end deftypefun | 11 | @end deftypefun |
12 | 12 | ||
13 | @deftypefun int header_set_value (header_t @var{hdr}, const char *@var{fn}, const char *@var{fv}, size_t n, int @var{replace}) | 13 | @deftypefun int header_set_value (header_t @var{hdr}, const char *@var{fn}, const char *@var{fv}, size_t n, int @var{replace}) |
14 | Set the field-name @var{fn} to field-value @var{fv} of size @var{n} in | 14 | Set the field-name @var{fn} to field-value @var{fv} of size @var{n} in |
15 | @var{hdr}. If @var{replace} is non-zero the initial value is replace, if zero | 15 | @var{hdr}. If @var{replace} is non-zero the initial value is replaced, if zero |
16 | it is append. | 16 | it is appended. |
17 | 17 | ||
18 | Some basic macros is already provided for rfc822. | 18 | Some basic macros are already provided for rfc822. |
19 | 19 | ||
20 | @table @code | 20 | @table @code |
21 | @item MU_HDR_RETURN_PATH | 21 | @item MU_HDR_RETURN_PATH |
... | @@ -73,7 +73,7 @@ MIME-Version | ... | @@ -73,7 +73,7 @@ MIME-Version |
73 | @end deftypefun | 73 | @end deftypefun |
74 | 74 | ||
75 | @deftypefun int header_get_value (header_t @var{hdr}, const char *fn, char *fv, size_t len, size_t *n) | 75 | @deftypefun int header_get_value (header_t @var{hdr}, const char *fn, char *fv, size_t len, size_t *n) |
76 | Value of field-name @var{fn} is return in buffer @var{fv} of size @var{len}. | 76 | Value of field-name @var{fn} is returned in buffer @var{fv} of size @var{len}. |
77 | The number of bytes written is put in @var{n}. | 77 | The number of bytes written is put in @var{n}. |
78 | @end deftypefun | 78 | @end deftypefun |
79 | 79 | ... | ... |
1 | @code{#include <mailutils/mailbox.h>} | 1 | @code{#include <mailutils/mailbox.h>} |
2 | @deftp {Data Type} mailbox_t | 2 | @deftp {Data Type} mailbox_t |
3 | The @code{mailbox_t} object is use to hold information and it is an opaque | 3 | The @code{mailbox_t} object is used to hold information and it is an opaque |
4 | data structure to the user. Functions are provided to retrieve the information. | 4 | data structure to the user. Functions are provided to retrieve the information. |
5 | @end deftp | 5 | @end deftp |
6 | @example | 6 | @example |
... | @@ -25,13 +25,13 @@ data structure to the user. Functions are provided to retrieve the information. | ... | @@ -25,13 +25,13 @@ data structure to the user. Functions are provided to retrieve the information. |
25 | @end example | 25 | @end example |
26 | 26 | ||
27 | @deftypefun int mailbox_create (mailbox_t *@var{pmbox}, const char *@var{name}, int @var{id}) | 27 | @deftypefun int mailbox_create (mailbox_t *@var{pmbox}, const char *@var{name}, int @var{id}) |
28 | The funcion @code{mailbox_create} allocates and initializes @var{pmbox}. | 28 | The function @code{mailbox_create} allocates and initializes @var{pmbox}. |
29 | The validation is base on the scheme of the url @var{name} or @var{id}. | 29 | The validation is based on the scheme of the url @var{name} or @var{id}. |
30 | 30 | ||
31 | The return value is @code{0} on success and a code number on error conditions: | 31 | The return value is @code{0} on success and a code number on error conditions: |
32 | @table @code | 32 | @table @code |
33 | @item EINVAL | 33 | @item EINVAL |
34 | The url @var{name} supply is invalid or not supported. | 34 | The url @var{name} supplied is invalid or not supported. |
35 | @var{pmbox} is NULL. | 35 | @var{pmbox} is NULL. |
36 | @item ENOMEM | 36 | @item ENOMEM |
37 | Not enough memory to allocate resources. | 37 | Not enough memory to allocate resources. |
... | @@ -39,7 +39,7 @@ Not enough memory to allocate resources. | ... | @@ -39,7 +39,7 @@ Not enough memory to allocate resources. |
39 | @end deftypefun | 39 | @end deftypefun |
40 | 40 | ||
41 | @deftypefun int mailbox_create_default (mailbox_t *@var{pmbox}, const char *@var{user}) | 41 | @deftypefun int mailbox_create_default (mailbox_t *@var{pmbox}, const char *@var{user}) |
42 | The environment variable @emph{$MAIL} or the string form by | 42 | The environment variable @emph{$MAIL} or the string formed by |
43 | @emph{$MAILDIR}/@var{user}" or @emph{$LOGNAME} if @var{user} is null, | 43 | @emph{$MAILDIR}/@var{user}" or @emph{$LOGNAME} if @var{user} is null, |
44 | for a default mailbox and calls @code{mailbox_create}. | 44 | for a default mailbox and calls @code{mailbox_create}. |
45 | @end deftypefun | 45 | @end deftypefun |
... | @@ -60,14 +60,14 @@ Set the @var{stream} connection to use for the mailbox. | ... | @@ -60,14 +60,14 @@ Set the @var{stream} connection to use for the mailbox. |
60 | The return value is @code{0} on success and a code number on error conditions: | 60 | The return value is @code{0} on success and a code number on error conditions: |
61 | @table @code | 61 | @table @code |
62 | @item EINVAL | 62 | @item EINVAL |
63 | @var{mbox} or @var{stream} are NULL. | 63 | @var{mbox} or @var{stream} is NULL. |
64 | @end table | 64 | @end table |
65 | @end deftypefun | 65 | @end deftypefun |
66 | 66 | ||
67 | @deftypefun int mailbox_open (mailbox_t @var{mbox}, int @var{flag}) | 67 | @deftypefun int mailbox_open (mailbox_t @var{mbox}, int @var{flag}) |
68 | A connection is open, if no stream was provided, a stream | 68 | A connection is open, if no stream was provided, a stream |
69 | is create base on the @var{mbox} type. The @var{flag} can be OR'ed. | 69 | is created based on the @var{mbox} type. The @var{flag} can be OR'ed. |
70 | See @code{stream_create} for @var{flag} description. | 70 | See @code{stream_create} for @var{flag}'s description. |
71 | 71 | ||
72 | The return value is @code{0} on success and a code number on error conditions: | 72 | The return value is @code{0} on success and a code number on error conditions: |
73 | @table @code | 73 | @table @code |
... | @@ -84,7 +84,7 @@ Not enough memory. | ... | @@ -84,7 +84,7 @@ Not enough memory. |
84 | @end deftypefun | 84 | @end deftypefun |
85 | 85 | ||
86 | @deftypefun int mailbox_close (mailbox_t @var{mbox}) | 86 | @deftypefun int mailbox_close (mailbox_t @var{mbox}) |
87 | The stream attach to @var{mbox} is close. | 87 | The stream attach to @var{mbox} is closed. |
88 | 88 | ||
89 | The return value is @code{0} on success and a code number on error conditions: | 89 | The return value is @code{0} on success and a code number on error conditions: |
90 | @table @code | 90 | @table @code |
... | @@ -94,12 +94,12 @@ The return value is @code{0} on success and a code number on error conditions: | ... | @@ -94,12 +94,12 @@ The return value is @code{0} on success and a code number on error conditions: |
94 | @end deftypefun | 94 | @end deftypefun |
95 | 95 | ||
96 | @deftypefun void mailbox_destroy (mailbox_t *@var{pmbox}) | 96 | @deftypefun void mailbox_destroy (mailbox_t *@var{pmbox}) |
97 | Destroy and releases resources hold by @var{pmbox}. | 97 | Destroys and releases resources held by @var{pmbox}. |
98 | @end deftypefun | 98 | @end deftypefun |
99 | 99 | ||
100 | @deftypefun int mailbox_get_message (mailbox_t @var{mbox}, size_t @var{msgno}, message_t *@var{pmessage}) | 100 | @deftypefun int mailbox_get_message (mailbox_t @var{mbox}, size_t @var{msgno}, message_t *@var{pmessage}) |
101 | Retreive message number @var{msgno}, @var{pmessage} is allocate and | 101 | Retreive message number @var{msgno}, @var{pmessage} is allocated and |
102 | initialize. | 102 | initialized. |
103 | 103 | ||
104 | The return value is @code{0} on success and a code number on error conditions: | 104 | The return value is @code{0} on success and a code number on error conditions: |
105 | @table @code | 105 | @table @code |
... | @@ -111,7 +111,7 @@ Not enough memory. | ... | @@ -111,7 +111,7 @@ Not enough memory. |
111 | @end deftypefun | 111 | @end deftypefun |
112 | 112 | ||
113 | @deftypefun int mailbox_append_message (mailbox_t @var{mbox}, message_t @var{message}) | 113 | @deftypefun int mailbox_append_message (mailbox_t @var{mbox}, message_t @var{message}) |
114 | The @var{message} is append to the mailbox @var{mbox}. | 114 | The @var{message} is appended to the mailbox @var{mbox}. |
115 | 115 | ||
116 | The return value is @code{0} on success and a code number on error conditions: | 116 | The return value is @code{0} on success and a code number on error conditions: |
117 | @table @code | 117 | @table @code |
... | @@ -121,7 +121,7 @@ The return value is @code{0} on success and a code number on error conditions: | ... | @@ -121,7 +121,7 @@ The return value is @code{0} on success and a code number on error conditions: |
121 | @end deftypefun | 121 | @end deftypefun |
122 | 122 | ||
123 | @deftypefun int mailbox_messages_count (mailbox_t @var{mbox}, size_t *@var{pnumber}); | 123 | @deftypefun int mailbox_messages_count (mailbox_t @var{mbox}, size_t *@var{pnumber}); |
124 | Give the number of message is @var{mbox}. | 124 | Give the number of messaged in @var{mbox}. |
125 | 125 | ||
126 | The return value is @code{0} on success and a code number on error conditions: | 126 | The return value is @code{0} on success and a code number on error conditions: |
127 | @table @code | 127 | @table @code |
... | @@ -131,7 +131,7 @@ The return value is @code{0} on success and a code number on error conditions: | ... | @@ -131,7 +131,7 @@ The return value is @code{0} on success and a code number on error conditions: |
131 | @end deftypefun | 131 | @end deftypefun |
132 | 132 | ||
133 | @deftypefun int mailbox_expunge (mailbox_t @var{mbox}) | 133 | @deftypefun int mailbox_expunge (mailbox_t @var{mbox}) |
134 | All the messages set deleted are removed. | 134 | All messages marked for deletion are removed. |
135 | 135 | ||
136 | The return value is @code{0} on success and a code number on error conditions: | 136 | The return value is @code{0} on success and a code number on error conditions: |
137 | @table @code | 137 | @table @code |
... | @@ -161,7 +161,7 @@ The return value is @code{0} on success and a code number on error conditions: | ... | @@ -161,7 +161,7 @@ The return value is @code{0} on success and a code number on error conditions: |
161 | @end deftypefun | 161 | @end deftypefun |
162 | 162 | ||
163 | @deftypefun int mailbox_get_auth (mailbox_t @var{mbox}, auth_t *@var{pauth}) | 163 | @deftypefun int mailbox_get_auth (mailbox_t @var{mbox}, auth_t *@var{pauth}) |
164 | Retriever the @var{*pauth} of the @var{mbox}. | 164 | Retrieve the @var{*pauth} of the @var{mbox}. |
165 | 165 | ||
166 | The return value is @code{0} on success and a code number on error conditions: | 166 | The return value is @code{0} on success and a code number on error conditions: |
167 | @table @code | 167 | @table @code |
... | @@ -171,7 +171,7 @@ The return value is @code{0} on success and a code number on error conditions: | ... | @@ -171,7 +171,7 @@ The return value is @code{0} on success and a code number on error conditions: |
171 | @end deftypefun | 171 | @end deftypefun |
172 | 172 | ||
173 | @deftypefun int mailbox_set_auth (mailbox_t @var{mbox}, auth_t @var{auth}) | 173 | @deftypefun int mailbox_set_auth (mailbox_t @var{mbox}, auth_t @var{auth}) |
174 | Set the type of authaurity for the mailbox. | 174 | Set the type of authentication for the mailbox. |
175 | 175 | ||
176 | The return value is @code{0} on success and a code number on error conditions: | 176 | The return value is @code{0} on success and a code number on error conditions: |
177 | @table @code | 177 | @table @code |
... | @@ -181,7 +181,7 @@ The return value is @code{0} on success and a code number on error conditions: | ... | @@ -181,7 +181,7 @@ The return value is @code{0} on success and a code number on error conditions: |
181 | @end deftypefun | 181 | @end deftypefun |
182 | 182 | ||
183 | @deftypefun int mailbox_is_updated (mailbox_t @var{mbox}) | 183 | @deftypefun int mailbox_is_updated (mailbox_t @var{mbox}) |
184 | Check if the mailbox is uptodate. | 184 | Check if the mailbox is up-to-date. |
185 | 185 | ||
186 | The return value is @code{0} on success and a code number on error conditions: | 186 | The return value is @code{0} on success and a code number on error conditions: |
187 | @table @code | 187 | @table @code | ... | ... |
... | @@ -103,7 +103,7 @@ This document was produced for version @value{VERSION} of @sc{gnu} | ... | @@ -103,7 +103,7 @@ This document was produced for version @value{VERSION} of @sc{gnu} |
103 | @menu | 103 | @menu |
104 | * Introduction:: GNU @sc{mailutils} | 104 | * Introduction:: GNU @sc{mailutils} |
105 | * Mailbox:: Mailbox API. | 105 | * Mailbox:: Mailbox API. |
106 | * Mailer:: Protocol Use to Send Mail. | 106 | * Mailer:: Protocol Used to Send Mail. |
107 | * Message:: Message API. | 107 | * Message:: Message API. |
108 | * Headers:: Headers API. | 108 | * Headers:: Headers API. |
109 | * Body:: Body API. | 109 | * Body:: Body API. |
... | @@ -125,8 +125,9 @@ This document was produced for version @value{VERSION} of @sc{gnu} | ... | @@ -125,8 +125,9 @@ This document was produced for version @value{VERSION} of @sc{gnu} |
125 | @chapter Introduction | 125 | @chapter Introduction |
126 | @cindex Introduction | 126 | @cindex Introduction |
127 | 127 | ||
128 | @sc{gnu} @sc{Mailutils} offers a general purpose library aim to provide | 128 | @sc{gnu} @sc{Mailutils} offers a general purpose library whose aim is to |
129 | a rich set of functions for accessing different mailbox formats and mailers. | 129 | provide a rich set of functions for accessing different mailbox formats and |
130 | mailers. | ||
130 | 131 | ||
131 | @example | 132 | @example |
132 | @group | 133 | @group |
... | @@ -139,7 +140,7 @@ a rich set of functions for accessing different mailbox formats and mailers. | ... | @@ -139,7 +140,7 @@ a rich set of functions for accessing different mailbox formats and mailers. |
139 | ----------- +-----------------+ | | ... | | 140 | ----------- +-----------------+ | | ... | |
140 | ( jeff ) +---|-* message_t[0] | | +-----------+ | 141 | ( jeff ) +---|-* message_t[0] | | +-----------+ |
141 | ----------- | | message_t[1] | | | 142 | ----------- | | message_t[1] | | |
142 | ( sean ) | | ... | | auth_t | 143 | ( shaleh ) | | ... | | auth_t |
143 | ---------- | +-----------------+ +-->+----------+ | 144 | ---------- | +-----------------+ +-->+----------+ |
144 | | | user | | 145 | | | user | |
145 | message_t | | passwd | | 146 | message_t | | passwd | |
... | @@ -155,8 +156,8 @@ a rich set of functions for accessing different mailbox formats and mailers. | ... | @@ -155,8 +156,8 @@ a rich set of functions for accessing different mailbox formats and mailers. |
155 | @end group | 156 | @end group |
156 | @end example | 157 | @end example |
157 | 158 | ||
158 | For example writing a simple @command{from} command that will list @emph{From} | 159 | For example writing a simple @command{from} command that will list the |
159 | and @emph{Subject} of a folder. | 160 | @emph{From} and @emph{Subject} headers of every mail in a folder. |
160 | 161 | ||
161 | @example | 162 | @example |
162 | @include sfrom.c.texi | 163 | @include sfrom.c.texi |
... | @@ -256,7 +257,7 @@ Be sure to include the word ``mailutils'' somewhere in the ``Subject:'' field. | ... | @@ -256,7 +257,7 @@ Be sure to include the word ``mailutils'' somewhere in the ``Subject:'' field. |
256 | In no particular order, | 257 | In no particular order, |
257 | Jakob Kaivo @email{jkaivo@@ndn.net}, | 258 | Jakob Kaivo @email{jkaivo@@ndn.net}, |
258 | Jeff Bailey @email{jbailey@@gnu.org}, | 259 | Jeff Bailey @email{jbailey@@gnu.org}, |
259 | Sean Perry @email{shaleh@@debian.org}, | 260 | Sean 'Shaleh' Perry @email{shaleh@@debian.org}, |
260 | Thomas Fletcher @email{thomasf@@qnx.com}. | 261 | Thomas Fletcher @email{thomasf@@qnx.com}. |
261 | Dave Inglis @email{dinglis@@qnx.com}. | 262 | Dave Inglis @email{dinglis@@qnx.com}. |
262 | Brian Edmond @email{briane@@qnx.com}. | 263 | Brian Edmond @email{briane@@qnx.com}. | ... | ... |
... | @@ -13,16 +13,16 @@ The stream is open write only. | ... | @@ -13,16 +13,16 @@ The stream is open write only. |
13 | The stream is open read and write. | 13 | The stream is open read and write. |
14 | @item MU_STREAM_APPEND | 14 | @item MU_STREAM_APPEND |
15 | @findex MU_STREAM_APPEND | 15 | @findex MU_STREAM_APPEND |
16 | The stream is open in append mode for write. | 16 | The stream is open in append mode for writing. |
17 | @item MU_STREAM_CREAT | 17 | @item MU_STREAM_CREAT |
18 | @findex MU_STREAM_CREAT | 18 | @findex MU_STREAM_CREAT |
19 | The stream is create. | 19 | The stream is created. |
20 | @item MU_STREAM_NONBLOCK | 20 | @item MU_STREAM_NONBLOCK |
21 | @findex MU_STREAM_NONBLOCK | 21 | @findex MU_STREAM_NONBLOCK |
22 | The stream is set non blocking. | 22 | The stream is set non blocking. |
23 | @item MU_STREAM_NO_CHECK | 23 | @item MU_STREAM_NO_CHECK |
24 | @findex MU_STREAM_NO_CHECK | 24 | @findex MU_STREAM_NO_CHECK |
25 | Stream is destroy without checking for the owner. | 25 | Stream is destroyed without checking for the owner. |
26 | @end table | 26 | @end table |
27 | @end deftypefun | 27 | @end deftypefun |
28 | 28 | ... | ... |
1 | 1 | ||
2 | @comment See rfc2368, rfc2369, rfc2384 | 2 | @comment See rfc2368, rfc2369, rfc2384 |
3 | A mailbox and mailer can be describe in a URL, the string will contain the | 3 | A mailbox and mailer can be described in a URL, the string will contain the |
4 | necessary information to initialize @code{mailbox_t}, or @code{mailer_t} | 4 | necessary information to initialize @code{mailbox_t}, or @code{mailer_t} |
5 | properly. | 5 | properly. |
6 | 6 | ||
... | @@ -13,7 +13,7 @@ and the authentication mechanism. The general form is | ... | @@ -13,7 +13,7 @@ and the authentication mechanism. The general form is |
13 | @url{pop://obelix;AUTH=+APOP@@village.gaulois.org:2000} | 13 | @url{pop://obelix;AUTH=+APOP@@village.gaulois.org:2000} |
14 | @end example | 14 | @end example |
15 | 15 | ||
16 | If @emph{:port} is omitted the default value is 110. Different form of | 16 | If @emph{:port} is omitted the default value is 110. Different forms of |
17 | authentication can be specified with @emph{;AUTH=type}. | 17 | authentication can be specified with @emph{;AUTH=type}. |
18 | The special string @emph{;AUTH=*} indicates that the client will use | 18 | The special string @emph{;AUTH=*} indicates that the client will use |
19 | a default scheme base on the capability of the server. | 19 | a default scheme base on the capability of the server. |
... | @@ -52,13 +52,13 @@ use @url{file://path} and let the library figure out which one. | ... | @@ -52,13 +52,13 @@ use @url{file://path} and let the library figure out which one. |
52 | 52 | ||
53 | @section Mailto | 53 | @section Mailto |
54 | 54 | ||
55 | After setting a mailer, @url{mailto:} is use to tell the mailer where | 55 | After setting a mailer, @url{mailto:} is used to tell the mailer where |
56 | and to whom the message is for. | 56 | and to whom the message is for. |
57 | @example | 57 | @example |
58 | @url{mailto://hostname} | 58 | @url{mailto://hostname} |
59 | @end example | 59 | @end example |
60 | 60 | ||
61 | Mailto can be use to generate short messages for example to subscribe | 61 | Mailto can be used to generate short messages, for example to subscribe |
62 | to mailing lists. | 62 | to mailing lists. |
63 | @example | 63 | @example |
64 | @url{mailto://bug-mailutils@@gnu.org?body=subscribe} | 64 | @url{mailto://bug-mailutils@@gnu.org?body=subscribe} | ... | ... |
-
Please register or sign in to post a comment