Commit f4d56536 f4d56536fd6645f1f6b4f2b97f2c57c031efa81b by Alain Magloire

body.texi mailbox.texi mailer.texi url.texi

ispell.
1 parent ffe2be32
1 The @code{body_t} type contains a @code{header_t}, a content and 1 The @code{body_t} type contains a @code{header_t}, a content and
2 optionnaly another @code{body_t} part. 2 optionally another @code{body_t} part.
3 3
4 @section Init/Destroy 4 @section Init/Destroy
5 5
...@@ -8,11 +8,11 @@ Initialize an object @var{bdy}. ...@@ -8,11 +8,11 @@ Initialize an object @var{bdy}.
8 @end deftypefun 8 @end deftypefun
9 9
10 @deftypefun void body_destroy (body_t *@var{bdy}) 10 @deftypefun void body_destroy (body_t *@var{bdy})
11 The ressources allocate are @var{bdy} freed. 11 The resources allocate are @var{bdy} freed.
12 @end deftypefun 12 @end deftypefun
13 13
14 @section Attributes 14 @section Attributes
15 The body can cary header attributes if it is a mime. They also come 15 The body can carry header attributes if it is a mime. They also come
16 with the matching "set". 16 with the matching "set".
17 17
18 @deftypefun int body_get_header (body_t @var{bdy}, header_t *@var{hdr}) 18 @deftypefun int body_get_header (body_t @var{bdy}, header_t *@var{hdr})
...@@ -24,7 +24,7 @@ with the matching "set". ...@@ -24,7 +24,7 @@ with the matching "set".
24 @deftypefun int body_get_content_encoding (body_t @var{bdy}, char *@var{type}, size_t @var{len}) 24 @deftypefun int body_get_content_encoding (body_t @var{bdy}, char *@var{type}, size_t @var{len})
25 @end deftypefun 25 @end deftypefun
26 26
27 @section Attachements 27 @section Attachments
28 28
29 @deftypefun int body_set_filename (body_t @var{bdy}, char *file) 29 @deftypefun int body_set_filename (body_t @var{bdy}, char *file)
30 Associate the body with a @var{file}. 30 Associate the body with a @var{file}.
......
1 Mail boxes come in different formats and may be on a remote hosts, 1 Mail boxes come in different formats and may be on a remote hosts,
2 only accessible through Mail Delivery Agent(MDA). Regardeless 2 only accessible through Mail Delivery Agent(MDA). Regardless
3 of the format and the protocol use, some common actions are needed like 3 of the format and the protocol use, some common actions are needed like
4 reading, saving, deleting, scanning ... Those actions are provided via a 4 reading, saving, deleting, scanning ... Those actions are provided via a
5 unify API mailbox_t. 5 unify API mailbox_t.
6 6
7 All functions of the mailbox_t API return 0 if succesfull or non-zero 7 All functions of the mailbox_t API return 0 if successful or non-zero
8 for failure, unless specify otherwise. 8 for failure, unless specify otherwise.
9 9
10 @section Init/Destroy 10 @section Init/Destroy
...@@ -48,7 +48,7 @@ mailbox_init_default (&mbx, NULL); ...@@ -48,7 +48,7 @@ mailbox_init_default (&mbx, NULL);
48 @end deftypefun 48 @end deftypefun
49 49
50 @deftypefun int mailbox_destroy (mailbox_t *@var{mbx}) 50 @deftypefun int mailbox_destroy (mailbox_t *@var{mbx})
51 All ressources allocated are release. If the stream is not open, 51 All resources allocated are release. If the stream is not open,
52 @code{mailbox_close} is call. 52 @code{mailbox_close} is call.
53 @end deftypefun 53 @end deftypefun
54 54
...@@ -58,7 +58,7 @@ on some cases like POP3, when opening, the lock can be persistent until ...@@ -58,7 +58,7 @@ on some cases like POP3, when opening, the lock can be persistent until
58 the stream is closed as required by the RFC. 58 the stream is closed as required by the RFC.
59 59
60 @deftypefun int mailbox_open (mailbox_t @var{mbx}, int @var{flag}) 60 @deftypefun int mailbox_open (mailbox_t @var{mbx}, int @var{flag})
61 Open the mailbox box stream. This funtion will call @code{mailbox_scan}. 61 Open the mailbox box stream. This function will call @code{mailbox_scan}.
62 62
63 @defmac MU_MB_RDONLY 63 @defmac MU_MB_RDONLY
64 Stream is open read-only. 64 Stream is open read-only.
...@@ -106,7 +106,7 @@ main () ...@@ -106,7 +106,7 @@ main ()
106 106
107 if (mailbox_init_default (&mbx, NULL) != 0) 107 if (mailbox_init_default (&mbx, NULL) != 0)
108 @{ 108 @{
109 fprintf ("Can't initiliaze system mailbox\n"); 109 fprintf ("Can't initialize system mailbox\n");
110 exit (EXIT_FAILURE); 110 exit (EXIT_FAILURE);
111 @} 111 @}
112 /* the open may fail if no mailbox was created, 112 /* the open may fail if no mailbox was created,
...@@ -158,7 +158,7 @@ Mark message @var{msgno} for deletion. ...@@ -158,7 +158,7 @@ Mark message @var{msgno} for deletion.
158 @end deftypefun 158 @end deftypefun
159 159
160 @deftypefun int mailbox_undelete (mailbox_t @var{mbx}, size_t @var{msgno}) 160 @deftypefun int mailbox_undelete (mailbox_t @var{mbx}, size_t @var{msgno})
161 UnMark message @var{msgno} for deletion. 161 Unmark message @var{msgno} for deletion.
162 @end deftypefun 162 @end deftypefun
163 163
164 @deftypefun int mailbox_is_deleted (mailbox_t @var{mbx}, size_t @var{msgno}) 164 @deftypefun int mailbox_is_deleted (mailbox_t @var{mbx}, size_t @var{msgno})
...@@ -192,7 +192,7 @@ If @var{destroy} is set non-zero @code{message_destroy} will be call after deliv ...@@ -192,7 +192,7 @@ If @var{destroy} is set non-zero @code{message_destroy} will be call after deliv
192 192
193 @deftypefun int mailbox_get_message (mailbox_t @var{mbx}, size_t @var{msgno}, message_t *@var{msg}) 193 @deftypefun int mailbox_get_message (mailbox_t @var{mbx}, size_t @var{msgno}, message_t *@var{msg})
194 @var{msg} is initialize, be warn when doing @code{mailbox_expunge} the 194 @var{msg} is initialize, be warn when doing @code{mailbox_expunge} the
195 offsets to the mailbox are losts and accessing the @var{msg} is undefined. 195 offsets to the mailbox are lost and accessing the @var{msg} is undefined.
196 To prevent this, it is possible to @code{message_clone} or set a notification 196 To prevent this, it is possible to @code{message_clone} or set a notification
197 to take appropriate action. 197 to take appropriate action.
198 @end deftypefun 198 @end deftypefun
...@@ -203,7 +203,7 @@ this @var{msg} are executed. ...@@ -203,7 +203,7 @@ this @var{msg} are executed.
203 @end deftypefun 203 @end deftypefun
204 204
205 @section Reading Contents/Headers 205 @section Reading Contents/Headers
206 Low level Reading funtions for contents and headers. 206 Low level Reading functions for contents and headers.
207 207
208 @comment @deftypefun int mailbox_set_header (mailbox_t @var{mbx}, size_t @var{msgno}, const char *@var{header}, size_t @var{len}, int @var{replace}) 208 @comment @deftypefun int mailbox_set_header (mailbox_t @var{mbx}, size_t @var{msgno}, const char *@var{header}, size_t @var{len}, int @var{replace})
209 @comment Fill the header of new message @var{msgno}. If @var{replace} is zero the 209 @comment Fill the header of new message @var{msgno}. If @var{replace} is zero the
...@@ -245,8 +245,8 @@ Most mailboxes will lock before changing their contents. External usage of ...@@ -245,8 +245,8 @@ Most mailboxes will lock before changing their contents. External usage of
245 those functions are discourage, since they may interfere with normal 245 those functions are discourage, since they may interfere with normal
246 operation and cause deadlocks. If however there is need to access the 246 operation and cause deadlocks. If however there is need to access the
247 mailbox outside the functions provided by the library, locking and unlocking 247 mailbox outside the functions provided by the library, locking and unlocking
248 can be done explicitely. There is another level of internal 248 can be done explicitly. There is another level of internal
249 locking to provide synchronisation to the mailbox_t object. 249 locking to provide synchronization to the mailbox_t object.
250 250
251 @deftypefun int mailbox_lock (mailbox_t @var{mbx}, int @var{flag}) 251 @deftypefun int mailbox_lock (mailbox_t @var{mbx}, int @var{flag})
252 Grab the lock. In some cases, i.e Unix mbox this may involve creating 252 Grab the lock. In some cases, i.e Unix mbox this may involve creating
...@@ -287,7 +287,7 @@ Set the file permission to @var{mode}. If the Mailbox was not ...@@ -287,7 +287,7 @@ Set the file permission to @var{mode}. If the Mailbox was not
287 287
288 @section Scanning 288 @section Scanning
289 289
290 Scan is done implicitely on @code{mailbox_open}. 290 Scan is done implicitly on @code{mailbox_open}.
291 291
292 @deftypefun int mailbox_scan (mailbox_t @var{mbx}, size_t *@var{msgs}) 292 @deftypefun int mailbox_scan (mailbox_t @var{mbx}, size_t *@var{msgs})
293 The mailbox is parse and @var{msgs} if not NULL contain the message count. 293 The mailbox is parse and @var{msgs} if not NULL contain the message count.
...@@ -303,7 +303,7 @@ A notification function can be set to monitor progress. ...@@ -303,7 +303,7 @@ A notification function can be set to monitor progress.
303 Return 1 if @var{mbx} is up to date 0 otherwise. 303 Return 1 if @var{mbx} is up to date 0 otherwise.
304 @end deftypefun 304 @end deftypefun
305 305
306 @deftypefun int mailbox_size (mailbox_t @var{mbx}, offt_t *@var{size}) 306 @deftypefun int mailbox_size (mailbox_t @var{mbx}, off_t *@var{size})
307 @var{size} is assign the mailbox total size. 307 @var{size} is assign the mailbox total size.
308 @end deftypefun 308 @end deftypefun
309 309
...@@ -346,7 +346,7 @@ function is called, @code{notification (mbx, arg)}. Not Implemented. ...@@ -346,7 +346,7 @@ function is called, @code{notification (mbx, arg)}. Not Implemented.
346 When parsing the mailbox every count call @code{notification (msgcount, arg)}. 346 When parsing the mailbox every count call @code{notification (msgcount, arg)}.
347 Note that all locks are held, and @var{notification} should be very small and 347 Note that all locks are held, and @var{notification} should be very small and
348 simple, it should not access or do any action on the mailbox doing this may 348 simple, it should not access or do any action on the mailbox doing this may
349 cause undefined behaviour. 349 cause undefined behavior.
350 @end deftypefun 350 @end deftypefun
351 @deftypefun int mailbox_set_msg_destroy_cb (mailbox_t @var{mbx}, int (*@var{notification}) (mailbox_t @var{mbx}, message_t @var{msg}, void *@var{arg})) 351 @deftypefun int mailbox_set_msg_destroy_cb (mailbox_t @var{mbx}, int (*@var{notification}) (mailbox_t @var{mbx}, message_t @var{msg}, void *@var{arg}))
352 @end deftypefun 352 @end deftypefun
...@@ -460,7 +460,7 @@ locking policy, appending envelope, describe the flags use in _open(..), etc... ...@@ -460,7 +460,7 @@ locking policy, appending envelope, describe the flags use in _open(..), etc...
460 @cindex POP3 Mbox 460 @cindex POP3 Mbox
461 461
462 TODO: describe timeout policies, describe the flags use in _open(..), 462 TODO: describe timeout policies, describe the flags use in _open(..),
463 describe different authorisation supported. 463 describe different authorization supported.
464 464
465 @section IMAP Mbox 465 @section IMAP Mbox
466 @cindex IMAP Mbox 466 @cindex IMAP Mbox
......
...@@ -9,7 +9,7 @@ Initialize the mailer object. ...@@ -9,7 +9,7 @@ Initialize the mailer object.
9 Not Implemented. 9 Not Implemented.
10 10
11 @defmac MU_ML_PROGRAM 11 @defmac MU_ML_PROGRAM
12 Program like sendmail, mail, mailx to deliver the mail 12 Program like Sendmail, mail, mailx to deliver the mail
13 @end defmac 13 @end defmac
14 14
15 @defmac MU_ML_SMTP 15 @defmac MU_ML_SMTP
...@@ -29,7 +29,7 @@ Not Implemented. ...@@ -29,7 +29,7 @@ Not Implemented.
29 @section Open/Close 29 @section Open/Close
30 30
31 @deftypefun int mailer_open (mailer_t @var{mailer}, int @var{flag}) 31 @deftypefun int mailer_open (mailer_t @var{mailer}, int @var{flag})
32 On mailer program, it is a @code{stat(2)} or ping a server for smtp. 32 On mailer program, it is a @code{stat(2)} or ping a server for SMTP.
33 @end deftypefun 33 @end deftypefun
34 @deftypefun int mailer_close (mailer_t @var{mailer}) 34 @deftypefun int mailer_close (mailer_t @var{mailer})
35 Noop on most mailers. 35 Noop on most mailers.
...@@ -56,12 +56,12 @@ executed. ...@@ -56,12 +56,12 @@ executed.
56 @section SMTP 56 @section SMTP
57 @cindex SMTP 57 @cindex SMTP
58 58
59 TODO: describe protocol, url, mailto url etc .. 59 TODO: describe protocol, URL, mailto URL etc ..
60 60
61 @section UUCP 61 @section UUCP
62 @cindex UUCP 62 @cindex UUCP
63 63
64 Yeurk ! It this to old ? Is it worth it ? 64 ! It this to old ? Is it worth it ?
65 65
66 @section Program 66 @section Program
67 @cindex Sendmail 67 @cindex Sendmail
......
...@@ -5,8 +5,8 @@ necessary information to initialize @code{mailbox_t}, or @code{mailer_t} ...@@ -5,8 +5,8 @@ necessary information to initialize @code{mailbox_t}, or @code{mailer_t}
5 properly. 5 properly.
6 6
7 @section POP3 7 @section POP3
8 The POP URL scheme contains a pop server, optionnal port number 8 The POP URL scheme contains a pop server, optional port number
9 and the authentication mechanism. The genereal form is 9 and the authentication mechanism. The general form is
10 10
11 @example 11 @example
12 @url{pop://user;AUTH=type@@hostname:port} 12 @url{pop://user;AUTH=type@@hostname:port}
...@@ -33,7 +33,7 @@ Description of the fields and examples are needed. ...@@ -33,7 +33,7 @@ Description of the fields and examples are needed.
33 @section File 33 @section File
34 34
35 Local folder should be handle by this URL. It is preferable to let 35 Local folder should be handle by this URL. It is preferable to let
36 the mailbox recognise the type of mailbox and take the appropriate 36 the mailbox recognize the type of mailbox and take the appropriate
37 action. 37 action.
38 38
39 @example 39 @example
...@@ -42,7 +42,7 @@ action. ...@@ -42,7 +42,7 @@ action.
42 @url{file://home/obelix/Mail} 42 @url{file://home/obelix/Mail}
43 @end example 43 @end example
44 44
45 For MMDF, MH local mailboxes urls are provided, but it is preferable to 45 For MMDF, MH local mailboxes URLs are provided, but it is preferable to
46 use @url{file://path} and let the library figure out which one. 46 use @url{file://path} and let the library figure out which one.
47 47
48 @example 48 @example
...@@ -67,9 +67,9 @@ to mailing lists. ...@@ -67,9 +67,9 @@ to mailing lists.
67 67
68 For more complete information see @cite{rfc2368}. 68 For more complete information see @cite{rfc2368}.
69 69
70 @section URL funtions 70 @section URL functions
71 71
72 Helper functions are provided to retreive and set the @emph{URL} fields. 72 Helper functions are provided to retrieve and set the @emph{URL} fields.
73 73
74 @deftypefun int url_init (url_t *@var{url}, const char *name) 74 @deftypefun int url_init (url_t *@var{url}, const char *name)
75 Initialize and parse the @var{url} 75 Initialize and parse the @var{url}
......