Skip to content

John McEleney / mailutils

Go to a project
Toggle navigation
Toggle navigation pinning
Commit 2aeeeff8 2aeeeff8dd895a10d89a25b961acdce44fb0b436 by Sergey Poznyakoff
Options

Reflect namespace changes

1 parent 5d383c02
Expand all
Inline Side-by-side
Showing 24 changed files with 512 additions and 467 deletions
1 @c This is part of the GNU Mailutils manual. 1 @c This is part of the GNU Mailutils manual.
2 @c Copyright (C) 1999,2000,2001,2002,2003,2004 Free Software Foundation, Inc. 2 @c Copyright (C) 1999,2000,2001,2002,2003,2004,2006
3 @c Free Software Foundation, Inc.
3 @c See file mailutils.texi for copying conditions. 4 @c See file mailutils.texi for copying conditions.
4 @comment ******************************************************************* 5 @comment *******************************************************************
5 6
...@@ -70,8 +71,8 @@ The index @var{no} is outside of the range of available addresses. ...@@ -70,8 +71,8 @@ The index @var{no} is outside of the range of available addresses.
70 Invalid usage, usually a required argument was @code{NULL}. 71 Invalid usage, usually a required argument was @code{NULL}.
71 @end macro 72 @end macro
72 73
73 @deftp {Data Type} address_t 74 @deftp {Data Type} mu_address_t
74 The @code{address_t} object is used to hold information about a parsed 75 The @code{mu_address_t} object is used to hold information about a parsed
75 RFC822 address list, and is an opaque 76 RFC822 address list, and is an opaque
76 data structure to the user. Functions are provided to retrieve information 77 data structure to the user. Functions are provided to retrieve information
77 about an address in the address list. 78 about an address in the address list.
...@@ -81,7 +82,7 @@ about an address in the address list. ...@@ -81,7 +82,7 @@ about an address in the address list.
81 @c Functions. 82 @c Functions.
82 @c 83 @c
83 84
84 @deftypefun int address_create (address_t *@var{addr}, const char *@var{string}) 85 @deftypefun int mu_address_create (mu_address_t *@var{addr}, const char *@var{string})
85 This function allocates and initializes @var{addr} by parsing the 86 This function allocates and initializes @var{addr} by parsing the
86 RFC822 address-list @var{string}. 87 RFC822 address-list @var{string}.
87 88
...@@ -93,7 +94,7 @@ The return value is @code{0} on success and a code number on error conditions: ...@@ -93,7 +94,7 @@ The return value is @code{0} on success and a code number on error conditions:
93 @end table 94 @end table
94 @end deftypefun 95 @end deftypefun
95 96
96 @deftypefun int address_createv (address_t *@var{addr}, const char *@var{sv}, size_t @var{len}) 97 @deftypefun int mu_address_createv (mu_address_t *@var{addr}, const char *@var{sv}, size_t @var{len})
97 This function allocates and initializes @var{addr} by parsing the 98 This function allocates and initializes @var{addr} by parsing the
98 array of pointers to RFC822 address-lists in @var{sv}. If @var{len} is 99 array of pointers to RFC822 address-lists in @var{sv}. If @var{len} is
99 @code{-1}, then @var{sv} must be @code{NULL} terminated in the fashion of @var{argv}, 100 @code{-1}, then @var{sv} must be @code{NULL} terminated in the fashion of @var{argv},
...@@ -107,7 +108,7 @@ The return value is @code{0} on success and a code number on error conditions: ...@@ -107,7 +108,7 @@ The return value is @code{0} on success and a code number on error conditions:
107 @end table 108 @end table
108 @end deftypefun 109 @end deftypefun
109 110
110 @deftypefun void address_destroy (address_t *@var{addr}) 111 @deftypefun void mu_address_destroy (mu_address_t *@var{addr})
111 The @var{addr} is destroyed. 112 The @var{addr} is destroyed.
112 @end deftypefun 113 @end deftypefun
113 114
...@@ -115,10 +116,10 @@ The @var{addr} is destroyed. ...@@ -115,10 +116,10 @@ The @var{addr} is destroyed.
115 @c address_get_ 116 @c address_get_
116 @c 117 @c
117 118
118 @deftypefun int address_get_nth (address_t @var{addr}, size_t @var{no}, address_t *@var{ret}) 119 @deftypefun int mu_address_get_nth (mu_address_t @var{addr}, size_t @var{no}, mu_address_t *@var{ret})
119 @end deftypefun 120 @end deftypefun
120 121
121 @deftypefun int address_get_email (address_t @var{addr}, size_t @var{no}, char* @var{buf}, size_t @var{len}, size_t *@var{n}) 122 @deftypefun int mu_address_get_email (mu_address_t @var{addr}, size_t @var{no}, char* @var{buf}, size_t @var{len}, size_t *@var{n})
122 Accesses the @var{no}th email address component of the address list. This 123 Accesses the @var{no}th email address component of the address list. This
123 address is the plain email address, correctly quoted, suitable for 124 address is the plain email address, correctly quoted, suitable for
124 using in an smtp dialog, for example, or as the address part of 125 using in an smtp dialog, for example, or as the address part of
...@@ -134,7 +135,7 @@ The return value is @code{0} on success and a code number on error conditions: ...@@ -134,7 +135,7 @@ The return value is @code{0} on success and a code number on error conditions:
134 @end table 135 @end table
135 @end deftypefun 136 @end deftypefun
136 137
137 @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}) 138 @deftypefun int mu_address_get_local_part (mu_address_t @var{addr}, size_t @var{no}, char *@var{buf}, size_t @var{len}, size_t *@var{n})
138 Accesses the local-part of an email addr-spec extracted while 139 Accesses the local-part of an email addr-spec extracted while
139 parsing the @var{no}th email address. 140 parsing the @var{no}th email address.
140 141
...@@ -145,7 +146,7 @@ The return value is @code{0} on success and a code number on error conditions: ...@@ -145,7 +146,7 @@ The return value is @code{0} on success and a code number on error conditions:
145 @end table 146 @end table
146 @end deftypefun 147 @end deftypefun
147 148
148 @deftypefun int address_get_domain (address_t @var{addr}, size_t @var{no}, char *@var{buf}, size_t @var{len}, size_t *@var{n}) 149 @deftypefun int mu_address_get_domain (mu_address_t @var{addr}, size_t @var{no}, char *@var{buf}, size_t @var{len}, size_t *@var{n})
149 Accesses the domain of an email addr-spec extracted while 150 Accesses the domain of an email addr-spec extracted while
150 parsing the @var{no}th email address. This will be @code{0} 151 parsing the @var{no}th email address. This will be @code{0}
151 length for a unix-mbox. 152 length for a unix-mbox.
...@@ -157,7 +158,7 @@ The return value is @code{0} on success and a code number on error conditions: ...@@ -157,7 +158,7 @@ The return value is @code{0} on success and a code number on error conditions:
157 @end table 158 @end table
158 @end deftypefun 159 @end deftypefun
159 160
160 @deftypefun int address_get_personal (address_t @var{addr}, size_t @var{no}, char *@var{buf}, size_t @var{len}, size_t *@var{n}) 161 @deftypefun int mu_address_get_personal (mu_address_t @var{addr}, size_t @var{no}, char *@var{buf}, size_t @var{len}, size_t *@var{n})
161 Accesses the display-name describing the @var{no}th email address. This 162 Accesses the display-name describing the @var{no}th email address. This
162 display-name is optional, so may not be present. If it is not present, but 163 display-name is optional, so may not be present. If it is not present, but
163 there is an RFC822 comment after the address, that comment will be 164 there is an RFC822 comment after the address, that comment will be
...@@ -168,7 +169,7 @@ A group is a kind of a special case. It has a display-name, followed ...@@ -168,7 +169,7 @@ A group is a kind of a special case. It has a display-name, followed
168 by an optional mailbox-list. The display-name will be allocated an address 169 by an optional mailbox-list. The display-name will be allocated an address
169 all it's own, but all the other elements (local-part, domain, etc.) will 170 all it's own, but all the other elements (local-part, domain, etc.) will
170 be zero-length. So "a group: ;" is valid, will have a count of 1, but 171 be zero-length. So "a group: ;" is valid, will have a count of 1, but
171 @code{address_get_email()}, and all the rest, will return zero-length output. 172 @code{mu_address_get_email()}, and all the rest, will return zero-length output.
172 173
173 The return value is @code{0} on success and a code number on error conditions: 174 The return value is @code{0} on success and a code number on error conditions:
174 @table @code 175 @table @code
...@@ -177,7 +178,7 @@ The return value is @code{0} on success and a code number on error conditions: ...@@ -177,7 +178,7 @@ The return value is @code{0} on success and a code number on error conditions:
177 @end table 178 @end table
178 @end deftypefun 179 @end deftypefun
179 180
180 @deftypefun int address_get_comments (address_t @var{addr}, size_t @var{no}, char *@var{buf}, size_t @var{len}, size_t *@var{n}) 181 @deftypefun int mu_address_get_comments (mu_address_t @var{addr}, size_t @var{no}, char *@var{buf}, size_t @var{len}, size_t *@var{n})
181 Accesses the comments extracted while parsing the @var{no}th email address. 182 Accesses the comments extracted while parsing the @var{no}th email address.
182 These comments have no defined meaning, and are not currently collected. 183 These comments have no defined meaning, and are not currently collected.
183 184
...@@ -188,7 +189,7 @@ The return value is @code{0} on success and a code number on error conditions: ...@@ -188,7 +189,7 @@ The return value is @code{0} on success and a code number on error conditions:
188 @end table 189 @end table
189 @end deftypefun 190 @end deftypefun
190 191
191 @deftypefun int address_get_route (address_t @var{addr}, size_t @var{no}, char *@var{buf}, size_t @var{len}, size_t *@var{n}) 192 @deftypefun int mu_address_get_route (mu_address_t @var{addr}, size_t @var{no}, char *@var{buf}, size_t @var{len}, size_t *@var{n})
192 Accesses the route of an email addr-spec extracted while 193 Accesses the route of an email addr-spec extracted while
193 parsing the @var{no}th email address. This is a rarely used RFC822 address 194 parsing the @var{no}th email address. This is a rarely used RFC822 address
194 syntax, but is legal in SMTP as well. The entire route is returned as 195 syntax, but is legal in SMTP as well. The entire route is returned as
...@@ -205,7 +206,7 @@ The return value is @code{0} on success and a code number on error conditions: ...@@ -205,7 +206,7 @@ The return value is @code{0} on success and a code number on error conditions:
205 @c address_aget_ 206 @c address_aget_
206 @c 207 @c
207 208
208 @deftypefun int address_aget_email (address_t @var{addr}, size_t @var{no}, char **@var{bufp}) 209 @deftypefun int mu_address_aget_email (mu_address_t @var{addr}, size_t @var{no}, char **@var{bufp})
209 As above, but mallocs the email address, if present, 210 As above, but mallocs the email address, if present,
210 and write a pointer to it into @var{bufp}. @var{bufp} will be @code{NULL} 211 and write a pointer to it into @var{bufp}. @var{bufp} will be @code{NULL}
211 if there is no email address to return. 212 if there is no email address to return.
...@@ -217,20 +218,20 @@ The return value is @code{0} on success and a code number on error conditions: ...@@ -217,20 +218,20 @@ The return value is @code{0} on success and a code number on error conditions:
217 @end table 218 @end table
218 @end deftypefun 219 @end deftypefun
219 220
220 @deftypefun int address_aget_local_part (address_t @var{addr}, size_t @var{no}, char **@var{buf}) 221 @deftypefun int mu_address_aget_local_part (mu_address_t @var{addr}, size_t @var{no}, char **@var{buf})
221 @end deftypefun 222 @end deftypefun
222 223
223 @deftypefun int address_aget_domain (address_t @var{addr}, size_t @var{no}, char **@var{buf}) 224 @deftypefun int mu_address_aget_domain (mu_address_t @var{addr}, size_t @var{no}, char **@var{buf})
224 @end deftypefun 225 @end deftypefun
225 226
226 @deftypefun int address_aget_personal (address_t @var{addr}, size_t @var{no}, char **@var{buf}) 227 @deftypefun int mu_address_aget_personal (mu_address_t @var{addr}, size_t @var{no}, char **@var{buf})
227 @end deftypefun 228 @end deftypefun
228 229
229 @c 230 @c
230 @c ----------- 231 @c -----------
231 @c 232 @c
232 233
233 @deftypefun int address_is_group (address_t @var{addr}, size_t @var{no}, int *@var{yes}) 234 @deftypefun int mu_address_is_group (mu_address_t @var{addr}, size_t @var{no}, int *@var{yes})
234 Sets *@var{yes} to @code{1} if this address is just the name of a group, 235 Sets *@var{yes} to @code{1} if this address is just the name of a group,
235 @code{0} otherwise. This is faster than checking if the address has 236 @code{0} otherwise. This is faster than checking if the address has
236 a non-zero length personal, and a zero-length local_part and domain. 237 a non-zero length personal, and a zero-length local_part and domain.
...@@ -247,7 +248,7 @@ The return value is @code{0} on success and a code number on error conditions: ...@@ -247,7 +248,7 @@ The return value is @code{0} on success and a code number on error conditions:
247 @end table 248 @end table
248 @end deftypefun 249 @end deftypefun
249 250
250 @deftypefun int address_to_string (address_t *@var{addr}, char *@var{buf}, size_t @var{len}, size_t *@var{n}) 251 @deftypefun int mu_address_to_string (mu_address_t *@var{addr}, char *@var{buf}, size_t @var{len}, size_t *@var{n})
251 Returns the entire address list as a single RFC822 formatted address list. 252 Returns the entire address list as a single RFC822 formatted address list.
252 253
253 The return value is @code{0} on success and a code number on error conditions: 254 The return value is @code{0} on success and a code number on error conditions:
...@@ -257,7 +258,7 @@ The return value is @code{0} on success and a code number on error conditions: ...@@ -257,7 +258,7 @@ The return value is @code{0} on success and a code number on error conditions:
257 @end table 258 @end table
258 @end deftypefun 259 @end deftypefun
259 260
260 @deftypefun int address_get_count (address_t @var{addr}, size_t *@var{count}) 261 @deftypefun int mu_address_get_count (mu_address_t @var{addr}, size_t *@var{count})
261 Returns a count of the addresses in the address list. 262 Returns a count of the addresses in the address list.
262 263
263 If @var{addr} is @code{NULL}, the count is @code{0}. If @var{count} is 264 If @var{addr} is @code{NULL}, the count is @code{0}. If @var{count} is
...@@ -266,22 +267,22 @@ not @code{NULL}, the count will be written to *@var{count}. ...@@ -266,22 +267,22 @@ not @code{NULL}, the count will be written to *@var{count}.
266 The return value is @code{0}. 267 The return value is @code{0}.
267 @end deftypefun 268 @end deftypefun
268 269
269 @deftypefun int address_get_group_count (address_t @var{addr}, size_t *) 270 @deftypefun int mu_address_get_group_count (mu_address_t @var{addr}, size_t *)
270 @end deftypefun 271 @end deftypefun
271 272
272 @deftypefun int address_get_email_count (address_t @var{addr}, size_t *) 273 @deftypefun int mu_address_get_email_count (mu_address_t @var{addr}, size_t *)
273 @end deftypefun 274 @end deftypefun
274 275
275 @deftypefun int address_get_unix_mailbox_count (address_t @var{addr}, size_t *) 276 @deftypefun int mu_address_get_unix_mailbox_count (mu_address_t @var{addr}, size_t *)
276 @end deftypefun 277 @end deftypefun
277 278
278 @deftypefun int address_contains_email (address_t @var{addr}, const char *@var{email}) 279 @deftypefun int mu_address_contains_email (mu_address_t @var{addr}, const char *@var{email})
279 @end deftypefun 280 @end deftypefun
280 281
281 @deftypefun int address_union (address_t *@var{a}, address_t @var{b}) 282 @deftypefun int mu_address_union (mu_address_t *@var{a}, mu_address_t @var{b})
282 @end deftypefun 283 @end deftypefun
283 284
284 @deftypefun size_t address_format_string (address_t @var{addr}, char *@var{buf}, size_t @var{buflen}) 285 @deftypefun size_t mu_address_format_string (mu_address_t @var{addr}, char *@var{buf}, size_t @var{buflen})
285 @end deftypefun 286 @end deftypefun
286 287
287 @subheading Example 288 @subheading Example
......
1 @c This is part of the GNU Mailutils manual. 1 @c This is part of the GNU Mailutils manual.
2 @c Copyright (C) 1999,2000,2001,2002,2003,2004 Free Software Foundation, Inc. 2 @c Copyright (C) 1999,2000,2001,2002,2003,2004,2006
3 @c Free Software Foundation, Inc.
3 @c See file mailutils.texi for copying conditions. 4 @c See file mailutils.texi for copying conditions.
4 @comment ******************************************************************* 5 @comment *******************************************************************
5 6
6 @smallexample 7 @smallexample
7 @code{/* Prefix @emph{attribute_} is reserved. */} 8 @code{/* Prefix @emph{mu_attribute_} is reserved. */}
8 @code{#include <mailutils/attribute.h>} 9 @code{#include <mailutils/attribute.h>}
9 @end smallexample 10 @end smallexample
10 11
11 @deftypefun int attribute_create (attribute_t *@var{attr}, void *) 12 @deftypefun int mu_attribute_create (mu_attribute_t *@var{attr}, void *)
12 @end deftypefun 13 @end deftypefun
13 14
14 @deftypefun void attribute_destroy (attribute_t *@var{attr}, void *) 15 @deftypefun void mu_attribute_destroy (mu_attribute_t *@var{attr}, void *)
15 @end deftypefun 16 @end deftypefun
16 17
17 @deftypefun void* attribute_get_owner (attribute_t @var{attr}) 18 @deftypefun void* mu_attribute_get_owner (mu_attribute_t @var{attr})
18 @end deftypefun 19 @end deftypefun
19 20
20 @deftypefun int attribute_is_modified (attribute_t @var{attr}) 21 @deftypefun int mu_attribute_is_modified (mu_attribute_t @var{attr})
21 @end deftypefun 22 @end deftypefun
22 23
23 @deftypefun int attribute_clear_modified (attribute_t @var{attr}) 24 @deftypefun int mu_attribute_clear_modified (mu_attribute_t @var{attr})
24 @end deftypefun 25 @end deftypefun
25 26
26 @deftypefun int attribute_set_modified (attribute_t @var{attr}) 27 @deftypefun int mu_attribute_set_modified (mu_attribute_t @var{attr})
27 @end deftypefun 28 @end deftypefun
28 29
29 @c 30 @c
30 @c _is_ 31 @c _is_
31 @c 32 @c
32 33
33 @deftypefun int attribute_is_userflag (attribute_t @var{attr}) 34 @deftypefun int mu_attribute_is_userflag (mu_attribute_t @var{attr})
34 @end deftypefun 35 @end deftypefun
35 36
36 @deftypefun int attribute_is_seen (attribute_t @var{attr}) 37 @deftypefun int mu_attribute_is_seen (mu_attribute_t @var{attr})
37 @end deftypefun 38 @end deftypefun
38 39
39 @deftypefun int attribute_is_answered (attribute_t @var{attr}) 40 @deftypefun int mu_attribute_is_answered (mu_attribute_t @var{attr})
40 @end deftypefun 41 @end deftypefun
41 42
42 @deftypefun int attribute_is_flagged (attribute_t @var{attr}) 43 @deftypefun int mu_attribute_is_flagged (mu_attribute_t @var{attr})
43 @end deftypefun 44 @end deftypefun
44 45
45 @deftypefun int attribute_is_deleted (attribute_t @var{attr}) 46 @deftypefun int mu_attribute_is_deleted (mu_attribute_t @var{attr})
46 @end deftypefun 47 @end deftypefun
47 48
48 @deftypefun int attribute_is_draft (attribute_t @var{attr}) 49 @deftypefun int mu_attribute_is_draft (mu_attribute_t @var{attr})
49 @end deftypefun 50 @end deftypefun
50 51
51 @deftypefun int attribute_is_recent (attribute_t @var{attr}) 52 @deftypefun int mu_attribute_is_recent (mu_attribute_t @var{attr})
52 @end deftypefun 53 @end deftypefun
53 54
54 @deftypefun int attribute_is_read (attribute_t @var{attr}) 55 @deftypefun int mu_attribute_is_read (mu_attribute_t @var{attr})
55 @end deftypefun 56 @end deftypefun
56 57
57 @c 58 @c
58 @c _set_ 59 @c _set_
59 @c 60 @c
60 61
61 @deftypefun int attribute_set_userflag (attribute_t @var{attr}, int) 62 @deftypefun int mu_attribute_set_userflag (mu_attribute_t @var{attr}, int)
62 @end deftypefun 63 @end deftypefun
63 64
64 @deftypefun int attribute_set_seen (attribute_t @var{attr}) 65 @deftypefun int mu_attribute_set_seen (mu_attribute_t @var{attr})
65 @end deftypefun 66 @end deftypefun
66 67
67 @deftypefun int attribute_set_answered (attribute_t @var{attr}) 68 @deftypefun int mu_attribute_set_answered (mu_attribute_t @var{attr})
68 @end deftypefun 69 @end deftypefun
69 70
70 @deftypefun int attribute_set_flagged (attribute_t @var{attr}) 71 @deftypefun int mu_attribute_set_flagged (mu_attribute_t @var{attr})
71 @end deftypefun 72 @end deftypefun
72 73
73 @deftypefun int attribute_set_deleted (attribute_t @var{attr}) 74 @deftypefun int mu_attribute_set_deleted (mu_attribute_t @var{attr})
74 @end deftypefun 75 @end deftypefun
75 76
76 @deftypefun int attribute_set_draft (attribute_t @var{attr}) 77 @deftypefun int mu_attribute_set_draft (mu_attribute_t @var{attr})
77 @end deftypefun 78 @end deftypefun
78 79
79 @deftypefun int attribute_set_recent (attribute_t @var{attr}) 80 @deftypefun int mu_attribute_set_recent (mu_attribute_t @var{attr})
80 @end deftypefun 81 @end deftypefun
81 82
82 @deftypefun int attribute_set_read (attribute_t @var{attr}) 83 @deftypefun int mu_attribute_set_read (mu_attribute_t @var{attr})
83 @end deftypefun 84 @end deftypefun
84 85
85 @c 86 @c
86 @c _unset_ 87 @c _unset_
87 @c 88 @c
88 89
89 @deftypefun int attribute_unset_userflag (attribute_t @var{attr}, int) 90 @deftypefun int mu_attribute_unset_userflag (mu_attribute_t @var{attr}, int)
90 @end deftypefun 91 @end deftypefun
91 92
92 @deftypefun int attribute_unset_seen (attribute_t @var{attr}) 93 @deftypefun int mu_attribute_unset_seen (mu_attribute_t @var{attr})
93 @end deftypefun 94 @end deftypefun
94 95
95 @deftypefun int attribute_unset_answered (attribute_t @var{attr}) 96 @deftypefun int mu_attribute_unset_answered (mu_attribute_t @var{attr})
96 @end deftypefun 97 @end deftypefun
97 98
98 @deftypefun int attribute_unset_flagged (attribute_t @var{attr}) 99 @deftypefun int mu_attribute_unset_flagged (mu_attribute_t @var{attr})
99 @end deftypefun 100 @end deftypefun
100 101
101 @deftypefun int attribute_unset_deleted (attribute_t @var{attr}) 102 @deftypefun int mu_attribute_unset_deleted (mu_attribute_t @var{attr})
102 @end deftypefun 103 @end deftypefun
103 104
104 @deftypefun int attribute_unset_draft (attribute_t @var{attr}) 105 @deftypefun int mu_attribute_unset_draft (mu_attribute_t @var{attr})
105 @end deftypefun 106 @end deftypefun
106 107
107 @deftypefun int attribute_unset_recent (attribute_t @var{attr}) 108 @deftypefun int mu_attribute_unset_recent (mu_attribute_t @var{attr})
108 @end deftypefun 109 @end deftypefun
109 110
110 @deftypefun int attribute_unset_read (attribute_t @var{attr}) 111 @deftypefun int mu_attribute_unset_read (mu_attribute_t @var{attr})
111 @end deftypefun 112 @end deftypefun
112 113
113 @c 114 @c
114 @c ---------- 115 @c ----------
115 @c 116 @c
116 117
117 @deftypefun int attribute_get_flags (attribute_t @var{attr}, int *) 118 @deftypefun int mu_attribute_get_flags (mu_attribute_t @var{attr}, int *)
118 @end deftypefun 119 @end deftypefun
119 120
120 @deftypefun int attribute_set_flags (attribute_t @var{attr}, int) 121 @deftypefun int mu_attribute_set_flags (mu_attribute_t @var{attr}, int)
121 @end deftypefun 122 @end deftypefun
122 123
123 @deftypefun int attribute_unset_flags (attribute_t @var{attr}, int) 124 @deftypefun int mu_attribute_unset_flags (mu_attribute_t @var{attr}, int)
124 @end deftypefun 125 @end deftypefun
125 126
126 @deftypefun int attribute_set_set_flags (attribute_t @var{attr}, int (*@var{_set_flags}) (attribute_t, int), void *) 127 @deftypefun int mu_attribute_set_set_flags (mu_attribute_t @var{attr}, int (*@var{_set_flags}) (mu_attribute_t, int), void *)
127 @end deftypefun 128 @end deftypefun
128 129
129 @deftypefun int attribute_set_unset_flags (attribute_t @var{attr}, int (*@var{_unset_flags}) (attribute_t, int), void *) 130 @deftypefun int mu_attribute_set_unset_flags (mu_attribute_t @var{attr}, int (*@var{_unset_flags}) (mu_attribute_t, int), void *)
130 @end deftypefun 131 @end deftypefun
131 132
132 @deftypefun int attribute_set_get_flags (attribute_t @var{attr}, int (*@var{_get_flags}) (attribute_t, int *), void *) 133 @deftypefun int mu_attribute_set_get_flags (mu_attribute_t @var{attr}, int (*@var{_get_flags}) (mu_attribute_t, int *), void *)
133 @end deftypefun 134 @end deftypefun
134 135
135 @c 136 @c
136 @c ---------- 137 @c ----------
137 @c 138 @c
138 139
139 @deftypefun int attribute_is_equal (attribute_t @var{attr1}, attribute_t @var{attr2}) 140 @deftypefun int mu_attribute_is_equal (mu_attribute_t @var{attr1}, mu_attribute_t @var{attr2})
140 @end deftypefun 141 @end deftypefun
141 142
142 @deftypefun int attribute_copy (attribute_t @var{dst}, attribute_t @var{src}) 143 @deftypefun int mu_attribute_copy (mu_attribute_t @var{dst}, mu_attribute_t @var{src})
143 @end deftypefun 144 @end deftypefun
144 145
145 @deftypefun int attribute_to_string (attribute_t @var{attr}, char *@var{buf}, size_t @var{len}, size_t *@var{writen}) 146 @deftypefun int mu_attribute_to_string (mu_attribute_t @var{attr}, char *@var{buf}, size_t @var{len}, size_t *@var{writen})
146 @end deftypefun 147 @end deftypefun
147 148
148 @deftypefun int string_to_flags (const char *@var{buf}, int *) 149 @deftypefun int string_to_flags (const char *@var{buf}, int *)
......
1 @c This is part of the GNU Mailutils manual. 1 @c This is part of the GNU Mailutils manual.
2 @c Copyright (C) 1999,2000,2001,2002,2003,2004 Free Software Foundation, Inc. 2 @c Copyright (C) 1999,2000,2001,2002,2003,2004,2006 Free Software Foundation, Inc.
3 @c See file mailutils.texi for copying conditions. 3 @c See file mailutils.texi for copying conditions.
4 @comment ******************************************************************* 4 @comment *******************************************************************
5 5
6 @smallexample 6 @smallexample
7 @code{/* Prefixes @emph{authority_}, @emph{ticket_}, and @emph{wicket_} are reserved. */} 7 @code{/* Prefixes @emph{mu_authority_}, @emph{mu_ticket_}, and @emph{mu_wicket_} are reserved. */}
8 @code{#include <mailutils/auth.h>} 8 @code{#include <mailutils/auth.h>}
9 9
10 @end smallexample 10 @end smallexample
11 11
12 There are many ways to authenticate to a server. To be flexible the 12 There are many ways to authenticate to a server. To be flexible the
13 authentication process is provided by three objects @code{authority_t}, 13 authentication process is provided by three objects @code{mu_authority_t},
14 @code{ticket_t}, and @code{wicket_t}. The @code{authority_t} can implement 14 @code{mu_ticket_t}, and @code{mu_wicket_t}. The @code{mu_authority_t} can implement
15 different protocol like APOP, MD5-AUTH, One Time Passwd, etc. By default 15 different protocol like APOP, MD5-AUTH, One Time Passwd, etc. By default
16 if a mailbox does not understand or know how to authenticate it falls back 16 if a mailbox does not understand or know how to authenticate it falls back
17 to user/passwd authentication. The @code{ticket_t} is a way for 17 to user/passwd authentication. The @code{mu_ticket_t} is a way for
18 Mailboxes and Mailers provide a way to authenticate when the URL does not 18 Mailboxes and Mailers provide a way to authenticate when the URL does not
19 contain enough information. The default action is to call the function 19 contain enough information. The default action is to call the function
20 @code{authority_authenticate()} which will get the @emph{user} and @emph{passwd} 20 @code{mu_authority_authenticate()} which will get the @emph{user} and @emph{passwd}
21 if not set, this function can be overridden by a custom method. 21 if not set, this function can be overridden by a custom method.
22 22
23 @c 23 @c
24 @c Ticket 24 @c Ticket
25 @c 25 @c
26 26
27 @deftypefun int ticket_create (ticket_t *, void *@var{owner}) 27 @deftypefun int mu_ticket_create (mu_ticket_t *, void *@var{owner})
28 @end deftypefun 28 @end deftypefun
29 29
30 @deftypefun void ticket_destroy (ticket_t *, void *@var{owner}) 30 @deftypefun void mu_ticket_destroy (mu_ticket_t *, void *@var{owner})
31 @end deftypefun 31 @end deftypefun
32 32
33 @deftypefun int ticket_set_destroy (ticket_t, void (*) (ticket_t), void *@var{owner}) 33 @deftypefun int mu_ticket_set_destroy (mu_ticket_t, void (*) (mu_ticket_t), void *@var{owner})
34 @end deftypefun 34 @end deftypefun
35 35
36 @deftypefun void* ticket_get_owner (ticket_t) 36 @deftypefun void* mu_ticket_get_owner (mu_ticket_t)
37 @end deftypefun 37 @end deftypefun
38 38
39 @deftypefun int ticket_set_pop (ticket_t, int (*@var{_pop}) (ticket_t, url_t, const char *, char **), void *) 39 @deftypefun int mu_ticket_set_pop (mu_ticket_t, int (*@var{_pop}) (mu_ticket_t, url_t, const char *, char **), void *)
40 @end deftypefun 40 @end deftypefun
41 41
42 @deftypefun int ticket_pop (ticket_t, url_t, const char *, char **) 42 @deftypefun int mu_ticket_pop (mu_ticket_t, url_t, const char *, char **)
43 @end deftypefun 43 @end deftypefun
44 44
45 @deftypefun int ticket_set_data (ticket_t, void *, void *@var{owner}) 45 @deftypefun int mu_ticket_set_data (mu_ticket_t, void *, void *@var{owner})
46 @end deftypefun 46 @end deftypefun
47 47
48 @deftypefun int ticket_get_data (ticket_t, void **) 48 @deftypefun int mu_ticket_get_data (mu_ticket_t, void **)
49 @end deftypefun 49 @end deftypefun
50 50
51 @c 51 @c
...@@ -54,28 +54,28 @@ if not set, this function can be overridden by a custom method. ...@@ -54,28 +54,28 @@ if not set, this function can be overridden by a custom method.
54 54
55 @sp 1 55 @sp 1
56 56
57 @deftypefun int authority_create (authority_t *, ticket_t, void *) 57 @deftypefun int mu_authority_create (mu_authority_t *, mu_ticket_t, void *)
58 @end deftypefun 58 @end deftypefun
59 59
60 @deftypefun void authority_destroy (authority_t *, void *) 60 @deftypefun void mu_authority_destroy (mu_authority_t *, void *)
61 @end deftypefun 61 @end deftypefun
62 62
63 @deftypefun void* authority_get_owner (authority_t) 63 @deftypefun void* mu_authority_get_owner (mu_authority_t)
64 @end deftypefun 64 @end deftypefun
65 65
66 @deftypefun int authority_set_ticket (authority_t, ticket_t) 66 @deftypefun int mu_authority_set_ticket (mu_authority_t, mu_ticket_t)
67 @end deftypefun 67 @end deftypefun
68 68
69 @deftypefun int authority_get_ticket (authority_t, ticket_t *) 69 @deftypefun int mu_authority_get_ticket (mu_authority_t, mu_ticket_t *)
70 @end deftypefun 70 @end deftypefun
71 71
72 @deftypefun int authority_authenticate (authority_t) 72 @deftypefun int mu_authority_authenticate (mu_authority_t)
73 @end deftypefun 73 @end deftypefun
74 74
75 @deftypefun int authority_set_authenticate (authority_t, int (*@var{_authenticate}) (authority_t), void *) 75 @deftypefun int mu_authority_set_authenticate (mu_authority_t, int (*@var{_authenticate}) (mu_authority_t), void *)
76 @end deftypefun 76 @end deftypefun
77 77
78 @deftypefun int authority_create_null (authority_t *@var{authority}, void *@var{owner}) 78 @deftypefun int mu_authority_create_null (mu_authority_t *@var{authority}, void *@var{owner})
79 @end deftypefun 79 @end deftypefun
80 80
81 @c 81 @c
...@@ -84,22 +84,22 @@ if not set, this function can be overridden by a custom method. ...@@ -84,22 +84,22 @@ if not set, this function can be overridden by a custom method.
84 84
85 @sp 1 85 @sp 1
86 86
87 @deftypefun int wicket_create (wicket_t *, const char *) 87 @deftypefun int mu_wicket_create (mu_wicket_t *, const char *)
88 @end deftypefun 88 @end deftypefun
89 89
90 @deftypefun void wicket_destroy (wicket_t *) 90 @deftypefun void mu_wicket_destroy (mu_wicket_t *)
91 @end deftypefun 91 @end deftypefun
92 92
93 @deftypefun int wicket_set_filename (wicket_t, const char *) 93 @deftypefun int mu_wicket_set_filename (mu_wicket_t, const char *)
94 @end deftypefun 94 @end deftypefun
95 95
96 @deftypefun int wicket_get_filename (wicket_t, char *, size_t, size_t *) 96 @deftypefun int mu_wicket_get_filename (mu_wicket_t, char *, size_t, size_t *)
97 @end deftypefun 97 @end deftypefun
98 98
99 @deftypefun int wicket_set_ticket (wicket_t, int (*) (wicket_t, const char *, const char *, ticket_t *)) 99 @deftypefun int mu_wicket_set_ticket (mu_wicket_t, int (*) (mu_wicket_t, const char *, const char *, mu_ticket_t *))
100 @end deftypefun 100 @end deftypefun
101 101
102 @deftypefun int wicket_get_ticket (wicket_t, ticket_t *, const char *, const char *) 102 @deftypefun int mu_wicket_get_ticket (mu_wicket_t, mu_ticket_t *, const char *, const char *)
103 @end deftypefun 103 @end deftypefun
104 104
105 @c 105 @c
......
1 @c This is part of the GNU Mailutils manual. 1 @c This is part of the GNU Mailutils manual.
2 @c Copyright (C) 1999,2000,2001,2002,2003,2004 Free Software Foundation, Inc. 2 @c Copyright (C) 1999,2000,2001,2002,2003,2004,2006 Free Software Foundation, Inc.
3 @c See file mailutils.texi for copying conditions. 3 @c See file mailutils.texi for copying conditions.
4 @comment ******************************************************************* 4 @comment *******************************************************************
5 5
6 @smallexample 6 @smallexample
7 @code{/* Prefix @emph{body_} is reserved. */} 7 @code{/* Prefix @emph{mu_body_} is reserved. */}
8 @code{#include <mailutils/body.h>} 8 @code{#include <mailutils/body.h>}
9 @end smallexample 9 @end smallexample
10 10
11 @deftypefun int body_create (body_t *@var{body}, void *@var{owner}) 11 @deftypefun int mu_body_create (mu_body_t *@var{body}, void *@var{owner})
12 Initialize an object @var{body}. 12 Initialize an object @var{body}.
13 @end deftypefun 13 @end deftypefun
14 14
15 @deftypefun void body_destroy (body_t *@var{body}) 15 @deftypefun void mu_body_destroy (mu_body_t *@var{body})
16 The resources allocated are release. 16 The resources allocated are release.
17 @end deftypefun 17 @end deftypefun
18 18
19 @deftypefun void* body_get_owner (body_t @var{body}) 19 @deftypefun void* mu_body_get_owner (mu_body_t @var{body})
20 @end deftypefun 20 @end deftypefun
21 21
22 @deftypefun int body_is_modified (body_t @var{body}) 22 @deftypefun int mu_body_is_modified (mu_body_t @var{body})
23 @end deftypefun 23 @end deftypefun
24 24
25 @deftypefun int body_clear_modified (body_t @var{body}) 25 @deftypefun int mu_body_clear_modified (mu_body_t @var{body})
26 @end deftypefun 26 @end deftypefun
27 27
28 @c 28 @c
29 @c ----------- 29 @c -----------
30 @c 30 @c
31 31
32 @deftypefun int body_get_stream (body_t @var{body}, stream_t *@var{stream}) 32 @deftypefun int mu_body_get_stream (mu_body_t @var{body}, stream_t *@var{stream})
33 @end deftypefun 33 @end deftypefun
34 34
35 @deftypefun int body_set_stream (body_t @var{body}, stream_t @var{stream}, void *@var{owner}) 35 @deftypefun int mu_body_set_stream (mu_body_t @var{body}, stream_t @var{stream}, void *@var{owner})
36 @end deftypefun 36 @end deftypefun
37 37
38 @deftypefun int body_get_filename (body_t @var{body}, char *@var{buffer}, size_t @var{buflen}, size_t *@var{writen}) 38 @deftypefun int mu_body_get_filename (mu_body_t @var{body}, char *@var{buffer}, size_t @var{buflen}, size_t *@var{writen})
39 @end deftypefun 39 @end deftypefun
40 40
41 @deftypefun int body_size (body_t @var{body}, size_t *@var{size}) 41 @deftypefun int mu_body_size (mu_body_t @var{body}, size_t *@var{size})
42 @end deftypefun 42 @end deftypefun
43 43
44 @deftypefun int body_set_size (body_t @var{body}, int (*@var{_size}) (body_t, size_t *), void *@var{owner}) 44 @deftypefun int mu_body_set_size (mu_body_t @var{body}, int (*@var{_size}) (mu_body_t, size_t *), void *@var{owner})
45 @end deftypefun 45 @end deftypefun
46 46
47 @deftypefun int body_lines (body_t @var{body}, size_t *@var{lines}) 47 @deftypefun int mu_body_lines (mu_body_t @var{body}, size_t *@var{lines})
48 @end deftypefun 48 @end deftypefun
49 49
50 @deftypefun int body_set_lines (body_t @var{body}, int (*@var{_lines}) (body_t, size_t *), void *@var{owner}) 50 @deftypefun int mu_body_set_lines (mu_body_t @var{body}, int (*@var{_lines}) (mu_body_t, size_t *), void *@var{owner})
51 @end deftypefun 51 @end deftypefun
......
1 @c This is part of the GNU Mailutils manual. 1 @c This is part of the GNU Mailutils manual.
2 @c Copyright (C) 1999,2000,2001,2002,2003,2004 Free Software Foundation, Inc. 2 @c Copyright (C) 1999,2000,2001,2002,2003,2004,2006 Free Software Foundation, Inc.
3 @c See file mailutils.texi for copying conditions. 3 @c See file mailutils.texi for copying conditions.
4 @comment ******************************************************************* 4 @comment *******************************************************************
5 5
6 @smallexample 6 @smallexample
7 @code{/* Prefix @emph{envelope_} is reserved. */} 7 @code{/* Prefix @emph{mu_envelope_} is reserved. */}
8 @code{#include <mailutils/envelope.h>} 8 @code{#include <mailutils/envelope.h>}
9 @end smallexample 9 @end smallexample
10 10
11 @deftypefun int envelope_create (envelope_t *, void *) 11 @deftypefun int mu_envelope_create (mu_envelope_t *, void *)
12 Primarily for internal use. 12 Primarily for internal use.
13 @end deftypefun 13 @end deftypefun
14 14
15 @deftypefun void envelope_destroy (envelope_t *, void *) 15 @deftypefun void mu_envelope_destroy (mu_envelope_t *, void *)
16 Primarily for internal use. 16 Primarily for internal use.
17 @end deftypefun 17 @end deftypefun
18 18
19 @deftypefun void* envelope_get_owner (envelope_t) 19 @deftypefun void* mu_envelope_get_owner (mu_envelope_t)
20 @end deftypefun 20 @end deftypefun
21 21
22 @c 22 @c
23 @c ---------- 23 @c ----------
24 @c 24 @c
25 25
26 @deftypefun int envelope_sender (envelope_t, char *, size_t, size_t *) 26 @deftypefun int mu_envelope_sender (mu_envelope_t, char *, size_t, size_t *)
27 Get the address that this message was reportedly received from. This 27 Get the address that this message was reportedly received from. This
28 would be the "mail from" argument if the message was delivered 28 would be the "mail from" argument if the message was delivered
29 or received via SMTP, for example. 29 or received via SMTP, for example.
30 @end deftypefun 30 @end deftypefun
31 31
32 @deftypefun int envelope_set_sender (envelope_t, int (*@var{_sender}) (envelope_t, char *, size_t, size_t *), void *) 32 @deftypefun int mu_envelope_set_sender (mu_envelope_t, int (*@var{_sender}) (mu_envelope_t, char *, size_t, size_t *), void *)
33 Primarily for internal use. The implementation of @code{envelope_t} depends 33 Primarily for internal use. The implementation of @code{mu_envelope_t} depends
34 on the mailbox type, this allows the function which actually gets 34 on the mailbox type, this allows the function which actually gets
35 the sender to be set by the creator of an @code{envelope_t}. 35 the sender to be set by the creator of an @code{mu_envelope_t}.
36 @end deftypefun 36 @end deftypefun
37 37
38 @deftypefun int envelope_date (envelope_t, char *, size_t, size_t *) 38 @deftypefun int mu_envelope_date (mu_envelope_t, char *, size_t, size_t *)
39 Get the date that the message was delivered to the mailbox, in 39 Get the date that the message was delivered to the mailbox, in
40 something close to ANSI @code{ctime()} format: Mon Jul 05 13:08:27 1999. 40 something close to ANSI @code{ctime()} format: Mon Jul 05 13:08:27 1999.
41 @end deftypefun 41 @end deftypefun
42 42
43 @deftypefun int envelope_set_date (envelope_t, int (*@var{_date}) (envelope_t, char *, size_t, size_t *), void *) 43 @deftypefun int mu_envelope_set_date (mu_envelope_t, int (*@var{_date}) (mu_envelope_t, char *, size_t, size_t *), void *)
44 Primarily for internal use. The implementation of @code{envelope_t} depends 44 Primarily for internal use. The implementation of @code{mu_envelope_t} depends
45 on the mailbox type, this allows the function which actually gets 45 on the mailbox type, this allows the function which actually gets
46 the date to be set by the creator of an @code{envelope_t}. 46 the date to be set by the creator of an @code{mu_envelope_t}.
47 @end deftypefun 47 @end deftypefun
......
1 @c This is part of the GNU Mailutils manual. 1 @c This is part of the GNU Mailutils manual.
2 @c Copyright (C) 1999,2000,2001,2002,2003,2004 Free Software Foundation, Inc. 2 @c Copyright (C) 1999,2000,2001,2002,2003,2004,2006 Free Software Foundation, Inc.
3 @c See file mailutils.texi for copying conditions. 3 @c See file mailutils.texi for copying conditions.
4 @comment ******************************************************************* 4 @comment *******************************************************************
5 5
6 @smallexample 6 @smallexample
7 @code{/* Prefix @emph{folder_} is reserved. */} 7 @code{/* Prefix @emph{mu_folder_} is reserved. */}
8 @code{#include <mailutils/folder.h>} 8 @code{#include <mailutils/folder.h>}
9 9
10 @end smallexample 10 @end smallexample
11 11
12 @smallexample 12 @smallexample
13 @group 13 @group
14 folder_t url_t 14 mu_folder_t mu_url_t
15 -/var/mail- +---//--->/-----------------\ +-->/-----------\ 15 -/var/mail- +---//--->/-------------------\ +-->/-----------\
16 ( alain *-)-+ | | url_t *-|---+ | port | 16 ( alain *-)-+ | | mu_url_t *-|---+ | port |
17 ---------- | | |-----------------+ | hostname | 17 ---------- | | |-------------------+ | hostname |
18 ( jakob *-)-+--+ | observer_t *-| | file | 18 ( jakob *-)-+--+ | mu_observer_t *-| | file |
19 ---------- | |-----------------+ | ... | 19 ---------- | |-------------------+ | ... |
20 ( jeff *-)-+ | stream_t | \-----------/ 20 ( jeff *-)-+ | mu_stream_t | \-----------/
21 ---------- | |-----------------| 21 ---------- | |-------------------|
22 ( sean *-)-+ | auth_t | 22 ( sean *-)-+ | mu_auth_t |
23 ---------- |-----------------| 23 ---------- |-------------------|
24 | mailbox_t(1) | 24 | mu_mailbox_t(1) |
25 |-----------------| 25 |-------------------|
26 | mailbox_t(2) | 26 | mu_mailbox_t(2) |
27 | ...... | 27 | ...... |
28 | mailbox_t(n) | 28 | mu_mailbox_t(n) |
29 \-----------------/ 29 \-----------------/
30 @end group 30 @end group
31 @end smallexample 31 @end smallexample
...@@ -34,18 +34,13 @@ Data structures: ...@@ -34,18 +34,13 @@ Data structures:
34 34
35 @smallexample 35 @smallexample
36 @group 36 @group
37 struct list_response 37 struct mu_list_response
38 @{ 38 @{
39 int type; 39 int type;
40 int separator; 40 int separator;
41 char *name; 41 char *name;
42 @}; 42 @};
43 43
44 struct folder_list
45 @{
46 struct list_response **element;
47 size_t num;
48 @};
49 @end group 44 @end group
50 @end smallexample 45 @end smallexample
51 46
...@@ -53,85 +48,82 @@ struct folder_list ...@@ -53,85 +48,82 @@ struct folder_list
53 @c Constructor/Destructor and possible types. 48 @c Constructor/Destructor and possible types.
54 @c 49 @c
55 50
56 @deftypefun int folder_create (folder_t *, const char *@var{url}) 51 @deftypefun int mu_folder_create (mu_folder_t *, const char *@var{url})
57 @end deftypefun
58
59 @deftypefun void folder_destroy (folder_t *)
60 @end deftypefun 52 @end deftypefun
61 53
62 @deftypefun int folder_open (folder_t, int @var{flag}) 54 @deftypefun void mu_folder_destroy (mu_folder_t *)
63 @end deftypefun 55 @end deftypefun
64 56
65 @deftypefun int folder_close (folder_t) 57 @deftypefun int mu_folder_open (mu_folder_t, int @var{flag})
66 @end deftypefun 58 @end deftypefun
67 59
68 @deftypefun int folder_delete (folder_t, const char *@var{mailbox}) 60 @deftypefun int mu_folder_close (mu_folder_t)
69 @end deftypefun 61 @end deftypefun
70 62
71 @deftypefun int folder_rename (folder_t, const char *, const char *@var{mailbox}) 63 @deftypefun int mu_folder_delete (mu_folder_t, const char *@var{mailbox})
72 @end deftypefun 64 @end deftypefun
73 65
74 @deftypefun int folder_subscribe (folder_t, const char *@var{mailbox}) 66 @deftypefun int mu_folder_rename (mu_folder_t, const char *, const char *@var{mailbox})
75 @end deftypefun 67 @end deftypefun
76 68
77 @deftypefun int folder_unsubscribe (folder_t, const char *@var{mailbox}) 69 @deftypefun int mu_folder_subscribe (mu_folder_t, const char *@var{mailbox})
78 @end deftypefun 70 @end deftypefun
79 71
80 @deftypefun int folder_list (folder_t, const char *@var{ref}, const char *@var{wcard}, struct folder_list *) 72 @deftypefun int mu_folder_unsubscribe (mu_folder_t, const char *@var{mailbox})
81 @end deftypefun 73 @end deftypefun
82 74
83 @deftypefun int folder_lsub (folder_t, const char *@var{ref}, const char *@var{wcard}, struct folder_list *) 75 @deftypefun int mu_folder_list (mu_folder_t, const char *@var{ref}, const char *@var{wcard}, size_t @var{size}, mu_list_t *@var{list})
84 @end deftypefun 76 @end deftypefun
85 77
86 @deftypefun int folder_list_destroy (struct folder_list *) 78 @deftypefun int mu_folder_lsub (mu_folder_t, const char *@var{ref}, const char *@var{wcard}, mu_list_t *@var{list})
87 @end deftypefun 79 @end deftypefun
88 80
89 @c 81 @c
90 @c Stream Settings. 82 @c Stream Settings.
91 @c 83 @c
92 84
93 @deftypefun int folder_get_stream (folder_t, stream_t *) 85 @deftypefun int mu_folder_get_stream (mu_folder_t, mu_stream_t *)
94 @end deftypefun 86 @end deftypefun
95 87
96 @deftypefun int folder_set_stream (folder_t, stream_t) 88 @deftypefun int mu_folder_set_stream (mu_folder_t, mu_stream_t)
97 @end deftypefun 89 @end deftypefun
98 90
99 @c 91 @c
100 @c Notifications. 92 @c Notifications.
101 @c 93 @c
102 94
103 @deftypefun int folder_get_observable (folder_t, observable_t *) 95 @deftypefun int mu_folder_get_observable (mu_folder_t, mu_observable_t *)
104 @end deftypefun 96 @end deftypefun
105 97
106 @c 98 @c
107 @c Debug. 99 @c Debug.
108 @c 100 @c
109 101
110 @deftypefun int folder_has_debug (folder_t) 102 @deftypefun int mu_folder_has_debug (mu_folder_t)
111 @end deftypefun 103 @end deftypefun
112 104
113 @deftypefun int folder_get_debug (folder_t, mu_debug_t *) 105 @deftypefun int mu_folder_get_debug (mu_folder_t, mu_debug_t *)
114 @end deftypefun 106 @end deftypefun
115 107
116 @deftypefun int folder_set_debug (folder_t, mu_debug_t) 108 @deftypefun int mu_folder_set_debug (mu_folder_t, mu_debug_t)
117 @end deftypefun 109 @end deftypefun
118 110
119 @c 111 @c
120 @c Authentication. 112 @c Authentication.
121 @c 113 @c
122 114
123 @deftypefun int folder_get_authority (folder_t, authority_t *) 115 @deftypefun int mu_folder_get_authority (mu_folder_t, mu_authority_t *)
124 @end deftypefun 116 @end deftypefun
125 117
126 @deftypefun int folder_set_authority (folder_t, authority_t) 118 @deftypefun int mu_folder_set_authority (mu_folder_t, mu_authority_t)
127 @end deftypefun 119 @end deftypefun
128 120
129 @c 121 @c
130 @c URL. 122 @c URL.
131 @c 123 @c
132 124
133 @deftypefun int folder_get_url (folder_t, url_t *) 125 @deftypefun int mu_folder_get_url (mu_folder_t, mu_url_t *)
134 @end deftypefun 126 @end deftypefun
135 127
136 @deftypefun int folder_set_url (folder_t, url_t) 128 @deftypefun int mu_folder_set_url (mu_folder_t, mu_url_t)
137 @end deftypefun 129 @end deftypefun
......
1 @c This is part of the GNU Mailutils manual. 1 @c This is part of the GNU Mailutils manual.
2 @c Copyright (C) 1999,2000,2001,2002,2003,2004 Free Software Foundation, Inc. 2 @c Copyright (C) 1999,2000,2001,2002,2003,2004,2006 Free Software Foundation, Inc.
3 @c See file mailutils.texi for copying conditions. 3 @c See file mailutils.texi for copying conditions.
4 @comment ******************************************************************* 4 @comment *******************************************************************
5 5
...@@ -33,39 +33,39 @@ etc ..). ...@@ -33,39 +33,39 @@ etc ..).
33 33
34 @smallexample 34 @smallexample
35 @group 35 @group
36 folder_t url_t 36 mu_folder_t mu_url_t
37 -/var/mail- +- .. ->+-----------------+ +-->+------------+ 37 -/var/mail- +- .. ->+-------------------+ +-->+------------+
38 ( alain *-)-+ | | url_t *-|---+ | port | 38 ( alain *-)-+ | | mu_url_t *-|---+ | port |
39 ---------- | | |-----------------| | hostname | 39 ---------- | | |-------------------| | hostname |
40 ( jakob *-)-+--+ | auth_t *-|---+ | file | 40 ( jakob *-)-+--+ | mu_auth_t *-|---+ | file |
41 ---------- | |-----------------| | | ... | 41 ---------- | |-------------------| | | ... |
42 ( jeff *-)-+ | stream_t | | +------------+ 42 ( jeff *-)-+ | mu_stream_t | | +------------+
43 ---------- | |-----------------| | 43 ---------- | |-------------------| |
44 ( shaleh*-)-+ | ..... | | auth_t 44 ( shaleh*-)-+ | ..... | | mu_auth_t
45 ---------- |-----------------| +-->+------------+ 45 ---------- |-------------------| +-->+-------------+
46 +---|-* mailbox_t[] | | ticket_t | 46 +---|-* mu_mailbox_t[] | | mu_ticket_t |
47 mailbox_t | +-----------------+ +------------+ 47 mu_mailbox_t | +-------------------+ +-------------+
48 +----------------+<-+ 48 +-------------------+
49 | locker_t *--|-------------+ 49 | mu_locker_t *--|-------------+
50 |----------------| | 50 |-------------------| |
51 | url_t | | locker_t 51 | mu_url_t | | mu_locker_t
52 |----------------| +-------->+---------+ 52 |-------------------| +-------->+---------+
53 | stream_t | | lock | 53 | mu_stream_t | | lock |
54 |----------------| | unlock | 54 |-------------------| | unlock |
55 | message_t[] *-|-------+ +---------+ 55 | mu_message_t[] *-|-------+ +---------+
56 +----------------+ | envelope_t 56 +-------------------+ | mu_envelope_t
57 | +-------->+-----------+ 57 | +-------->+-----------+
58 message_t | | | date | 58 mu_message_t | | | date |
59 +----------------+<------+ | | from | 59 +-------------------+<------+ | | from |
60 | envelope_t *-|------------------+ | to | 60 | mu_envelope_t *-|------------------+ | to |
61 |----------------| header_t +-----------+ 61 |-------------------| mu_header_t +-----------+
62 | header_t *-|------------>+--------------+ 62 | mu_header_t *-|------------>+-----------------+
63 |----------------| | stream_t | 63 |-------------------| | mu_stream_t |
64 | body_t *-|----+ +--------------+ 64 | mu_body_t *-|----+ +-----------------+
65 +----------------+ | body_t 65 +-------------------+ | mu_body_t
66 +-->+--------------+ 66 +-->+-----------------+
67 | stream_t | 67 | mu_stream_t |
68 +--------------+ 68 +-----------------+
69 @end group 69 @end group
70 @end smallexample 70 @end smallexample
71 71
......
1 @c This is part of the GNU Mailutils manual. 1 @c This is part of the GNU Mailutils manual.
2 @c Copyright (C) 1999,2000,2001,2002,2003,2004 Free Software Foundation, Inc. 2 @c Copyright (C) 1999,2000,2001,2002,2003,2004,2006 Free Software Foundation, Inc.
3 @c See file mailutils.texi for copying conditions. 3 @c See file mailutils.texi for copying conditions.
4 @comment ******************************************************************* 4 @comment *******************************************************************
5 5
6 @smallexample 6 @smallexample
7 @code{/* Prefix @emph{header_} is reserved. */} 7 @code{/* Prefix @emph{mu_header_} is reserved. */}
8 @code{#include <mailutils/header.h>} 8 @code{#include <mailutils/header.h>}
9 9
10 @end smallexample 10 @end smallexample
...@@ -12,29 +12,29 @@ ...@@ -12,29 +12,29 @@
12 So far we plan support for RFC822 and plan for RFC1522. With RFC1522 non-ASCII 12 So far we plan support for RFC822 and plan for RFC1522. With RFC1522 non-ASCII
13 characters will be encoded. 13 characters will be encoded.
14 14
15 @deftypefun int header_create (header_t *@var{hdr}, const char *@var{blurb}, size_t @var{len}, void *@var{owner}) 15 @deftypefun int mu_header_create (mu_header_t *@var{hdr}, const char *@var{blurb}, size_t @var{len}, void *@var{owner})
16 Initialize a @var{hdr} to a supported type. If @var{blurb} is not @code{NULL}, 16 Initialize a @var{hdr} to a supported type. If @var{blurb} is not @code{NULL},
17 it is parsed. 17 it is parsed.
18 @end deftypefun 18 @end deftypefun
19 19
20 @deftypefun void header_destroy (header_t *@var{hdr}, void *@var{owner}) 20 @deftypefun void mu_header_destroy (mu_header_t *@var{hdr}, void *@var{owner})
21 The resources allocated for @var{hdr} are freed. 21 The resources allocated for @var{hdr} are freed.
22 @end deftypefun 22 @end deftypefun
23 23
24 @deftypefun void* header_get_owner (header_t *@var{hdr}) 24 @deftypefun void* mu_header_get_owner (mu_header_t *@var{hdr})
25 @end deftypefun 25 @end deftypefun
26 26
27 @deftypefun int header_is_modified (header_t @var{hdr}) 27 @deftypefun int mu_header_is_modified (mu_header_t @var{hdr})
28 @end deftypefun 28 @end deftypefun
29 29
30 @deftypefun int header_clear_modified (header_t @var{hdr}) 30 @deftypefun int mu_header_clear_modified (mu_header_t @var{hdr})
31 @end deftypefun 31 @end deftypefun
32 32
33 @c 33 @c
34 @c Set and get field values by field name. 34 @c Set and get field values by field name.
35 @c 35 @c
36 36
37 @deftypefun int header_set_value (header_t @var{hdr}, const char *@var{fn}, const char *@var{fv}, int @var{n}) 37 @deftypefun int mu_header_set_value (mu_header_t @var{hdr}, const char *@var{fn}, const char *@var{fv}, int @var{n})
38 38
39 Some basic macros are already provided for RFC822. 39 Some basic macros are already provided for RFC822.
40 40
...@@ -128,12 +128,12 @@ Envelope-to ...@@ -128,12 +128,12 @@ Envelope-to
128 @end table 128 @end table
129 @end deftypefun 129 @end deftypefun
130 130
131 @deftypefun int header_get_value (header_t @var{hdr}, const char *@var{fn}, char *@var{fv}, size_t @var{len}, size_t *@var{n}) 131 @deftypefun int mu_header_get_value (mu_header_t @var{hdr}, const char *@var{fn}, char *@var{fv}, size_t @var{len}, size_t *@var{n})
132 Value of field-name @var{fn} is returned in buffer @var{fv} of size @var{len}. 132 Value of field-name @var{fn} is returned in buffer @var{fv} of size @var{len}.
133 The number of bytes written is put in @var{n}. 133 The number of bytes written is put in @var{n}.
134 @end deftypefun 134 @end deftypefun
135 135
136 @deftypefun int header_aget_value (header_t @var{hdr}, const char *@var{fn}, char **@var{fv}) 136 @deftypefun int mu_header_aget_value (mu_header_t @var{hdr}, const char *@var{fn}, char **@var{fv})
137 The value is allocated. 137 The value is allocated.
138 @end deftypefun 138 @end deftypefun
139 139
...@@ -141,70 +141,70 @@ The value is allocated. ...@@ -141,70 +141,70 @@ The value is allocated.
141 @c Get field values as an address_t. 141 @c Get field values as an address_t.
142 @c 142 @c
143 143
144 @deftypefun int header_get_address (header_t @var{hdr}, const char *@var{buf}, address_t *@var{addr}) 144 @deftypefun int mu_header_get_address (mu_header_t @var{hdr}, const char *@var{buf}, address_t *@var{addr})
145 @end deftypefun 145 @end deftypefun
146 146
147 @c 147 @c
148 @c Stream 148 @c Stream
149 @c 149 @c
150 150
151 @deftypefun int header_get_stream (header_t @var{hdr}, stream_t *@var{stream}) 151 @deftypefun int mu_header_get_stream (mu_header_t @var{hdr}, stream_t *@var{stream})
152 @end deftypefun 152 @end deftypefun
153 153
154 @deftypefun int header_set_stream (header_t @var{hdr}, stream_t @var{stream}, void *) 154 @deftypefun int mu_header_set_stream (mu_header_t @var{hdr}, stream_t @var{stream}, void *)
155 @end deftypefun 155 @end deftypefun
156 156
157 @c 157 @c
158 @c 158 @c
159 @c 159 @c
160 160
161 @deftypefun int header_get_field_count (header_t @var{hdr}, size_t *@var{count}) 161 @deftypefun int mu_header_get_field_count (mu_header_t @var{hdr}, size_t *@var{count})
162 @end deftypefun 162 @end deftypefun
163 163
164 @deftypefun int header_get_field_value (header_t @var{hdr}, size_t @var{index}, char *, size_t, size_t *) 164 @deftypefun int mu_header_get_field_value (mu_header_t @var{hdr}, size_t @var{index}, char *, size_t, size_t *)
165 @end deftypefun 165 @end deftypefun
166 166
167 @deftypefun int header_get_field_name (header_t @var{hdr}, size_t @var{index}, char *, size_t, size_t *) 167 @deftypefun int mu_header_get_field_name (mu_header_t @var{hdr}, size_t @var{index}, char *, size_t, size_t *)
168 @end deftypefun 168 @end deftypefun
169 169
170 @deftypefun int header_aget_field_value (header_t @var{hdr}, size_t @var{index}, char **) 170 @deftypefun int mu_header_aget_field_value (mu_header_t @var{hdr}, size_t @var{index}, char **)
171 @end deftypefun 171 @end deftypefun
172 172
173 @deftypefun int header_aget_field_name (header_t @var{hdr}, size_t @var{index}, char **) 173 @deftypefun int mu_header_aget_field_name (mu_header_t @var{hdr}, size_t @var{index}, char **)
174 @end deftypefun 174 @end deftypefun
175 175
176 @deftypefun int header_get_value_unfold (header_t @var{hdr}, const char *@var{name}, char *@var{buffer}, size_t @var{buflen}, size_t *@var{n}) 176 @deftypefun int mu_header_get_value_unfold (mu_header_t @var{hdr}, const char *@var{name}, char *@var{buffer}, size_t @var{buflen}, size_t *@var{n})
177 @end deftypefun 177 @end deftypefun
178 178
179 @deftypefun int header_aget_value_unfold (header_t @var{hdr}, const char *@var{name}, char **@var{value}) 179 @deftypefun int mu_header_aget_value_unfold (mu_header_t @var{hdr}, const char *@var{name}, char **@var{value})
180 @end deftypefun 180 @end deftypefun
181 181
182 @deftypefun int header_get_field_value_unfold (header_t @var{hdr}, size_t @var{num}, char *@var{buf}, size_t @var{buflen}, size_t *@var{nwritten}) 182 @deftypefun int mu_header_get_field_value_unfold (mu_header_t @var{hdr}, size_t @var{num}, char *@var{buf}, size_t @var{buflen}, size_t *@var{nwritten})
183 @end deftypefun 183 @end deftypefun
184 184
185 @deftypefun int header_aget_field_value_unfold (header_t @var{hdr}, size_t @var{num}, char **@var{value}); 185 @deftypefun int mu_header_aget_field_value_unfold (mu_header_t @var{hdr}, size_t @var{num}, char **@var{value});
186 @end deftypefun 186 @end deftypefun
187 187
188 @deftypefun int header_size (header_t @var{hdr}, size_t *); 188 @deftypefun int mu_header_size (mu_header_t @var{hdr}, size_t *);
189 @end deftypefun 189 @end deftypefun
190 190
191 @deftypefun int header_lines (header_t @var{hdr}, size_t *); 191 @deftypefun int mu_header_lines (mu_header_t @var{hdr}, size_t *);
192 @end deftypefun 192 @end deftypefun
193 193
194 @deftypefun int header_set_set_value (header_t @var{hdr}, int (*@var{_set_value}) (header_t, const char *, const char *, int), void *); 194 @deftypefun int mu_header_set_set_value (mu_header_t @var{hdr}, int (*@var{_set_value}) (mu_header_t, const char *, const char *, int), void *);
195 @end deftypefun 195 @end deftypefun
196 196
197 @deftypefun int header_set_get_value (header_t @var{hdr}, int (*@var{_get_value}) (header_t, const char *, char *, size_t, size_t *), void *); 197 @deftypefun int mu_header_set_get_value (mu_header_t @var{hdr}, int (*@var{_get_value}) (mu_header_t, const char *, char *, size_t, size_t *), void *);
198 @end deftypefun 198 @end deftypefun
199 199
200 @deftypefun int header_set_get_fvalue (header_t @var{hdr}, int (*@var{_get_value}) (header_t, const char *, char *, size_t, size_t *), void *); 200 @deftypefun int mu_header_set_get_fvalue (mu_header_t @var{hdr}, int (*@var{_get_value}) (mu_header_t, const char *, char *, size_t, size_t *), void *);
201 @end deftypefun 201 @end deftypefun
202 202
203 @deftypefun int header_set_size (header_t @var{hdr}, int (*@var{_size}) (header_t, size_t *), void *); 203 @deftypefun int mu_header_set_size (mu_header_t @var{hdr}, int (*@var{_size}) (mu_header_t, size_t *), void *);
204 @end deftypefun 204 @end deftypefun
205 205
206 @deftypefun int header_set_lines (header_t @var{hdr}, int (*@var{_lines}) (header_t, size_t *), void *); 206 @deftypefun int mu_header_set_lines (mu_header_t @var{hdr}, int (*@var{_lines}) (mu_header_t, size_t *), void *);
207 @end deftypefun 207 @end deftypefun
208 208
209 @deftypefun int header_set_fill (header_t @var{hdr}, int (*@var{_fill}) (header_t, char *, size_t, off_t, size_t *), void *@var{owner}); 209 @deftypefun int mu_header_set_fill (mu_header_t @var{hdr}, int (*@var{_fill}) (mu_header_t, char *, size_t, mu_off_t, size_t *), void *@var{owner});
210 @end deftypefun 210 @end deftypefun
......
1 @c This is part of the GNU Mailutils manual. 1 @c This is part of the GNU Mailutils manual.
2 @c Copyright (C) 1999,2000,2001,2002,2003,2004 Free Software Foundation, Inc. 2 @c Copyright (C) 1999,2000,2001,2002,2003,2004,2006
3 @c Free Software Foundation, Inc.
3 @c See file mailutils.texi for copying conditions. 4 @c See file mailutils.texi for copying conditions.
4 @comment ******************************************************************* 5 @comment *******************************************************************
5 6
6 @smallexample 7 @smallexample
7 @code{/* Prefix @emph{imap4_} is reserved */} 8 @code{/* Prefix @emph{mu_imap4_} is reserved */}
8 @code{#include <mailutils/imap4.h>} 9 @code{#include <mailutils/imap4.h>}
9 10
10 @end smallexample 11 @end smallexample
...@@ -20,155 +21,155 @@ request. Untagged responses, for historical reasons are also call ...@@ -20,155 +21,155 @@ request. Untagged responses, for historical reasons are also call
20 @subsubsection Initialization 21 @subsubsection Initialization
21 @cindex IMAP4 Initialization 22 @cindex IMAP4 Initialization
22 23
23 @deftypefun int imap4_create (imap4_t *) 24 @deftypefun int mu_imap4_create (mu_imap4_t *)
24 @end deftypefun 25 @end deftypefun
25 26
26 @deftypefun int imap4_open (imap4_t, const char *@var{hostname}, unsigned int @var{port}, int @var{flags}) 27 @deftypefun int mu_imap4_open (mu_imap4_t, const char *@var{hostname}, unsigned int @var{port}, int @var{flags})
27 @end deftypefun 28 @end deftypefun
28 29
29 @deftypefun int imap4d_set_timeout (imap4_t, unsigned int @var{seconds}) 30 @deftypefun int imap4d_set_timeout (mu_imap4_t, unsigned int @var{seconds})
30 @end deftypefun 31 @end deftypefun
31 32
32 @subsubsection Append 33 @subsubsection Append
33 @cindex IMAP4 Append 34 @cindex IMAP4 Append
34 35
35 @deftypefun int imap4_append (imap4_t) 36 @deftypefun int mu_imap4_append (mu_imap4_t)
36 @end deftypefun 37 @end deftypefun
37 38
38 @subsubsection Capability 39 @subsubsection Capability
39 @cindex IMAP4 Capability 40 @cindex IMAP4 Capability
40 41
41 @deftypefun int imap4_capability (imap4_t) 42 @deftypefun int mu_imap4_capability (mu_imap4_t)
42 @end deftypefun 43 @end deftypefun
43 44
44 @subsubsection Create 45 @subsubsection Create
45 @cindex IMAP4 Create 46 @cindex IMAP4 Create
46 47
47 @deftypefun int imap4_create_mailbox (imap4_t, const char *@var{mbox}) 48 @deftypefun int mu_imap4_create_mailbox (mu_imap4_t, const char *@var{mbox})
48 @end deftypefun 49 @end deftypefun
49 50
50 @subsubsection Check 51 @subsubsection Check
51 @cindex IMAP4 Check 52 @cindex IMAP4 Check
52 53
53 @deftypefun int imap4_check (imap4_t) 54 @deftypefun int mu_imap4_check (mu_imap4_t)
54 @end deftypefun 55 @end deftypefun
55 56
56 @subsubsection Close 57 @subsubsection Close
57 @cindex IMAP4 Close 58 @cindex IMAP4 Close
58 59
59 @deftypefun int imap4_close (imap4_t) 60 @deftypefun int mu_imap4_close (mu_imap4_t)
60 @end deftypefun 61 @end deftypefun
61 62
62 @subsubsection Copy 63 @subsubsection Copy
63 @cindex IMAP4 Copy 64 @cindex IMAP4 Copy
64 65
65 @deftypefun int imap4_copy (imap4_t) 66 @deftypefun int mu_imap4_copy (mu_imap4_t)
66 @end deftypefun 67 @end deftypefun
67 68
68 @subsubsection UID Copy 69 @subsubsection UID Copy
69 @cindex IMAP4 UID Copy 70 @cindex IMAP4 UID Copy
70 71
71 @deftypefun int imap4_uid_copy (imap4_t) 72 @deftypefun int mu_imap4_uid_copy (mu_imap4_t)
72 @end deftypefun 73 @end deftypefun
73 74
74 @subsubsection Delete 75 @subsubsection Delete
75 @cindex IMAP4 Delete 76 @cindex IMAP4 Delete
76 77
77 @deftypefun int imap4_delete (imap4_t) 78 @deftypefun int mu_imap4_delete (mu_imap4_t)
78 @end deftypefun 79 @end deftypefun
79 80
80 @subsubsection Fetch 81 @subsubsection Fetch
81 @cindex IMAP4 Fetch 82 @cindex IMAP4 Fetch
82 83
83 @deftypefun int imap4_fetch (imap4_t) 84 @deftypefun int mu_imap4_fetch (mu_imap4_t)
84 @end deftypefun 85 @end deftypefun
85 86
86 @subsubsection UID Fetch 87 @subsubsection UID Fetch
87 @cindex IMAP4 UID Fetch 88 @cindex IMAP4 UID Fetch
88 89
89 @deftypefun int imap4_uid_fetch (imap4_t) 90 @deftypefun int mu_imap4_uid_fetch (mu_imap4_t)
90 @end deftypefun 91 @end deftypefun
91 92
92 @subsubsection Examine 93 @subsubsection Examine
93 @cindex IMAP4 Examine 94 @cindex IMAP4 Examine
94 95
95 @deftypefun int imap4_examine (imap4_t) 96 @deftypefun int mu_imap4_examine (mu_imap4_t)
96 @end deftypefun 97 @end deftypefun
97 98
98 @subsubsection Expunge 99 @subsubsection Expunge
99 @cindex IMAP4 Expunge 100 @cindex IMAP4 Expunge
100 101
101 @deftypefun int imap4_expunge (imap4_t) 102 @deftypefun int mu_imap4_expunge (mu_imap4_t)
102 @end deftypefun 103 @end deftypefun
103 104
104 @subsubsection List 105 @subsubsection List
105 @cindex IMAP4 List 106 @cindex IMAP4 List
106 107
107 @deftypefun int imap4_list (imap4_t) 108 @deftypefun int mu_imap4_list (mu_imap4_t)
108 @end deftypefun 109 @end deftypefun
109 110
110 @subsubsection Lsub 111 @subsubsection Lsub
111 @cindex IMAP4 Lsub 112 @cindex IMAP4 Lsub
112 113
113 @deftypefun int imap4_lsub (imap4_t) 114 @deftypefun int mu_imap4_lsub (mu_imap4_t)
114 @end deftypefun 115 @end deftypefun
115 116
116 @subsubsection Namespace 117 @subsubsection Namespace
117 @cindex IMAP4 Namespace 118 @cindex IMAP4 Namespace
118 119
119 @deftypefun int imap4_namespace (imap4_t) 120 @deftypefun int mu_imap4_namespace (mu_imap4_t)
120 @end deftypefun 121 @end deftypefun
121 122
122 @subsubsection Rename 123 @subsubsection Rename
123 @cindex IMAP4 Rename 124 @cindex IMAP4 Rename
124 125
125 @deftypefun int imap4_rename (imap4_t) 126 @deftypefun int mu_imap4_rename (mu_imap4_t)
126 @end deftypefun 127 @end deftypefun
127 128
128 @subsubsection Search 129 @subsubsection Search
129 @cindex IMAP4 Search 130 @cindex IMAP4 Search
130 131
131 @deftypefun int imap4_search (imap4_t) 132 @deftypefun int mu_imap4_search (mu_imap4_t)
132 @end deftypefun 133 @end deftypefun
133 134
134 @subsubsection UID Search 135 @subsubsection UID Search
135 @cindex IMAP4 UID Search 136 @cindex IMAP4 UID Search
136 137
137 @deftypefun int imap4_uid_search (imap4_t) 138 @deftypefun int mu_imap4_uid_search (mu_imap4_t)
138 @end deftypefun 139 @end deftypefun
139 140
140 @subsubsection Select 141 @subsubsection Select
141 @cindex IMAP4 Select 142 @cindex IMAP4 Select
142 143
143 @deftypefun int imap4_select (imap4_t) 144 @deftypefun int mu_imap4_select (mu_imap4_t)
144 @end deftypefun 145 @end deftypefun
145 146
146 @subsubsection Status 147 @subsubsection Status
147 @cindex IMAP4 Status 148 @cindex IMAP4 Status
148 149
149 @deftypefun int imap4_status (imap4_t) 150 @deftypefun int mu_imap4_status (mu_imap4_t)
150 @end deftypefun 151 @end deftypefun
151 152
152 @subsubsection Store 153 @subsubsection Store
153 @cindex IMAP4 Store 154 @cindex IMAP4 Store
154 155
155 @deftypefun int imap4_store (imap4_t) 156 @deftypefun int mu_imap4_store (mu_imap4_t)
156 @end deftypefun 157 @end deftypefun
157 158
158 @subsubsection UID Store 159 @subsubsection UID Store
159 @cindex IMAP4 UID Store 160 @cindex IMAP4 UID Store
160 161
161 @deftypefun int imap4_uid_store (imap4_t) 162 @deftypefun int mu_imap4_uid_store (mu_imap4_t)
162 @end deftypefun 163 @end deftypefun
163 164
164 @subsubsection Subscribe 165 @subsubsection Subscribe
165 @cindex IMAP4 Subscribe 166 @cindex IMAP4 Subscribe
166 167
167 @deftypefun int imap4_subscribe (imap4_t) 168 @deftypefun int mu_imap4_subscribe (mu_imap4_t)
168 @end deftypefun 169 @end deftypefun
169 170
170 @subsubsection Unsubscribe 171 @subsubsection Unsubscribe
171 @cindex IMAP4 Unsubscribe 172 @cindex IMAP4 Unsubscribe
172 173
173 @deftypefun int imap4_unsubscribe (imap4_t) 174 @deftypefun int mu_imap4_unsubscribe (mu_imap4_t)
174 @end deftypefun 175 @end deftypefun
......
1 @c This is part of the GNU Mailutils manual. 1 @c This is part of the GNU Mailutils manual.
2 @c Copyright (C) 1999,2000,2001,2002,2003,2004 Free Software Foundation, Inc. 2 @c Copyright (C) 1999,2000,2001,2002,2003,2004,2006
3 @c Free Software Foundation, Inc.
3 @c See file mailutils.texi for copying conditions. 4 @c See file mailutils.texi for copying conditions.
4 @comment ******************************************************************* 5 @comment *******************************************************************
5 6
6 @smallexample 7 @smallexample
7 @code{/* Prefix @emph{iterator_} is reserved. */} 8 @code{/* Prefix @emph{mu_iterator_} is reserved. */}
8 @code{#include <mailutils/iterator.h>} 9 @code{#include <mailutils/iterator.h>}
9 @end smallexample 10 @end smallexample
10 11
11 @deftypefun int iterator_create (iterator_t *@var{iterator}, list_t) 12 @deftypefun int mu_iterator_create (mu_iterator_t *@var{iterator}, void *@var{obj})
12 @end deftypefun 13 @end deftypefun
13 14
14 @deftypefun int iterator_dup (iterator_t *@var{iterator}, iterator_t @var{orig}) 15 @deftypefun int mu_iterator_dup (mu_iterator_t *@var{iterator}, mu_iterator_t @var{orig})
15 @end deftypefun 16 @end deftypefun
16 17
17 @deftypefun void iterator_destroy (iterator_t *) 18 @deftypefun void mu_iterator_destroy (mu_iterator_t *)
18 @end deftypefun 19 @end deftypefun
19 20
20 @deftypefun int iterator_first (iterator_t) 21 @deftypefun int mu_iterator_first (mu_iterator_t)
21 @end deftypefun 22 @end deftypefun
22 23
23 @deftypefun int iterator_next (iterator_t) 24 @deftypefun int mu_iterator_next (mu_iterator_t)
24 @end deftypefun 25 @end deftypefun
25 26
26 @deftypefun int iterator_current (iterator_t, void **@var{item}) 27 @deftypefun int mu_iterator_current (mu_iterator_t, void **@var{item})
27 @end deftypefun 28 @end deftypefun
28 29
29 @deftypefun int iterator_is_done (iterator_t) 30 @deftypefun int mu_iterator_is_done (mu_iterator_t)
30 @end deftypefun 31 @end deftypefun
31 32
32 @deftypefun int iterator_get_list (iterator_t @var{iterator}, list_t *@var{list}) 33 @deftypefun int mu_iterator_attach (mu_iterator_t *@var{root}, mu_iterator_t @var{iterator})
33 @end deftypefun 34 @end deftypefun
35
36 @deftypefun int mu_iterator_detach (mu_iterator_t *@var{root}, mu_iterator_t @var{iterator})
37 @end deftypefun
38
39 @deftypefun void mu_iterator_advance (mu_iterator_t @var{iterator}, void *@var{item})
40 @end deftypefun
41
42 @deftypefun int mu_iterator_set_first (mu_iterator_t @var{iterator}, int (*@var{first}) (void *))
43 @end deftypefun
44
45 @deftypefun int mu_iterator_set_next (mu_iterator_t @var{iterator}, int (*@var{next}) (void *))
46 @end deftypefun
47
48 @deftypefun int mu_iterator_set_getitem (mu_iterator_t @var{iterator}, int (*@var{getitem}) (void *, void **))
49 @end deftypefun
50
51 @deftypefun int mu_iterator_set_finished_p (mu_iterator_t @var{iterator}, int (*@var{finished_p}) (void *))
52 @end deftypefun
53
54 @deftypefun int mu_iterator_set_dup (mu_iterator_t @var{itr}, int (*@var{dup}) (void **@var{ptr}, void *@var{data}))
55 @end deftypefun
56
57 @deftypefun int mu_iterator_set_destroy (mu_iterator_t @var{itr}, int (*@var{destroy}) (mu_iterator_t @var{itr}, void *@var{data}))
58 @end deftypefun
59
60 @deftypefun int mu_iterator_set_curitem_p (mu_iterator_t @var{itr}, int (*@var{curitem_p}) (void *, void *))
61 @end deftypefun
62
......
1 @c This is part of the GNU Mailutils manual. 1 @c This is part of the GNU Mailutils manual.
2 @c Copyright (C) 1999,2000,2001,2002,2003,2004 Free Software Foundation, Inc. 2 @c Copyright (C) 1999,2000,2001,2002,2003,2004,2006 Free Software Foundation, Inc.
3 @c See file mailutils.texi for copying conditions. 3 @c See file mailutils.texi for copying conditions.
4 @comment ******************************************************************* 4 @comment *******************************************************************
5 5
6 @smallexample 6 @smallexample
7 @code{/* Prefix @emph{locker_} is reserved. */} 7 @code{/* Prefix @emph{mu_locker_} is reserved. */}
8 @code{#include <mailutils/locker.h>} 8 @code{#include <mailutils/locker.h>}
9 @end smallexample 9 @end smallexample
10 10
11 @deftypefun int locker_set_default_flags (int @var{flags}, enum mu_locker_set_mode @var{mode}) 11 @deftypefun int mu_locker_set_default_flags (int @var{flags}, enum mu_locker_set_mode @var{mode})
12 @end deftypefun 12 @end deftypefun
13 13
14 @deftypefun void locker_set_default_retry_timeout (time_t @var{to}) 14 @deftypefun void mu_locker_set_default_retry_timeout (time_t @var{to})
15 @end deftypefun 15 @end deftypefun
16 16
17 @deftypefun void locker_set_default_retry_count (size_t @var{n}) 17 @deftypefun void mu_locker_set_default_retry_count (size_t @var{n})
18 @end deftypefun 18 @end deftypefun
19 19
20 @deftypefun void locker_set_default_expire_timeout (time_t @var{t}) 20 @deftypefun void mu_locker_set_default_expire_timeout (time_t @var{t})
21 @end deftypefun 21 @end deftypefun
22 22
23 @deftypefun void locker_set_default_external_program (char *@var{path}) 23 @deftypefun void mu_locker_set_default_external_program (char *@var{path})
24 @end deftypefun 24 @end deftypefun
25 25
26 A flags of 0 means that the default will be used. 26 A flags of 0 means that the default will be used.
27 27
28 @deftypefun int locker_create (locker_t *, const char *@var{filename}, int @var{flags}) 28 @deftypefun int mu_locker_create (mu_locker_t *, const char *@var{filename}, int @var{flags})
29 @end deftypefun 29 @end deftypefun
30 30
31 @deftypefun void locker_destroy (locker_t *) 31 @deftypefun void mu_locker_destroy (mu_locker_t *)
32 @end deftypefun 32 @end deftypefun
33 33
34 Time is measured in seconds. 34 Time is measured in seconds.
35 35
36 @deftypefun int locker_set_flags (locker_t, int) 36 @deftypefun int mu_locker_set_flags (mu_locker_t, int)
37 @end deftypefun 37 @end deftypefun
38 38
39 @deftypefun int locker_set_expire_time (locker_t, int) 39 @deftypefun int mu_locker_set_expire_time (mu_locker_t, int)
40 @end deftypefun 40 @end deftypefun
41 41
42 @deftypefun int locker_set_retries (locker_t, int) 42 @deftypefun int mu_locker_set_retries (mu_locker_t, int)
43 @end deftypefun 43 @end deftypefun
44 44
45 @deftypefun int locker_set_retry_sleep (locker_t, int) 45 @deftypefun int mu_locker_set_retry_sleep (mu_locker_t, int)
46 @end deftypefun 46 @end deftypefun
47 47
48 @deftypefun int locker_set_external (locker_t, const char *@var{program}) 48 @deftypefun int mu_locker_set_external (mu_locker_t, const char *@var{program})
49 @end deftypefun 49 @end deftypefun
50 50
51 @deftypefun int locker_get_flags (locker_t, int *) 51 @deftypefun int mu_locker_get_flags (mu_locker_t, int *)
52 @end deftypefun 52 @end deftypefun
53 53
54 @deftypefun int locker_get_expire_time (locker_t, int*) 54 @deftypefun int mu_locker_get_expire_time (mu_locker_t, int*)
55 @end deftypefun 55 @end deftypefun
56 56
57 @deftypefun int locker_get_retries (locker_t, int *) 57 @deftypefun int mu_locker_get_retries (mu_locker_t, int *)
58 @end deftypefun 58 @end deftypefun
59 59
60 @deftypefun int locker_get_retry_sleep (locker_t, int *) 60 @deftypefun int mu_locker_get_retry_sleep (mu_locker_t, int *)
61 @end deftypefun 61 @end deftypefun
62 62
63 @deftypefun int locker_get_external (locker_t, char **) 63 @deftypefun int mu_locker_get_external (mu_locker_t, char **)
64 @end deftypefun 64 @end deftypefun
65 65
66 @deftypefun int locker_lock (locker_t) 66 @deftypefun int mu_locker_lock (mu_locker_t)
67 @end deftypefun 67 @end deftypefun
68 68
69 @deftypefun int locker_touchlock (locker_t) 69 @deftypefun int mu_locker_touchlock (mu_locker_t)
70 @end deftypefun 70 @end deftypefun
71 71
72 @deftypefun int locker_unlock (locker_t) 72 @deftypefun int mu_locker_unlock (mu_locker_t)
73 @end deftypefun 73 @end deftypefun
74 74
75 @deftypefun int locker_remove_lock (locker_t) 75 @deftypefun int mu_locker_remove_lock (mu_locker_t)
76 @end deftypefun 76 @end deftypefun
......
1 @c This is part of the GNU Mailutils manual. 1 @c This is part of the GNU Mailutils manual.
2 @c Copyright (C) 1999,2000,2001,2002,2003,2004 Free Software Foundation, Inc. 2 @c Copyright (C) 1999,2000,2001,2002,2003,2004,2006 Free Software Foundation, Inc.
3 @c See file mailutils.texi for copying conditions. 3 @c See file mailutils.texi for copying conditions.
4 @comment ******************************************************************* 4 @comment *******************************************************************
5 5
...@@ -70,7 +70,7 @@ from the data structure. ...@@ -70,7 +70,7 @@ from the data structure.
70 @include mailcap.inc 70 @include mailcap.inc
71 @end smallexample 71 @end smallexample
72 72
73 @deftypefun int mu_mailcap_create (mu_mailcap_t *@var{mailcap}, stream_t @var{stream}) 73 @deftypefun int mu_mailcap_create (mu_mailcap_t *@var{mailcap}, mu_stream_t @var{stream})
74 The function allocates, parses the buffer from the @var{stream} and initializes @var{mailcap}. 74 The function allocates, parses the buffer from the @var{stream} and initializes @var{mailcap}.
75 The return value is @code{0} on success and a code number on error conditions: 75 The return value is @code{0} on success and a code number on error conditions:
76 @table @code 76 @table @code
...@@ -156,9 +156,9 @@ Helper function saving in buffer, the argument of "notes" field. ...@@ -156,9 +156,9 @@ Helper function saving in buffer, the argument of "notes" field.
156 @end deftypefun 156 @end deftypefun
157 157
158 @deftypefun int mu_mailcap_entry_needsterminal (mu_mailcap_entry_t @var{entry}, int *@var{on}) 158 @deftypefun int mu_mailcap_entry_needsterminal (mu_mailcap_entry_t @var{entry}, int *@var{on})
159 Helper function. Returns *@var{on} != 0 if the flag "needsterminal" is in the record. 159 Helper function. Returns *@var{on} != 0 if the flag @code{needsterminal} is in the record.
160 @end deftypefun 160 @end deftypefun
161 161
162 @deftypefun int mu_mailcap_entry_copiousoutput (mu_mailcap_entry_t @var{entry}, int *@var{on}) 162 @deftypefun int mu_mailcap_entry_copiousoutput (mu_mailcap_entry_t @var{entry}, int *@var{on})
163 Helper function. Returns *@var{on} != 0 if the flag "copiousoutput" is in the record. 163 Helper function. Returns *@var{on} != 0 if the flag @var{copiousoutput} is in the record.
164 @end deftypefun 164 @end deftypefun
......
1 @c This is part of the GNU Mailutils manual. 1 @c This is part of the GNU Mailutils manual.
2 @c Copyright (C) 1999,2000,2001,2002,2003,2004 Free Software Foundation, Inc. 2 @c Copyright (C) 1999,2000,2001,2002,2003,2004,2006 Free Software Foundation, Inc.
3 @c See file mailutils.texi for copying conditions. 3 @c See file mailutils.texi for copying conditions.
4 @comment ******************************************************************* 4 @comment *******************************************************************
5 5
6 @smallexample 6 @smallexample
7 @code{/* Prefix @emph{mailer_} is reserved. */} 7 @code{/* Prefix @emph{mu_mailer_} is reserved. */}
8 @code{#include <mailutils/mailer.h>} 8 @code{#include <mailutils/mailer.h>}
9 9
10 @end smallexample 10 @end smallexample
...@@ -13,19 +13,19 @@ ...@@ -13,19 +13,19 @@
13 @c Constructor/Destructor. 13 @c Constructor/Destructor.
14 @c 14 @c
15 15
16 @deftypefun int mailer_create (mailer_t *, const char *@var{url}) 16 @deftypefun int mu_mailer_create (mu_mailer_t *, const char *@var{url})
17 @end deftypefun 17 @end deftypefun
18 18
19 @deftypefun void mailer_destroy (mailer_t *) 19 @deftypefun void mu_mailer_destroy (mu_mailer_t *)
20 @end deftypefun 20 @end deftypefun
21 21
22 @deftypefun int mailer_open (mailer_t, int @var{flags}) 22 @deftypefun int mu_mailer_open (mu_mailer_t, int @var{flags})
23 @end deftypefun 23 @end deftypefun
24 24
25 @deftypefun int mailer_close (mailer_t) 25 @deftypefun int mu_mailer_close (mu_mailer_t)
26 @end deftypefun 26 @end deftypefun
27 27
28 @deftypefun int mailer_send_message (mailer_t @var{mailer}, message_t @var{msg}, address_t @var{from}, address_t @var{to}); 28 @deftypefun int mu_mailer_send_message (mu_mailer_t @var{mailer}, mu_message_t @var{msg}, mu_address_t @var{from}, mu_address_t @var{to});
29 29
30 If @var{from} is not @code{NULL}, it must contain a single fully qualified 30 If @var{from} is not @code{NULL}, it must contain a single fully qualified
31 RFC2822 email address which will be used as the envelope from 31 RFC2822 email address which will be used as the envelope from
...@@ -42,31 +42,31 @@ The default for @var{to} is to use the contents of the standard "To:", "Cc:", ...@@ -42,31 +42,31 @@ The default for @var{to} is to use the contents of the standard "To:", "Cc:",
42 and "Bcc:" fields, this is equivalent to Sendmail's @option{-t} flag. 42 and "Bcc:" fields, this is equivalent to Sendmail's @option{-t} flag.
43 @end deftypefun 43 @end deftypefun
44 44
45 @deftypefun int mailer_get_property (mailer_t, property_t *) 45 @deftypefun int mu_mailer_get_property (mu_mailer_t, mu_property_t *)
46 @end deftypefun 46 @end deftypefun
47 47
48 @deftypefun int mailer_get_stream (mailer_t, stream_t *) 48 @deftypefun int mu_mailer_get_stream (mu_mailer_t, mu_stream_t *)
49 @end deftypefun 49 @end deftypefun
50 50
51 @deftypefun int mailer_set_stream (mailer_t, stream_t) 51 @deftypefun int mu_mailer_set_stream (mu_mailer_t, mu_stream_t)
52 @end deftypefun 52 @end deftypefun
53 53
54 @deftypefun int mailer_get_debug (mailer_t, mu_debug_t *) 54 @deftypefun int mu_mailer_get_debug (mu_mailer_t, mu_debug_t *)
55 @end deftypefun 55 @end deftypefun
56 56
57 @deftypefun int mailer_set_debug (mailer_t, mu_debug_t) 57 @deftypefun int mu_mailer_set_debug (mu_mailer_t, mu_debug_t)
58 @end deftypefun 58 @end deftypefun
59 59
60 @deftypefun int mailer_get_observable (mailer_t, observable_t *) 60 @deftypefun int mu_mailer_get_observable (mu_mailer_t, observable_t *)
61 @end deftypefun 61 @end deftypefun
62 62
63 @deftypefun int mailer_get_url (mailer_t, url_t *) 63 @deftypefun int mu_mailer_get_url (mu_mailer_t, url_t *)
64 @end deftypefun 64 @end deftypefun
65 65
66 @deftypefun int mailer_check_from (address_t @var{from}) 66 @deftypefun int mu_mailer_check_from (mu_address_t @var{from})
67 @end deftypefun 67 @end deftypefun
68 68
69 @deftypefun int mailer_check_to (address_t @var{to}) 69 @deftypefun int mu_mailer_check_to (mu_address_t @var{to})
70 @end deftypefun 70 @end deftypefun
71 71
72 @sp 1 72 @sp 1
...@@ -74,41 +74,53 @@ and "Bcc:" fields, this is equivalent to Sendmail's @option{-t} flag. ...@@ -74,41 +74,53 @@ and "Bcc:" fields, this is equivalent to Sendmail's @option{-t} flag.
74 74
75 Some possible use cases the API must support are: 75 Some possible use cases the API must support are:
76 76
77 - original submission 77 @itemize @bullet{}
78 @item original submission
78 79
79 1 - fill in header addresses 80 @enumerate 0
81 @item fill in header addresses
80 82
81 2 - @code{mailer_send_message(mailer, msg, NULL, NULL)} 83 @item @code{mu_mailer_send_message(mailer, msg, NULL, NULL)}
82 84
83 - from will be filled in if missing, 85 @itemize @minus{}
86 @item from will be filled in if missing,
84 87
85 - Bcc's will be deleted before delivery to a non-bcc address, 88 @item Bcc's will be deleted before delivery to a non-bcc address,
86 89
87 - message-id and date will be added, if missing, 90 @item message-id and date will be added, if missing,
88 91
89 - a To: or Apparently-To: will be added if non is present (for RFC 92 @item a @code{To:} or @code{Apparently-To:} header will be added if non is present (for RFC compliance)
90 compliance) 93 @end itemize
91 94
92 - MTA-style @file{.forward} (and Sieve-style redirect) 95 @end enumerate
93 96
94 1 - get the envelope from of the message to be forwarded 97 @item MTA-style @file{.forward} (and Sieve-style redirect)
95 98
96 2 - @code{mailer_send_message(mailer, msg, from, to)} 99 @enumerate 1
100 @item get the envelope from of the message to be forwarded
97 101
98 - MUA-style bounce 102 @item @code{mu_mailer_send_message(mailer, msg, from, to)}
103 @end enumerate
99 104
100 1 - add Resent-[To,From,...] 105 @item MUA-style bounce
101 106
102 2 - @code{mailer_send_message(mailer, msg, NULL, to)} 107 @enumerate 1
108 @item add @code{Resent-[To,From,...]}
103 109
104 - DSN "bounce" 110 @item @code{mu_mailer_send_message(mailer, msg, NULL, to)}
111 @end enumerate
105 112
106 1 - compose DSN 113 @item DSN "bounce"
107 114
108 2 - @code{mailer_deliver(mailer, msg, address_t("<>"), to)} 115 @enumerate 1
116 @item compose DSN
117
118 @item @code{mu_mailer_deliver(mailer, msg, address_t("<>"), to)}
109 119
110 Don't want mail loops, so the null but valid SMTP address of @samp{<>} 120 Don't want mail loops, so the null but valid SMTP address of @samp{<>}
111 is the envelope From. 121 is the envelope From.
122 @end enumerate
123 @end itemize
112 124
113 @subheading The Sendmail Mailer 125 @subheading The Sendmail Mailer
114 126
...@@ -124,7 +136,7 @@ contents for the recipients). ...@@ -124,7 +136,7 @@ contents for the recipients).
124 136
125 @strong{Caution:} since the @code{stdout} and @code{stderr} of Sendmail 137 @strong{Caution:} since the @code{stdout} and @code{stderr} of Sendmail
126 is closed, we have no way of ever giving feedback on failure. Also, what 138 is closed, we have no way of ever giving feedback on failure. Also, what
127 should the return code be from @code{mailer_send_message()} when Sendmail 139 should the return code be from @code{mu_mailer_send_message()} when Sendmail
128 returns @samp{1}? @samp{1} maps to @code{EPERM}, which is less than 140 returns @samp{1}? @samp{1} maps to @code{EPERM}, which is less than
129 descriptive! 141 descriptive!
130 142
......
1 @c This is part of the GNU Mailutils manual. 1 @c This is part of the GNU Mailutils manual.
2 @c Copyright (C) 1999,2000,2001,2002,2003,2004 Free Software Foundation, Inc. 2 @c Copyright (C) 1999,2000,2001,2002,2003,2004,2006 Free Software Foundation, Inc.
3 @c See file mailutils.texi for copying conditions. 3 @c See file mailutils.texi for copying conditions.
4 @comment ******************************************************************* 4 @comment *******************************************************************
5 5
6 @smallexample 6 @smallexample
7 @code{/* Prefix @emph{pop3_} is reserve */} 7 @code{/* Prefix @emph{mu_mime_} is reserved */}
8 @code{#include <mailutils/pop3.h>} 8 @code{#include <mailutils/mime.h>}
9 9
10 @end smallexample 10 @end smallexample
11 11
12 Multipurpose Internet Mail Extensions (MIME). 12 Multipurpose Internet Mail Extensions (MIME).
13 13
14 @deftypefun int mime_create (mime_t *pmime, message_t msg, int flags) 14 @deftypefun int mu_mime_create (mu_mime_t *pmime, mu_message_t msg, int flags)
15 @end deftypefun 15 @end deftypefun
16 16
17 @deftypefun void mime_destroy (mime_t *pmime) 17 @deftypefun void mu_mime_destroy (mu_mime_t *pmime)
18 @end deftypefun 18 @end deftypefun
19 19
20 @deftypefun int mime_is_multipart (mime_t mime) 20 @deftypefun int mu_mime_is_multipart (mu_mime_t mime)
21 @end deftypefun 21 @end deftypefun
22 22
23 @deftypefun int mime_get_num_parts (mime_t mime, size_t *nparts) 23 @deftypefun int mu_mime_get_num_parts (mu_mime_t mime, size_t *nparts)
24 @end deftypefun 24 @end deftypefun
25 25
26 @deftypefun int mime_get_part (mime_t mime, size_t part, message_t *msg) 26 @deftypefun int mu_mime_get_part (mu_mime_t mime, size_t part, mu_message_t *msg)
27 @end deftypefun 27 @end deftypefun
28 28
29 @deftypefun int mime_add_part (mime_t mime, message_t msg) 29 @deftypefun int mu_mime_add_part (mu_mime_t mime, mu_message_t msg)
30 @end deftypefun 30 @end deftypefun
31 31
32 @deftypefun int mime_get_message (mime_t mime, message_t *msg) 32 @deftypefun int mu_mime_get_message (mu_mime_t mime, mu_message_t *msg)
33 @end deftypefun 33 @end deftypefun
......
1 @c This is part of the GNU Mailutils manual. 1 @c This is part of the GNU Mailutils manual.
2 @c Copyright (C) 1999,2000,2001,2002,2003,2004 Free Software Foundation, Inc. 2 @c Copyright (C) 1999,2000,2001,2002,2003,2004,2006 Free Software Foundation, Inc.
3 @c See file mailutils.texi for copying conditions. 3 @c See file mailutils.texi for copying conditions.
4 @comment ******************************************************************* 4 @comment *******************************************************************
5 5
6 @smallexample 6 @smallexample
7 @code{/* Prefix @emph{nntp_} is reserved */} 7 @code{/* Prefix @emph{mu_nntp_} is reserved */}
8 @code{#include <mailutils/nntp.h>} 8 @code{#include <mailutils/nntp.h>}
9 9
10 @end smallexample 10 @end smallexample
...@@ -15,86 +15,86 @@ Network News Transfer Protocol. Not implemented. ...@@ -15,86 +15,86 @@ Network News Transfer Protocol. Not implemented.
15 15
16 @subsubsection Initialization 16 @subsubsection Initialization
17 @cindex NNTP Initialization 17 @cindex NNTP Initialization
18 @deftypefun int nntp_create (nnpt_t *) 18 @deftypefun int mu_nntp_create (mu_nntp_t *)
19 @end deftypefun 19 @end deftypefun
20 20
21 @deftypefun int nntp_destroy (nnpt_t *) 21 @deftypefun int mu_nntp_destroy (mu_nntp_t *)
22 @end deftypefun 22 @end deftypefun
23 23
24 @deftypefun int nntp_open (nnpt_t) 24 @deftypefun int mu_nntp_open (nnpt_t)
25 @end deftypefun 25 @end deftypefun
26 26
27 @subsubsection Article 27 @subsubsection Article
28 @cindex NNTP Article 28 @cindex NNTP Article
29 @deftypefun int nntp_article (nnpt_t) 29 @deftypefun int mu_nntp_article (nnpt_t)
30 @end deftypefun 30 @end deftypefun
31 31
32 @subsubsection Body 32 @subsubsection Body
33 @cindex NNTP Body 33 @cindex NNTP Body
34 @deftypefun int nntp_body (nntp_t) 34 @deftypefun int mu_nntp_body (mu_nntp_t)
35 @end deftypefun 35 @end deftypefun
36 36
37 @subsubsection Group 37 @subsubsection Group
38 @cindex NNTP Group 38 @cindex NNTP Group
39 @deftypefun int nntp_group (nntp_t) 39 @deftypefun int mu_nntp_group (mu_nntp_t)
40 @end deftypefun 40 @end deftypefun
41 41
42 @subsubsection Head 42 @subsubsection Head
43 @cindex NNTP Head 43 @cindex NNTP Head
44 @deftypefun int nntp_head (nntp_t) 44 @deftypefun int mu_nntp_head (mu_nntp_t)
45 @end deftypefun 45 @end deftypefun
46 46
47 @subsubsection Help 47 @subsubsection Help
48 @cindex NNTP Help 48 @cindex NNTP Help
49 @deftypefun int nntp_help (nntp_t) 49 @deftypefun int mu_nntp_help (mu_nntp_t)
50 @end deftypefun 50 @end deftypefun
51 51
52 @subsubsection IHave 52 @subsubsection IHave
53 @cindex NNTP IHave 53 @cindex NNTP IHave
54 @deftypefun int nntp_ihave (nntp_t) 54 @deftypefun int mu_nntp_ihave (mu_nntp_t)
55 @end deftypefun 55 @end deftypefun
56 56
57 @subsubsection Last 57 @subsubsection Last
58 @cindex NNTP Last 58 @cindex NNTP Last
59 @deftypefun int nntp_last (nntp_t) 59 @deftypefun int mu_nntp_last (mu_nntp_t)
60 @end deftypefun 60 @end deftypefun
61 61
62 @subsubsection List 62 @subsubsection List
63 @cindex NNTP List 63 @cindex NNTP List
64 @deftypefun int nntp_list (nntp_t) 64 @deftypefun int mu_nntp_list (mu_nntp_t)
65 @end deftypefun 65 @end deftypefun
66 66
67 @subsubsection NewGroups 67 @subsubsection NewGroups
68 @cindex NNTP NewGroups 68 @cindex NNTP NewGroups
69 @deftypefun int nntp_newgroups (nntp_t) 69 @deftypefun int mu_nntp_newgroups (mu_nntp_t)
70 @end deftypefun 70 @end deftypefun
71 71
72 @subsubsection NewNews 72 @subsubsection NewNews
73 @cindex NNTP NewNews 73 @cindex NNTP NewNews
74 @deftypefun int nntp_newnews (nntp_t) 74 @deftypefun int mu_nntp_newnews (mu_nntp_t)
75 @end deftypefun 75 @end deftypefun
76 76
77 @subsubsection Next 77 @subsubsection Next
78 @cindex NNTP Next 78 @cindex NNTP Next
79 @deftypefun int nntp_next (nntp_t) 79 @deftypefun int mu_nntp_next (mu_nntp_t)
80 @end deftypefun 80 @end deftypefun
81 81
82 @subsubsection Post 82 @subsubsection Post
83 @cindex NNTP Post 83 @cindex NNTP Post
84 @deftypefun int nntp_post (nntp_t) 84 @deftypefun int mu_nntp_post (mu_nntp_t)
85 @end deftypefun 85 @end deftypefun
86 86
87 @subsubsection Quit 87 @subsubsection Quit
88 @cindex NNTP Quit 88 @cindex NNTP Quit
89 @deftypefun int nntp_quit (nntp_t) 89 @deftypefun int mu_nntp_quit (mu_nntp_t)
90 @end deftypefun 90 @end deftypefun
91 91
92 @subsubsection Slave 92 @subsubsection Slave
93 @cindex NNTP Slave 93 @cindex NNTP Slave
94 @deftypefun int nntp_slave (nntp_t) 94 @deftypefun int mu_nntp_slave (mu_nntp_t)
95 @end deftypefun 95 @end deftypefun
96 96
97 @subsubsection Stat 97 @subsubsection Stat
98 @cindex NNTP Stat 98 @cindex NNTP Stat
99 @deftypefun int nntp_stat (nntp_t) 99 @deftypefun int mu_nntp_stat (mu_nntp_t)
100 @end deftypefun 100 @end deftypefun
......
1 @c This is part of the GNU Mailutils manual. 1 @c This is part of the GNU Mailutils manual.
2 @c Copyright (C) 1999,2000,2001,2002,2003,2004 Free Software Foundation, Inc. 2 @c Copyright (C) 1999,2000,2001,2002,2003,2004,2006 Free Software Foundation, Inc.
3 @c See file mailutils.texi for copying conditions. 3 @c See file mailutils.texi for copying conditions.
4 @comment ******************************************************************* 4 @comment *******************************************************************
5 5
6 @smallexample 6 @smallexample
7 @code{/* Prefix @emph{parse822_} is reserved. */} 7 @code{/* Prefix @emph{mu_parse822_} is reserved. */}
8 @code{#include <mailutils/parse822.h>} 8 @code{#include <mailutils/parse822.h>}
9 9
10 @end smallexample 10 @end smallexample
11 11
12 @deftypefun int parse822_is_char (char @var{c}) 12 @deftypefun int mu_parse822_is_char (char @var{c})
13 @end deftypefun 13 @end deftypefun
14 14
15 @deftypefun int parse822_is_digit (char @var{c}) 15 @deftypefun int mu_parse822_is_digit (char @var{c})
16 @end deftypefun 16 @end deftypefun
17 17
18 @deftypefun int parse822_is_ctl (char @var{c}) 18 @deftypefun int mu_parse822_is_ctl (char @var{c})
19 @end deftypefun 19 @end deftypefun
20 20
21 @deftypefun int parse822_is_space (char @var{c}) 21 @deftypefun int mu_parse822_is_space (char @var{c})
22 @end deftypefun 22 @end deftypefun
23 23
24 @deftypefun int parse822_is_htab (char @var{c}) 24 @deftypefun int mu_parse822_is_htab (char @var{c})
25 @end deftypefun 25 @end deftypefun
26 26
27 @deftypefun int parse822_is_lwsp_char (char @var{c}) 27 @deftypefun int mu_parse822_is_lwsp_char (char @var{c})
28 @end deftypefun 28 @end deftypefun
29 29
30 @deftypefun int parse822_is_special (char @var{c}) 30 @deftypefun int mu_parse822_is_special (char @var{c})
31 @end deftypefun 31 @end deftypefun
32 32
33 @deftypefun int parse822_is_atom_char (char @var{c}) 33 @deftypefun int mu_parse822_is_atom_char (char @var{c})
34 @end deftypefun 34 @end deftypefun
35 35
36 @deftypefun int parse822_is_q_text (char @var{c}) 36 @deftypefun int mu_parse822_is_q_text (char @var{c})
37 @end deftypefun 37 @end deftypefun
38 38
39 @deftypefun int parse822_is_d_text (char @var{c}) 39 @deftypefun int mu_parse822_is_d_text (char @var{c})
40 @end deftypefun 40 @end deftypefun
41 41
42 @deftypefun int parse822_is_smtp_q (char @var{c}) 42 @deftypefun int mu_parse822_is_smtp_q (char @var{c})
43 @end deftypefun 43 @end deftypefun
44 44
45 @deftypefun int parse822_skip_crlf (const char **@var{p}, const char *@var{e}) 45 @deftypefun int mu_parse822_skip_crlf (const char **@var{p}, const char *@var{e})
46 @end deftypefun 46 @end deftypefun
47 47
48 @deftypefun int parse822_skip_lwsp_char (const char **@var{p}, const char *@var{e}) 48 @deftypefun int mu_parse822_skip_lwsp_char (const char **@var{p}, const char *@var{e})
49 @end deftypefun 49 @end deftypefun
50 50
51 @deftypefun int parse822_skip_lwsp (const char **@var{p}, const char *@var{e}) 51 @deftypefun int mu_parse822_skip_lwsp (const char **@var{p}, const char *@var{e})
52 @end deftypefun 52 @end deftypefun
53 53
54 @deftypefun int parse822_skip_comments (const char **@var{p}, const char *@var{e}) 54 @deftypefun int mu_parse822_skip_comments (const char **@var{p}, const char *@var{e})
55 @end deftypefun 55 @end deftypefun
56 56
57 @deftypefun int parse822_skip_nl (const char **@var{p}, const char *@var{e}) 57 @deftypefun int mu_parse822_skip_nl (const char **@var{p}, const char *@var{e})
58 @end deftypefun 58 @end deftypefun
59 59
60 @deftypefun int parse822_digits (const char **@var{p}, const char *@var{e}, int @var{min}, int @var{max}, int *@var{digits}) 60 @deftypefun int mu_parse822_digits (const char **@var{p}, const char *@var{e}, int @var{min}, int @var{max}, int *@var{digits})
61 @end deftypefun 61 @end deftypefun
62 62
63 @deftypefun int parse822_special (const char **@var{p}, const char *@var{e}, char @var{c}) 63 @deftypefun int mu_parse822_special (const char **@var{p}, const char *@var{e}, char @var{c})
64 @end deftypefun 64 @end deftypefun
65 65
66 @deftypefun int parse822_comment (const char **@var{p}, const char *@var{e}, char **@var{comment}) 66 @deftypefun int mu_parse822_comment (const char **@var{p}, const char *@var{e}, char **@var{comment})
67 @end deftypefun 67 @end deftypefun
68 68
69 @deftypefun int parse822_atom (const char **@var{p}, const char *@var{e}, char **@var{atom}) 69 @deftypefun int mu_parse822_atom (const char **@var{p}, const char *@var{e}, char **@var{atom})
70 @end deftypefun 70 @end deftypefun
71 71
72 @deftypefun int parse822_quoted_pair (const char **@var{p}, const char *@var{e}, char **@var{qpair}) 72 @deftypefun int mu_parse822_quoted_pair (const char **@var{p}, const char *@var{e}, char **@var{qpair})
73 @end deftypefun 73 @end deftypefun
74 74
75 @deftypefun int parse822_quoted_string (const char **@var{p}, const char *@var{e}, char **@var{qstr}) 75 @deftypefun int mu_parse822_quoted_string (const char **@var{p}, const char *@var{e}, char **@var{qstr})
76 @end deftypefun 76 @end deftypefun
77 77
78 @deftypefun int parse822_word (const char **@var{p}, const char *@var{e}, char **@var{word}) 78 @deftypefun int mu_parse822_word (const char **@var{p}, const char *@var{e}, char **@var{word})
79 @end deftypefun 79 @end deftypefun
80 80
81 @deftypefun int parse822_phrase (const char **@var{p}, const char *@var{e}, char **@var{phrase}) 81 @deftypefun int mu_parse822_phrase (const char **@var{p}, const char *@var{e}, char **@var{phrase})
82 @end deftypefun 82 @end deftypefun
83 83
84 @deftypefun int parse822_d_text (const char **@var{p}, const char *@var{e}, char **@var{dtext}) 84 @deftypefun int mu_parse822_d_text (const char **@var{p}, const char *@var{e}, char **@var{dtext})
85 @end deftypefun 85 @end deftypefun
86 86
87 @c 87 @c
88 @c From RFC 822, 6.1 Address Specification Syntax 88 @c From RFC 822, 6.1 Address Specification Syntax
89 @c 89 @c
90 90
91 @deftypefun int parse822_address_list (address_t *@var{a}, const char *@var{s}) 91 @deftypefun int mu_parse822_address_list (mu_address_t *@var{a}, const char *@var{s})
92 @end deftypefun 92 @end deftypefun
93 93
94 @deftypefun int parse822_mail_box (const char **@var{p}, const char *@var{e}, address_t *@var{a}) 94 @deftypefun int mu_parse822_mail_box (const char **@var{p}, const char *@var{e}, mu_address_t *@var{a})
95 @end deftypefun 95 @end deftypefun
96 96
97 @deftypefun int parse822_group (const char **@var{p}, const char *@var{e}, address_t *@var{a}) 97 @deftypefun int mu_parse822_group (const char **@var{p}, const char *@var{e}, mu_address_t *@var{a})
98 @end deftypefun 98 @end deftypefun
99 99
100 @deftypefun int parse822_address (const char **@var{p}, const char *@var{e}, address_t *@var{a}) 100 @deftypefun int mu_parse822_address (const char **@var{p}, const char *@var{e}, mu_address_t *@var{a})
101 @end deftypefun 101 @end deftypefun
102 102
103 @deftypefun int parse822_route_addr (const char **@var{p}, const char *@var{e}, address_t *@var{a}) 103 @deftypefun int mu_parse822_route_addr (const char **@var{p}, const char *@var{e}, mu_address_t *@var{a})
104 @end deftypefun 104 @end deftypefun
105 105
106 @deftypefun int parse822_route (const char **@var{p}, const char *@var{e}, char **@var{route}) 106 @deftypefun int mu_parse822_route (const char **@var{p}, const char *@var{e}, char **@var{route})
107 @end deftypefun 107 @end deftypefun
108 108
109 @deftypefun int parse822_addr_spec (const char **@var{p}, const char *@var{e}, address_t *@var{a}) 109 @deftypefun int mu_parse822_addr_spec (const char **@var{p}, const char *@var{e}, mu_address_t *@var{a})
110 @end deftypefun 110 @end deftypefun
111 111
112 @deftypefun int parse822_unix_mbox (const char **@var{p}, const char *@var{e}, address_t *@var{a}) 112 @deftypefun int mu_parse822_unix_mbox (const char **@var{p}, const char *@var{e}, mu_address_t *@var{a})
113 @end deftypefun 113 @end deftypefun
114 114
115 @deftypefun int parse822_local_part (const char **@var{p}, const char *@var{e}, char **@var{local_part}) 115 @deftypefun int mu_parse822_local_part (const char **@var{p}, const char *@var{e}, char **@var{local_part})
116 @end deftypefun 116 @end deftypefun
117 117
118 @deftypefun int parse822_domain (const char **@var{p}, const char *@var{e}, char **@var{domain}) 118 @deftypefun int mu_parse822_domain (const char **@var{p}, const char *@var{e}, char **@var{domain})
119 @end deftypefun 119 @end deftypefun
120 120
121 @deftypefun int parse822_sub_domain (const char **@var{p}, const char *@var{e}, char **@var{sub_domain}) 121 @deftypefun int mu_parse822_sub_domain (const char **@var{p}, const char *@var{e}, char **@var{sub_domain})
122 @end deftypefun 122 @end deftypefun
123 123
124 @deftypefun int parse822_domain_ref (const char **@var{p}, const char *@var{e}, char **@var{domain_ref}) 124 @deftypefun int mu_parse822_domain_ref (const char **@var{p}, const char *@var{e}, char **@var{domain_ref})
125 @end deftypefun 125 @end deftypefun
126 126
127 @deftypefun int parse822_domain_literal (const char **@var{p}, const char *@var{e}, char **@var{domain_literal}) 127 @deftypefun int mu_parse822_domain_literal (const char **@var{p}, const char *@var{e}, char **@var{domain_literal})
128 @end deftypefun 128 @end deftypefun
129 129
130 @c 130 @c
131 @c RFC 822 Quoting Functions 131 @c RFC 822 Quoting Functions
132 @c 132 @c
133 133
134 @deftypefun int parse822_quote_string (char **@var{quoted}, const char *@var{raw}) 134 @deftypefun int mu_parse822_quote_string (char **@var{quoted}, const char *@var{raw})
135 @end deftypefun 135 @end deftypefun
136 136
137 @deftypefun int parse822_quote_local_part (char **@var{quoted}, const char *@var{raw}) 137 @deftypefun int mu_parse822_quote_local_part (char **@var{quoted}, const char *@var{raw})
138 @end deftypefun 138 @end deftypefun
139 139
140 @deftypefun int parse822_field_body (const char **@var{p}, const char *@var{e}, char **@var{fieldbody}) 140 @deftypefun int mu_parse822_field_body (const char **@var{p}, const char *@var{e}, char **@var{fieldbody})
141 @end deftypefun 141 @end deftypefun
142 142
143 @deftypefun int parse822_field_name (const char **@var{p}, const char *@var{e}, char **@var{fieldname}) 143 @deftypefun int mu_parse822_field_name (const char **@var{p}, const char *@var{e}, char **@var{fieldname})
144 @end deftypefun 144 @end deftypefun
145 145
146 @c 146 @c
147 @c From RFC 822, 5.1 Date and Time Specification Syntax 147 @c From RFC 822, 5.1 Date and Time Specification Syntax
148 @c 148 @c
149 149
150 @deftypefun int parse822_day (const char **@var{p}, const char *@var{e}, int *@var{day}) 150 @deftypefun int mu_parse822_day (const char **@var{p}, const char *@var{e}, int *@var{day})
151 @end deftypefun 151 @end deftypefun
152 152
153 @deftypefun int parse822_date (const char **@var{p}, const char *@var{e}, int *@var{day}, int *@var{mon}, int *@var{year}) 153 @deftypefun int mu_parse822_date (const char **@var{p}, const char *@var{e}, int *@var{day}, int *@var{mon}, int *@var{year})
154 @end deftypefun 154 @end deftypefun
155 155
156 @deftypefun int parse822_time (const char **@var{p}, const char *@var{e}, int *@var{h}, int *@var{m}, int *@var{s}, int *@var{tz}, const char **@var{tz_name}) 156 @deftypefun int mu_parse822_time (const char **@var{p}, const char *@var{e}, int *@var{h}, int *@var{m}, int *@var{s}, int *@var{tz}, const char **@var{tz_name})
157 @end deftypefun 157 @end deftypefun
158 158
159 @deftypefun int parse822_date_time (const char **@var{p}, const char *@var{e}, struct tm *@var{tm}, mu_timezone *@var{tz}) 159 @deftypefun int mu_parse822_date_time (const char **@var{p}, const char *@var{e}, struct tm *@var{tm}, mu_timezone *@var{tz})
160 @end deftypefun 160 @end deftypefun
......
...@@ -4,7 +4,8 @@ ...@@ -4,7 +4,8 @@
4 @finalout 4 @finalout
5 5
6 @comment This is part of the GNU Mailutils manual. 6 @comment This is part of the GNU Mailutils manual.
7 @comment Copyright (C) 1999,2000,2001,2002,2003,2004 Free Software Foundation, Inc. 7 @comment Copyright (C) 1999,2000,2001,2002,2003,2004,2006
8 @comment Free Software Foundation, Inc.
8 @comment See file mailutils.texi for copying conditions. 9 @comment See file mailutils.texi for copying conditions.
9 @comment ******************************************************************* 10 @comment *******************************************************************
10 11
...@@ -80,7 +81,7 @@ default timeout to be ten minutes, many servers have shorter idle period, care s ...@@ -80,7 +81,7 @@ default timeout to be ten minutes, many servers have shorter idle period, care s
80 @code{mu_pop3_connect()}, two built-ins authentications are provided @code{mu_pop3_apop ()} or 81 @code{mu_pop3_connect()}, two built-ins authentications are provided @code{mu_pop3_apop ()} or
81 @code{mu_pop3_user()}/@code{mu_pop3_pass()}. The @code{mu_pop3_stat()} and @code{mu_pop3_list ()} functions can be use to 82 @code{mu_pop3_user()}/@code{mu_pop3_pass()}. The @code{mu_pop3_stat()} and @code{mu_pop3_list ()} functions can be use to
82 get the number and size of messages. The functions @code{mu_pop3_list_all()}, @code{mu_pop3_uidl_all ()} and 83 get the number and size of messages. The functions @code{mu_pop3_list_all()}, @code{mu_pop3_uidl_all ()} and
83 @code{mu_pop3_capa()} save the information in an @code{iterator_t}. Downloading of messages is done 84 @code{mu_pop3_capa()} save the information in an @code{mu_iterator_t}. Downloading of messages is done
84 via a two methods @code{mu_pop3_retr()} or @code{mu_pop3_top()}; 85 via a two methods @code{mu_pop3_retr()} or @code{mu_pop3_top()};
85 @strong{Caution: Some Internet Service Providers do not permit to leave mail on server and the message will be 86 @strong{Caution: Some Internet Service Providers do not permit to leave mail on server and the message will be
86 deleted once downloaded}. 87 deleted once downloaded}.
...@@ -174,7 +175,7 @@ Errors: ...@@ -174,7 +175,7 @@ Errors:
174 175
175 @cindex POP3 carrier 176 @cindex POP3 carrier
176 177
177 @deftypefun int mu_pop3_set_carrier (mu_pop3_t @var{pop3}, stream_t @var{carrier}) 178 @deftypefun int mu_pop3_set_carrier (mu_pop3_t @var{pop3}, mu_stream_t @var{carrier})
178 179
179 Set the stream to be use as the carrier to the server , for example tcp_stream. 180 Set the stream to be use as the carrier to the server , for example tcp_stream.
180 181
...@@ -225,7 +226,7 @@ Errors: ...@@ -225,7 +226,7 @@ Errors:
225 226
226 @cindex POP3 CAPA 227 @cindex POP3 CAPA
227 228
228 @deftypefun int mu_pop3_capa (mu_pop3_t @var{pop3}, iterator_t *@var{iterator}) 229 @deftypefun int mu_pop3_capa (mu_pop3_t @var{pop3}, mu_iterator_t *@var{iterator})
229 230
230 The CAPA command is send to the server and the list of capabilities is retrieve by going through 231 The CAPA command is send to the server and the list of capabilities is retrieve by going through
231 the iterator, when done the user should call @code{iterator_destroy()}. 232 the iterator, when done the user should call @code{iterator_destroy()}.
...@@ -287,7 +288,7 @@ Errors: ...@@ -287,7 +288,7 @@ Errors:
287 288
288 @cindex POP3 RETR 289 @cindex POP3 RETR
289 290
290 @deftypefun int mu_pop3_retr (mu_pop3_t @var{pop3}, unsigned @var{msgno}, stream_t *@var{stream}) 291 @deftypefun int mu_pop3_retr (mu_pop3_t @var{pop3}, unsigned @var{msgno}, mu_stream_t *@var{stream})
291 292
292 If successful @code{stream} should be call to download the message, byte-stuff lines or handle internally, CRLFs are 293 If successful @code{stream} should be call to download the message, byte-stuff lines or handle internally, CRLFs are
293 converted to LF. All other operations will fail until the downloaded is complete by the caller. 294 converted to LF. All other operations will fail until the downloaded is complete by the caller.
...@@ -308,13 +309,15 @@ Errors: ...@@ -308,13 +309,15 @@ Errors:
308 int 309 int
309 print_message (mu_pop3_t pop3, unsigned int msgno) 310 print_message (mu_pop3_t pop3, unsigned int msgno)
310 @{ 311 @{
311 stream_t stream; 312 mu_stream_t stream;
312 int status = mu_pop3_retr (pop3, msgno, &stream); 313 int status = mu_pop3_retr (pop3, msgno, &stream);
313 if (status == 0) 314 if (status == 0)
314 @{ 315 @{
315 size_t n = 0; 316 size_t n = 0;
316 char buf[128]; 317 char buf[128];
317 while ((status = stream_readline (stream, buf, sizeof buf, &n)) == 0) && n > 0) 318 while ((status = mu_stream_readline (stream,
319 buf, sizeof buf, &n)) == 0)
320 && n > 0)
318 @{ 321 @{
319 printf ("%s", buf); 322 printf ("%s", buf);
320 @} 323 @}
...@@ -325,7 +328,7 @@ print_message (mu_pop3_t pop3, unsigned int msgno) ...@@ -325,7 +328,7 @@ print_message (mu_pop3_t pop3, unsigned int msgno)
325 328
326 @cindex POP3 TOP 329 @cindex POP3 TOP
327 330
328 @deftypefun int mu_pop3_top (mu_pop3_t @var{pop3}, unsigned int @var{msgno}, unsigned int @var{lines}, stream_t *@var{stream}) 331 @deftypefun int mu_pop3_top (mu_pop3_t @var{pop3}, unsigned int @var{msgno}, unsigned int @var{lines}, mu_stream_t *@var{stream})
329 332
330 If successful @code{stream} should be call to download the header, byte-stuff lines or handle internally, CRLFs are 333 If successful @code{stream} should be call to download the header, byte-stuff lines or handle internally, CRLFs are
331 converted to LF. All other operations will failed until the operation is completed by the caller. 334 converted to LF. All other operations will failed until the operation is completed by the caller.
...@@ -345,13 +348,15 @@ Errors: ...@@ -345,13 +348,15 @@ Errors:
345 int 348 int
346 print_top (mu_pop3_t pop3, unsigned int msgno, unsigned int lines) 349 print_top (mu_pop3_t pop3, unsigned int msgno, unsigned int lines)
347 @{ 350 @{
348 stream_t stream; 351 mu_stream_t stream;
349 int status = mu_pop3_top (pop3, msgno, lines, &stream); 352 int status = mu_pop3_top (pop3, msgno, lines, &stream);
350 if (status == 0) 353 if (status == 0)
351 @{ 354 @{
352 size_t n = 0; 355 size_t n = 0;
353 char buf[128]; 356 char buf[128];
354 while ((status = stream_readline (stream, buf, sizeof buf, &n)) == 0) && n > 0) 357 while ((status = mu_stream_readline (stream, buf,
358 sizeof buf, &n)) == 0)
359 && n > 0)
355 printf ("%s", buf); 360 printf ("%s", buf);
356 @} 361 @}
357 return status; 362 return status;
...@@ -403,7 +408,7 @@ Errors: ...@@ -403,7 +408,7 @@ Errors:
403 @end table 408 @end table
404 @end deftypefun 409 @end deftypefun
405 410
406 @deftypefun int mu_pop3_uidl_all (mu_pop3_t @var{pop3}, iterator_t *@var{iterator}) 411 @deftypefun int mu_pop3_uidl_all (mu_pop3_t @var{pop3}, mu_iterator_t *@var{iterator})
407 412
408 A UIDL command is executed. The call should iterate through the @code{iterator} to fetch the response. 413 A UIDL command is executed. The call should iterate through the @code{iterator} to fetch the response.
409 414
...@@ -422,22 +427,24 @@ Errors: ...@@ -422,22 +427,24 @@ Errors:
422 427
423 void print_uidl (mu_pop3_t pop3) 428 void print_uidl (mu_pop3_t pop3)
424 @{ 429 @{
425 iterator_t itr; 430 mu_iterator_t itr;
426 status = mu_pop3_uidl_all (pop3, &itr); 431 status = mu_pop3_uidl_all (pop3, &itr);
427 if (status == 0) 432 if (status == 0)
428 @{ 433 @{
429 int rc; 434 int rc;
430 435
431 for (iterator_first (itr); !iterator_is_done (itr); iterator_next (itr)) 436 for (mu_iterator_first (itr);
437 !mu_iterator_is_done (itr);
438 mu_iterator_next (itr))
432 @{ 439 @{
433 char *text; 440 char *text;
434 441
435 rc = iterator_current (itr, (void**) &text); 442 rc = mu_iterator_current (itr, (void**) &text);
436 if (rc) 443 if (rc)
437 lperror ("iterator_current", rc); 444 lperror ("iterator_current", rc);
438 printf ("%s\n", text); 445 printf ("%s\n", text);
439 @} 446 @}
440 iterator_destroy (&itr); 447 mu_iterator_destroy (&itr);
441 @} 448 @}
442 449
443 @} 450 @}
......
1 @c This is part of the GNU Mailutils manual. 1 @c This is part of the GNU Mailutils manual.
2 @c Copyright (C) 1999,2000,2001,2002,2003,2004 Free Software Foundation, Inc. 2 @c Copyright (C) 1999,2000,2001,2002,2003,2004,2006
3 @c Free Software Foundation, Inc.
3 @c See file mailutils.texi for copying conditions. 4 @c See file mailutils.texi for copying conditions.
4 @comment ******************************************************************* 5 @comment *******************************************************************
5 6
6 @smallexample 7 @smallexample
7 @code{/* Prefix @emph{smtp_} is reserved */} 8 @code{/* Prefix @emph{mu_smtp_} is reserved */}
8 @code{#include <mailutils/smtp.h>} 9 @code{#include <mailutils/smtp.h>}
9 10
10 @end smallexample 11 @end smallexample
...@@ -12,86 +13,86 @@ ...@@ -12,86 +13,86 @@
12 Simple Mail Transfer Protocol. Not implemented. 13 Simple Mail Transfer Protocol. Not implemented.
13 14
14 @subsection Commands 15 @subsection Commands
15 @cindex smtp_t 16 @cindex mu_smtp_t
16 17
17 @subsubsection Initialization 18 @subsubsection Initialization
18 @cindex SMTP Initialization 19 @cindex SMTP Initialization
19 @deftypefun int smtp_create (smtp_t *) 20 @deftypefun int mu_smtp_create (mu_smtp_t *)
20 @end deftypefun 21 @end deftypefun
21 22
22 @deftypefun void smtp_destroy (smtp_t *) 23 @deftypefun void mu_smtp_destroy (mu_smtp_t *)
23 @end deftypefun 24 @end deftypefun
24 25
25 @deftypefun int smtp_open (smtp_t, const char *@var{host}, unsigned int @var{port}, int @var{flags}) 26 @deftypefun int mu_smtp_open (mu_smtp_t, const char *@var{host}, unsigned int @var{port}, int @var{flags})
26 @end deftypefun 27 @end deftypefun
27 28
28 29
29 @subsubsection Data 30 @subsubsection Data
30 @cindex SMTP Data 31 @cindex SMTP Data
31 @deftypefun int smtp_data (smtp_t, stream_t @var{stream}) 32 @deftypefun int mu_smtp_data (mu_smtp_t, stream_t @var{stream})
32 @end deftypefun 33 @end deftypefun
33 34
34 @subsubsection Helo 35 @subsubsection Helo
35 @cindex SMTP Helo 36 @cindex SMTP Helo
36 @deftypefun int smtp_helo (smtp_t, const char *@var{domain}) 37 @deftypefun int mu_smtp_helo (mu_smtp_t, const char *@var{domain})
37 @end deftypefun 38 @end deftypefun
38 39
39 @deftypefun int smtp_ehlo (smtp_t, const char *@var{domain}) 40 @deftypefun int mu_smtp_ehlo (mu_smtp_t, const char *@var{domain})
40 @end deftypefun 41 @end deftypefun
41 42
42 @subsubsection Expn 43 @subsubsection Expn
43 @cindex SMTP Expn 44 @cindex SMTP Expn
44 @deftypefun int smtp_expn (smtp_t, const char *@var{list}, iterator_t *) 45 @deftypefun int mu_smtp_expn (mu_smtp_t, const char *@var{list}, iterator_t *)
45 @end deftypefun 46 @end deftypefun
46 47
47 @subsubsection Help 48 @subsubsection Help
48 @cindex SMTP Help 49 @cindex SMTP Help
49 @deftypefun int smtp_help (smtp_t, const char *@var{help}, iterator_t *) 50 @deftypefun int mu_smtp_help (mu_smtp_t, const char *@var{help}, iterator_t *)
50 @end deftypefun 51 @end deftypefun
51 52
52 @subsubsection Mail From 53 @subsubsection Mail From
53 @cindex SMTP Mail From 54 @cindex SMTP Mail From
54 @deftypefun int smtp_mail_from (smtp_t, const char *@var{address}, const char *@var{param}) 55 @deftypefun int mu_smtp_mail_from (mu_smtp_t, const char *@var{address}, const char *@var{param})
55 @end deftypefun 56 @end deftypefun
56 57
57 @subsubsection Noop 58 @subsubsection Noop
58 @cindex SMTP Noop 59 @cindex SMTP Noop
59 @deftypefun int smtp_noop (smtp_t) 60 @deftypefun int mu_smtp_noop (mu_smtp_t)
60 @end deftypefun 61 @end deftypefun
61 62
62 @subsubsection Quit 63 @subsubsection Quit
63 @cindex SMTP Quit 64 @cindex SMTP Quit
64 @deftypefun int smtp_quit (smtp_t) 65 @deftypefun int mu_smtp_quit (mu_smtp_t)
65 @end deftypefun 66 @end deftypefun
66 67
67 @subsubsection Recpt To 68 @subsubsection Recpt To
68 @cindex SMTP Recpt To 69 @cindex SMTP Recpt To
69 @deftypefun int smtp_rcpt_to (smtp_t, const char *@var{address}, const char *@var{param}) 70 @deftypefun int mu_smtp_rcpt_to (mu_smtp_t, const char *@var{address}, const char *@var{param})
70 @end deftypefun 71 @end deftypefun
71 72
72 @subsubsection Reset 73 @subsubsection Reset
73 @cindex SMTP Reset 74 @cindex SMTP Reset
74 @deftypefun int smtp_reset (smtp_t) 75 @deftypefun int mu_smtp_reset (mu_smtp_t)
75 @end deftypefun 76 @end deftypefun
76 77
77 @subsubsection Verify 78 @subsubsection Verify
78 @cindex SMTP Verify 79 @cindex SMTP Verify
79 @deftypefun int smtp_verify (smtp_t, const char *@var{user}) 80 @deftypefun int mu_smtp_verify (mu_smtp_t, const char *@var{user})
80 @end deftypefun 81 @end deftypefun
81 82
82 @subsubsection Help functions 83 @subsubsection Help functions
83 @cindex SMTP Help functions 84 @cindex SMTP Help functions
84 @deftypefun extern int smtp_readline (smtp_t, char *@var{buffer}, size_t @var{len}, size_t *@var{len}) 85 @deftypefun extern int mu_smtp_readline (mu_smtp_t, char *@var{buffer}, size_t @var{len}, size_t *@var{len})
85 @end deftypefun 86 @end deftypefun
86 87
87 @deftypefun extern int smtp_response (smtp_t, char *@var{buffer}, size_t @var{len}, size_t *@var{len}) 88 @deftypefun extern int mu_smtp_response (mu_smtp_t, char *@var{buffer}, size_t @var{len}, size_t *@var{len})
88 @end deftypefun 89 @end deftypefun
89 90
90 @deftypefun extern int smtp_writeline (smtp_t, const char *@var{format}, @var{...}) 91 @deftypefun extern int mu_smtp_writeline (mu_smtp_t, const char *@var{format}, @var{...})
91 @end deftypefun 92 @end deftypefun
92 93
93 @deftypefun extern int smtp_sendline (smtp_t, const char *@var{line}) 94 @deftypefun extern int mu_smtp_sendline (mu_smtp_t, const char *@var{line})
94 @end deftypefun 95 @end deftypefun
95 96
96 @deftypefun extern int smtp_send (smtp_t 97 @deftypefun extern int mu_smtp_send (mu_smtp_t)
97 @end deftypefun 98 @end deftypefun
......
1 @c This is part of the GNU Mailutils manual. 1 @c This is part of the GNU Mailutils manual.
2 @c Copyright (C) 1999,2000,2001,2002,2003,2004 Free Software Foundation, Inc. 2 @c Copyright (C) 1999,2000,2001,2002,2003,2004,2006
3 @c Free Software Foundation, Inc.
3 @c See file mailutils.texi for copying conditions. 4 @c See file mailutils.texi for copying conditions.
4 @comment ******************************************************************* 5 @comment *******************************************************************
5 6
...@@ -111,15 +112,15 @@ For more complete information see @cite{RFC 2368}. ...@@ -111,15 +112,15 @@ For more complete information see @cite{RFC 2368}.
111 112
112 Helper functions are provided to retrieve and set the @emph{URL} fields. 113 Helper functions are provided to retrieve and set the @emph{URL} fields.
113 114
114 @deftypefun int url_create (url_t *@var{url}, const char *@var{name}) 115 @deftypefun int mu_url_create (mu_url_t *@var{url}, const char *@var{name})
115 Create the url data structure, but do not parse it. 116 Create the url data structure, but do not parse it.
116 @end deftypefun 117 @end deftypefun
117 118
118 @deftypefun void url_destroy (url_t *@var{url}) 119 @deftypefun void mu_url_destroy (mu_url_t *@var{url})
119 Destroy the url and free its resources. 120 Destroy the url and free its resources.
120 @end deftypefun 121 @end deftypefun
121 122
122 @deftypefun int url_parse (url_t) 123 @deftypefun int mu_url_parse (mu_url_t)
123 Parses the url, after calling this the get functions can be called. 124 Parses the url, after calling this the get functions can be called.
124 125
125 The syntax, condensed from @cite{RFC 1738}, and extended with the ;auth= 126 The syntax, condensed from @cite{RFC 1738}, and extended with the ;auth=
...@@ -142,58 +143,58 @@ This is a generalized URL syntax, and may not be exactly appropriate ...@@ -142,58 +143,58 @@ This is a generalized URL syntax, and may not be exactly appropriate
142 for any particular scheme. 143 for any particular scheme.
143 @end deftypefun 144 @end deftypefun
144 145
145 @deftypefun int url_get_scheme (const url_t, char *, size_t, size_t *) 146 @deftypefun int mu_url_get_scheme (const mu_url_t, char *, size_t, size_t *)
146 @end deftypefun 147 @end deftypefun
147 148
148 @deftypefun int url_get_user (const url_t, char *, size_t, size_t *) 149 @deftypefun int mu_url_get_user (const mu_url_t, char *, size_t, size_t *)
149 @end deftypefun 150 @end deftypefun
150 151
151 @deftypefun int url_get_passwd (const url_t, char *, size_t, size_t *) 152 @deftypefun int mu_url_get_passwd (const mu_url_t, char *, size_t, size_t *)
152 @end deftypefun 153 @end deftypefun
153 154
154 @deftypefun int url_get_auth (const url_t, char *, size_t, size_t *) 155 @deftypefun int mu_url_get_auth (const mu_url_t, char *, size_t, size_t *)
155 @end deftypefun 156 @end deftypefun
156 157
157 @deftypefun int url_get_host (const url_t, char *, size_t, size_t *) 158 @deftypefun int mu_url_get_host (const mu_url_t, char *, size_t, size_t *)
158 @end deftypefun 159 @end deftypefun
159 160
160 @deftypefun int url_get_port (const url_t, long *) 161 @deftypefun int mu_url_get_port (const mu_url_t, long *)
161 @end deftypefun 162 @end deftypefun
162 163
163 @deftypefun int url_get_path (const url_t, char *, size_t, size_t *) 164 @deftypefun int mu_url_get_path (const mu_url_t, char *, size_t, size_t *)
164 @end deftypefun 165 @end deftypefun
165 166
166 @deftypefun int url_get_query (const url_t, char *, size_t, size_t *) 167 @deftypefun int mu_url_get_query (const mu_url_t, char *, size_t, size_t *)
167 @end deftypefun 168 @end deftypefun
168 169
169 @deftypefun {const char*} url_to_string (const url_t) 170 @deftypefun {const char*} mu_url_to_string (const mu_url_t)
170 @end deftypefun 171 @end deftypefun
171 172
172 @deftypefun int url_is_scheme (url_t, const char *@var{scheme}) 173 @deftypefun int mu_url_is_scheme (mu_url_t, const char *@var{scheme})
173 @end deftypefun 174 @end deftypefun
174 175
175 @deftypefun int url_is_same_scheme (url_t, url_t) 176 @deftypefun int mu_url_is_same_scheme (mu_url_t, mu_url_t)
176 @end deftypefun 177 @end deftypefun
177 178
178 @deftypefun int url_is_same_user (url_t, url_t) 179 @deftypefun int mu_url_is_same_user (mu_url_t, mu_url_t)
179 @end deftypefun 180 @end deftypefun
180 181
181 @deftypefun int url_is_same_path (url_t, url_t) 182 @deftypefun int mu_url_is_same_path (mu_url_t, mu_url_t)
182 @end deftypefun 183 @end deftypefun
183 184
184 @deftypefun int url_is_same_host (url_t, url_t) 185 @deftypefun int mu_url_is_same_host (mu_url_t, mu_url_t)
185 @end deftypefun 186 @end deftypefun
186 187
187 @deftypefun int url_is_same_port (url_t, url_t) 188 @deftypefun int mu_url_is_same_port (mu_url_t, mu_url_t)
188 @end deftypefun 189 @end deftypefun
189 190
190 @deftypefun char* url_decode (const char *@var{string}) 191 @deftypefun {char *} mu_url_decode (const char *@var{string})
191 Decodes an @cite{RFC 1738} encoded string, returning the decoded string 192 Decodes an @cite{RFC 1738} encoded string, returning the decoded string
192 in allocated memory. If the string is not encoded, this degenerates to 193 in allocated memory. If the string is not encoded, this degenerates to
193 a @code{strdup()}. 194 a @code{strdup()}.
194 @end deftypefun 195 @end deftypefun
195 196
196 @deftypefun int url_is_ticket (url_t @var{ticket}, url_t @var{url}) 197 @deftypefun int mu_url_is_ticket (mu_url_t @var{ticket}, mu_url_t @var{url})
197 @end deftypefun 198 @end deftypefun
198 199
199 @subsubheading Example 200 @subsubheading Example
......