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