Commit c5fe2fd2 c5fe2fd2670a170f0f907cef692297f49bcdf596 by Alain Magloire

A bunch of typo correction from Thomas.

1 parent 2e878c30
@example
@code{/* Prefix @emph{address_} is reserve */}
@code{/* Prefix @emph{address_} is reserved */}
@code{#include <mailutils/address.h>}
@end example
......@@ -91,7 +91,7 @@ The @var{addr} is destroyed.
@deftypefun int address_get_email (address_t *@var{addr}, size_t @var{no}, char* @var{buf}, size_t @var{len}, size_t* @var{n})
Acesses the @var{no}th email address component of the address list. This
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
a contact book entry.
......@@ -105,7 +105,7 @@ The return value is @code{0} on success and a code number on error conditions:
@deftypefun int address_get_personal (address_t *@var{addr}, size_t @var{no}, char* @var{buf}, size_t @var{len}, size_t* @var{n})
Acesses the display-name describing the @var{no}th email address. This
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
returned as the personal phrase, as this is a common usage of the comment
......@@ -127,7 +127,7 @@ The return value is @code{0} on success and a code number on error conditions:
@deftypefun int address_get_comments (address_t *@var{addr}, size_t @var{no}, char* @var{buf}, size_t @var{len}, size_t* @var{n})
Acesses the comments extracted while parsing the @var{no}th email address.
Accesses the comments extracted while parsing the @var{no}th email address.
These comments have no defined meaning, and are not currently collected.
The return value is @code{0} on success and a code number on error conditions:
......@@ -140,7 +140,7 @@ The return value is @code{0} on success and a code number on error conditions:
@deftypefun int address_get_email (address_t *@var{addr}, size_t @var{no}, char* @var{buf}, size_t @var{len}, size_t* @var{n})
Acesses the email addr-spec extracted while
Accesses the email addr-spec extracted while
parsing the @var{no}th email address. This will be @code{0}
length for a unix-mbox.
......@@ -153,7 +153,7 @@ The return value is @code{0} on success and a code number on error conditions:
@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})
Acesses the local-part of an email addr-spec extracted while
Accesses the local-part of an email addr-spec extracted while
parsing the @var{no}th email address.
The return value is @code{0} on success and a code number on error conditions:
......@@ -165,7 +165,7 @@ The return value is @code{0} on success and a code number on error conditions:
@deftypefun int address_get_domain (address_t *@var{addr}, size_t @var{no}, char* @var{buf}, size_t @var{len}, size_t* @var{n})
Acesses the domain of an email addr-spec extracted while
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.
......@@ -178,7 +178,7 @@ The return value is @code{0} on success and a code number on error conditions:
@deftypefun int address_get_route (address_t *@var{addr}, size_t @var{no}, char* @var{buf}, size_t @var{len}, size_t* @var{n})
Acesses the route of an email addr-spec extracted while
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
a string, those wishing to parse it should look at <mailutils/parse822.h>.
......
@example
@code{/* Prefix @emph{attribute_} is reserve */}
@code{/* Prefix @emph{attribute_} is reserved */}
@code{#include <mailutils/attribute.h>}
@end example
......
@example
@code{/* Prefix @emph{auth_} is reserve */}
@code{/* Prefix @emph{auth_} is reserved */}
@code{#include <mailutils/auth.h>}
@end example
There are many ways to authenticate to a server, to be flexible the
There are many ways to authenticate to a server. To be flexible the
authentication process is provided by two objects @code{auth_t} and
@code{ticket_t}. The @code{auth_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 away to
user/passwd authentication. The @code{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 function
@code{auth_authenticate} who will get the @emph{user} and @emph{passwd}
if not set, this function can be override by a custom method.
contain enough information. The default action is to call the function
@code{auth_authenticate} which will get the @emph{user} and @emph{passwd}
if not set, this function can be overriden by a custom method.
@deftypefun int auth_create (auth_t *@var{pauth}, void *@var{owner})
@end deftypefun
......
@example
@code{/* Prefix @emph{body_} is reserve */}
@code{/* Prefix @emph{body_} is reserved */}
@code{#include <mailutils/body.h>}
@end example
......
@example
@code{/* Prefix @emph{envelope_} is reserve */}
@code{/* Prefix @emph{envelope_} is reserved */}
@code{#include <mailutils/envelope.h>}
@end example
......
......@@ -16,10 +16,10 @@
@end menu
Where ever the mail is and whatever format it is store in, the same operations
Whereever the mail is and whatever format it is stored in, the same operations
to manipulate emails are common. To unified the C API, GNU mailutils offers
an heteroclite set of objects that work in aggregation to do operations on
emails. Each object do a specific task and delegate non related tasks to
a heteroclite set of objects that work in aggregation to do operations on
emails. Each object do a specific task and delegates non related tasks to
others. The object comes alive by specifying a @emph{URL} parameter when
created, it will indicate the storage format or protocol
(POP3, IMAP4, MH, MAILDIR, etc ..).
......
@example
@code{/* Prefix @emph{header_} is reserve */}
@code{/* Prefix @emph{header_} is reserved */}
@code{#include <mailutils/header.h>}
@end example
......
@example
@code{/* Prefix @emph{imap4_} is reserve */}
@code{/* Prefix @emph{imap4_} is reserved */}
@code{#include <mailutils/imap4.h>}
@end example
......
@example
@code{/* Prefix @emph{iterator_} is reserve */}
@code{/* Prefix @emph{iterator_} is reserved */}
@code{#include <mailutils/iterator.h>}
@end example
......
@example
@code{/* Prefix @emph{locker_} is reserve */}
@code{/* Prefix @emph{locker_} is reserved */}
@code{#include <mailutils/locker.h>}
@end example
......
@example
@code{/* Prefix @emph{mailbox_} is reserve */}
@code{/* Prefix @emph{mailbox_} is reserved */}
@code{#include <mailutils/mailbox.h>}
@end example
@deftp {Data Type} mailbox_t
The @code{mailbox_t} object is used to hold information and it is an opaque
data structure to the user. Functions are provided to retrieve the information.
data structure to the user. Functions are provided to retrieve information
from the data structure.
@end deftp
@example
@group
......@@ -64,9 +65,9 @@ Not enough memory to allocate resources.
@end deftypefun
@deftypefun int mailbox_create_default (mailbox_t *@var{pmbox}, const char *@var{name})
The environment variable @emph{$MAIL} or the string formed by
Create a mailbox with @code{mailbox_create ()} based on the environment
variable @emph{$MAIL} or the string formed by
@emph{_PATH_MAILDIR}/@var{user}" or @emph{$LOGNAME} if @var{user} is null,
for a default mailbox and calls @code{mailbox_create}.
@end deftypefun
@deftypefun void mailbox_destroy (mailbox_t *@var{pmbox})
......
@example
@code{/* Prefix @emph{maildir_} is reserve */}
@code{/* Prefix @emph{maildir_} is reserved */}
@code{#include <mailutils/maildir.h>}
@end example
......
@example
@code{/* Prefix @emph{mailer_} is reserve */}
@code{/* Prefix @emph{mailer_} is reserved */}
@code{#include <mailutils/mailer.h>}
@end example
......
......@@ -104,17 +104,17 @@ This document was produced for version @value{VERSION} of @sc{gnu}
@end ifinfo
@menu
* Introduction:: GNU @sc{mailutils}
* C API:: C API.
* Concrete API:: Concrete API.
* Framework:: Framework.
* Programs:: Programs.
* Reporting Bugs:: Reporting Bugs.
* Acknowledgement:: Thanks and Credits.
* Concept Index:: All @sc{Mailutils} Functions.
* Concept Index:: All @sc{Mailutils} Functions.
* Index::
@end menu
@node Introduction, C API, Top, Top
@node Introduction, Concrete API, Top, Top
@comment node-name, next, previous, up
@chapter Introduction
@cindex Introduction
......@@ -217,14 +217,14 @@ Misc
@cite{Internet Email Protocols a Developer's Guide by Kevin Johnson}
@end itemize
@node C API, Framework, Introduction, Top
@node Concrete API, Framework, Introduction, Top
@comment node-name, next, previous, up
@chapter C API
@cindex C API
@chapter Concrete API
@cindex Concrete API
@include c-api.texi
@node Framework, Programs, C API, Top
@node Framework, Programs, Concrete API, Top
@comment node-name, next, previous, up
@chapter Framework
@cindex Framework
......
@example
@code{/* Prefix @emph{mbox_} is reserve */}
@code{/* Prefix @emph{mbox_} is reserved */}
@code{#include <mailutils/mbox.h>}
@end example
......
@example
@code{/* Prefix @emph{mh_} is reserve */}
@code{/* Prefix @emph{mh_} is reserved */}
@code{#include <mailutils/mh.h>}
@end example
......
@example
@code{/* Prefix @emph{nntp_} is reserve */}
@code{/* Prefix @emph{nntp_} is reserved */}
@code{#include <mailutils/nntp.h>}
@end example
......
@example
@code{/* Prefix @emph{parse822_} is reserve */}
@code{/* Prefix @emph{parse822_} is reserved */}
@code{#include <mailutils/parse822.h>}
@end example
......
@example
@code{/* Prefix @emph{sendmail_} is reserve */}
@code{/* Prefix @emph{sendmail_} is reserved */}
@code{#include <mailutils/sendmail.h>}
@end example
Spawning Sedmail daemon to deliver mail. Not implemented.
Spawning Sendmail daemon to deliver mail. Not implemented.
......
@example
@code{/* Prefix @emph{smtp_} is reserve */}
@code{/* Prefix @emph{smtp_} is reserved */}
@code{#include <mailutils/smtp.h>}
@end example
......