Commit 17659c7a 17659c7a2935bbe3af85817b0227b24a9fe23178 by Alain Magloire

new API.

1 parent 617eeb6c
......@@ -80,7 +80,7 @@ default timeout to be ten minutes, many servers have shorter idle period, care s
@code{mu_pop3_connect()}, two built-ins authentications are provided @code{mu_pop3_apop ()} or
@code{mu_pop3_user()}/@code{mu_pop3_pass()}. The @code{mu_pop3_stat()} and @code{mu_pop3_list ()} functions can be use to
get the number and size of messages. The functions @code{mu_pop3_list_all()}, @code{mu_pop3_uidl_all ()} and
@code{mu_pop3_capa()} save the information in a @code{list_t}. Downloading of messages is done
@code{mu_pop3_capa()} save the information in an @code{iterator_t}. Downloading of messages is done
via a two methods @code{mu_pop3_retr()} or @code{mu_pop3_top()};
@strong{Caution: Some Internet Service Providers do not permit to leave mail on server and the message will be
deleted once downloaded}.
......@@ -225,9 +225,10 @@ Errors:
@cindex POP3 CAPA
@deftypefun int mu_pop3_capa (mu_pop3_t @var{pop3})
@deftypefun int mu_pop3_capa (mu_pop3_t @var{pop3}, iterator_t *@var{iterator})
The CAPA command is send to the sever and the list of capabilities is retrieve by calling @code{mu_pop3_capa_iterate()}.
The CAPA command is send to the server and the list of capabilities is retrieve by going through
the iterator, when done the user should call @code{iterator_destroy()}.
Errors:
@table @code
......@@ -402,9 +403,9 @@ Errors:
@end table
@end deftypefun
@deftypefun int mu_pop3_uidl_all (mu_pop3_t @var{pop3}, list_t *@var{list})
@deftypefun int mu_pop3_uidl_all (mu_pop3_t @var{pop3}, iterator_t *@var{iterator})
A UIDL command is executed. The call should iterate through the @code{list} to fetch the response.
A UIDL command is executed. The call should iterate through the @code{iterator} to fetch the response.
Errors:
@table @code
......@@ -421,17 +422,12 @@ Errors:
void print_uidl (mu_pop3_t pop3)
@{
list_t list;
status = mu_pop3_uidl_all (pop3, &list);
iterator_t itr;
status = mu_pop3_uidl_all (pop3, &itr);
if (status == 0)
@{
iterator_t itr;
int rc;
rc = iterator_create (&itr, list);
if (rc)
lperror ("iterator_create", rc);
for (iterator_first (itr); !iterator_is_done (itr); iterator_next (itr))
@{
char *text;
......@@ -442,7 +438,6 @@ void print_uidl (mu_pop3_t pop3)
printf ("%s\n", text);
@}
iterator_destroy (&itr);
list_destroy(&list);
@}
@}
......