summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorWojciech Polak <polak@gnu.org>2004-01-20 21:54:57 +0000
committerWojciech Polak <polak@gnu.org>2004-01-20 21:54:57 +0000
commit65164155a2a16498b5dcb473b6b3c58037d9f044 (patch)
tree1a7c0dc0d186fbfe1e2999c18e1c446c13283ca6 /doc
parentf8bb91cfacd595d4d0132e45ace89c130361c756 (diff)
downloadmailutils-65164155a2a16498b5dcb473b6b3c58037d9f044.tar.gz
mailutils-65164155a2a16498b5dcb473b6b3c58037d9f044.tar.bz2
Major reorganization in the documentation.
Diffstat (limited to 'doc')
-rw-r--r--doc/texinfo/address.texi32
-rw-r--r--doc/texinfo/attribute.texi10
-rw-r--r--doc/texinfo/auth.texi15
-rw-r--r--doc/texinfo/body.texi8
-rw-r--r--doc/texinfo/c-api.texi3
-rw-r--r--doc/texinfo/envelope.texi21
-rw-r--r--doc/texinfo/folder.texi11
-rw-r--r--doc/texinfo/framework.texi120
-rw-r--r--doc/texinfo/headers.texi8
-rw-r--r--doc/texinfo/imap4.texi7
-rw-r--r--doc/texinfo/iterator.texi9
-rw-r--r--doc/texinfo/libmu_scm.texi123
-rw-r--r--doc/texinfo/libmuauth.texi61
-rw-r--r--doc/texinfo/libsieve.texi1202
-rw-r--r--doc/texinfo/locker.texi8
-rw-r--r--doc/texinfo/mailbox.texi15
-rw-r--r--doc/texinfo/mailcap.inc6
-rw-r--r--doc/texinfo/mailcap.texi41
-rw-r--r--doc/texinfo/maildir.texi9
-rw-r--r--doc/texinfo/mailer.texi41
-rw-r--r--doc/texinfo/mailutils.texi289
-rw-r--r--doc/texinfo/mbox.texi14
-rw-r--r--doc/texinfo/message.texi13
-rw-r--r--doc/texinfo/mh.texi9
-rw-r--r--doc/texinfo/mime.texi7
-rw-r--r--doc/texinfo/mom.texi24
-rw-r--r--doc/texinfo/muint.texi4
-rw-r--r--doc/texinfo/nntp.texi7
-rw-r--r--doc/texinfo/parse822.texi8
-rw-r--r--doc/texinfo/pop3.texi37
-rw-r--r--doc/texinfo/programs.texi962
-rw-r--r--doc/texinfo/sendmail.texi7
-rw-r--r--doc/texinfo/sieve.texi1109
-rw-r--r--doc/texinfo/smtp.texi7
-rw-r--r--doc/texinfo/stream.texi11
-rw-r--r--doc/texinfo/url.texi71
36 files changed, 2147 insertions, 2182 deletions
diff --git a/doc/texinfo/address.texi b/doc/texinfo/address.texi
index 0d4e4ccc9..899fb848a 100644
--- a/doc/texinfo/address.texi
+++ b/doc/texinfo/address.texi
@@ -1,13 +1,13 @@
@c This is part of the GNU Mailutils manual.
-@c Copyright (C) 1999,2000,2001,2002 Free Software Foundation, Inc.
+@c Copyright (C) 1999,2000,2001,2002,2003,2004 Free Software Foundation, Inc.
@c See file mailutils.texi for copying conditions.
@comment *******************************************************************
-@example
+@smallexample
@code{/* Prefix @emph{address_} is reserved */}
@code{#include <mailutils/address.h>}
+@end smallexample
-@end example
The Internet address format is defined in RFC 822. RFC 822 has been
updated, and is now superceeded by RFC 2822, which
makes some corrections and clarifications. References to RFC 822
@@ -15,10 +15,10 @@ here apply equally to RFC 2822.
The RFC 822 format is more flexible than many people realize, here
is a quick summary of the syntax this parser implements, see
-RFC 822 for the details. "[]" pairs mean "optional", "/" means "one or
-the other", and double-quoted characters are literals.
+RFC 822 for the details. @samp{[]} pairs mean "optional", @samp{/} means
+"one or the other", and double-quoted characters are literals.
-@example
+@smallexample
addr-spec = local-part "@" domain
mailbox = addr-spec ["(" display-name ")"] /
[display-name] "<" [route] addr-spec ">"
@@ -26,7 +26,7 @@ mailbox-list = mailbox ["," mailbox-list]
group = display-name ":" [mailbox-list] ";"
address = mailbox / group / unix-mbox
address-list = address ["," address-list]
-@end example
+@end smallexample
unix-mbox is a non-standard extension meant to deal with the common
practice of using user names as addresses in mail utilities. It allows
@@ -75,7 +75,6 @@ The @code{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.
-
@end deftp
@deftypefun int address_create (address_t *@var{addr}, const char *@var{string})
@@ -104,9 +103,6 @@ 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})
The @var{addr} is destroyed.
@end deftypefun
@@ -154,7 +150,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
-address_get_email(), and all the rest, will return zero-length output.
+@code{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
@@ -163,7 +159,6 @@ 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})
Accesses the comments extracted while parsing the @var{no}th email address.
@@ -176,7 +171,6 @@ The return value is @code{0} on success and a code number on error conditions:
@end table
@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})
Accesses the email addr-spec extracted while
@@ -220,7 +214,7 @@ The return value is @code{0} on success and a code number on error conditions:
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>.
+a string, those wishing to parse it should look at @file{mailutils/parse822.h}.
The return value is @code{0} on success and a code number on error conditions:
@table @code
@@ -259,7 +253,6 @@ 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})
Returns a count of the addresses in the address list.
@@ -270,8 +263,7 @@ not @code{null}, the count will be written to *@var{count}.
The return value is @code{0}.
@end deftypefun
-@section Example
-@example
+@subheading Example
+@smallexample
@include addr.inc
-@end example
-
+@end smallexample
diff --git a/doc/texinfo/attribute.texi b/doc/texinfo/attribute.texi
index 3889e0830..53c68d06b 100644
--- a/doc/texinfo/attribute.texi
+++ b/doc/texinfo/attribute.texi
@@ -1,12 +1,12 @@
@c This is part of the GNU Mailutils manual.
-@c Copyright (C) 1999,2000,2001,2002 Free Software Foundation, Inc.
+@c Copyright (C) 1999,2000,2001,2002,2003,2004 Free Software Foundation, Inc.
@c See file mailutils.texi for copying conditions.
@comment *******************************************************************
-@example
+
+@smallexample
@code{/* Prefix @emph{attribute_} is reserved */}
@code{#include <mailutils/attribute.h>}
-
-@end example
+@end smallexample
@deftypefun int attribute_create (attribute_t *@var{pattribute})
@end deftypefun
@@ -56,7 +56,6 @@
@deftypefun int attribute_set_read (attribute_t @var{attribute})
@end deftypefun
-
@deftypefun int attribute_unset_seen (attribute_t @var{attribute})
@end deftypefun
@@ -89,4 +88,3 @@
@deftypefun int attribute_to_string (attribute_t @var{attr}, char *@var{buf}, size_t @var{len}, size_t *@var{pwriten})
@end deftypefun
-
diff --git a/doc/texinfo/auth.texi b/doc/texinfo/auth.texi
index 40525ac21..22ef41e21 100644
--- a/doc/texinfo/auth.texi
+++ b/doc/texinfo/auth.texi
@@ -1,12 +1,13 @@
@c This is part of the GNU Mailutils manual.
-@c Copyright (C) 1999,2000,2001,2002 Free Software Foundation, Inc.
+@c Copyright (C) 1999,2000,2001,2002,2003,2004 Free Software Foundation, Inc.
@c See file mailutils.texi for copying conditions.
@comment *******************************************************************
-@example
+
+@smallexample
@code{/* Prefix @emph{auth_} is reserved */}
@code{#include <mailutils/auth.h>}
-@end example
+@end smallexample
There are many ways to authenticate to a server. To be flexible the
authentication process is provided by two objects @code{auth_t} and
@@ -34,11 +35,13 @@ if not set, this function can be overridden by a custom method.
@deftypefun int auth_epilogue (auth_t @var{auth})
@end deftypefun
+@sp 1
A simple example of an authenticate function:
-@example
-#include <mailutils/auth.h>
+
+@smallexample
#include <stdio.h>
#include <string.h>
+#include <mailutils/auth.h>
int
my_authenticate (auth_t auth, char **user, char **passwd)
@@ -64,4 +67,4 @@ my_authenticate (auth_t auth, char **user, char **passwd)
*passwd = strdup (p);
return 0;
@}
-@end example
+@end smallexample
diff --git a/doc/texinfo/body.texi b/doc/texinfo/body.texi
index 0a9afe705..b1096d192 100644
--- a/doc/texinfo/body.texi
+++ b/doc/texinfo/body.texi
@@ -1,12 +1,12 @@
@c This is part of the GNU Mailutils manual.
-@c Copyright (C) 1999,2000,2001,2002 Free Software Foundation, Inc.
+@c Copyright (C) 1999,2000,2001,2002,2003,2004 Free Software Foundation, Inc.
@c See file mailutils.texi for copying conditions.
@comment *******************************************************************
-@example
+
+@smallexample
@code{/* Prefix @emph{body_} is reserved */}
@code{#include <mailutils/body.h>}
-
-@end example
+@end smallexample
@deftypefun int body_create (body_t *@var{body}, void *@var{owner})
Initialize an object @var{bdy}.
diff --git a/doc/texinfo/c-api.texi b/doc/texinfo/c-api.texi
index fb01bd48e..821f07a37 100644
--- a/doc/texinfo/c-api.texi
+++ b/doc/texinfo/c-api.texi
@@ -1,5 +1,5 @@
@c This is part of the GNU Mailutils manual.
-@c Copyright (C) 1999,2000,2001,2002 Free Software Foundation, Inc.
+@c Copyright (C) 1999,2000,2001,2002,2003,2004 Free Software Foundation, Inc.
@c See file mailutils.texi for copying conditions.
@comment *******************************************************************
@@ -61,4 +61,3 @@
@section Parse822
@cindex Parse822
@include parse822.texi
-
diff --git a/doc/texinfo/envelope.texi b/doc/texinfo/envelope.texi
index 54e713e9e..937354203 100644
--- a/doc/texinfo/envelope.texi
+++ b/doc/texinfo/envelope.texi
@@ -1,25 +1,22 @@
@c This is part of the GNU Mailutils manual.
-@c Copyright (C) 1999,2000,2001,2002 Free Software Foundation, Inc.
+@c Copyright (C) 1999,2000,2001,2002,2003,2004 Free Software Foundation, Inc.
@c See file mailutils.texi for copying conditions.
@comment *******************************************************************
-@example
+
+@smallexample
@code{/* Prefix @emph{envelope_} is reserved */}
@code{#include <mailutils/envelope.h>}
-@end example
+@end smallexample
@deftypefun int envelope_date (envelope_t, char *, size_t, size_t *);
-
Get the date that the message was delivered to the mailbox, in
-something close to ANSI ctime() format: Mon Jul 05 13:08:27 1999.
-
+something close to ANSI @code{ctime()} format: Mon Jul 05 13:08:27 1999.
@end deftypefun
@deftypefun int envelope_sender (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_get_message (envelope_t, message_t *);
@@ -34,17 +31,13 @@ Primarily for internal use.
@end deftypefun
@deftypefun int envelope_set_sender (envelope_t, int (*_sender) __P ((envelope_t, char *, size_t, size_t*)), void *);
-
Primarily for internal use. The implementation of envelope_t depends
on the mailbox type, this allows the function which actually gets
-the sender to be set by the creator of an envelope_t.
-
+the sender to be set by the creator of an @code{envelope_t}.
@end deftypefun
@deftypefun int envelope_set_date (envelope_t, int (*_date) __P ((envelope_t, char *, size_t, size_t *)), void *);
-
Primarily for internal use. The implementation of envelope_t depends
on the mailbox type, this allows the function which actually gets
-the date to be set by the creator of an envelope_t.
-
+the date to be set by the creator of an @code{envelope_t}.
@end deftypefun
diff --git a/doc/texinfo/folder.texi b/doc/texinfo/folder.texi
index 142ccc3cf..8ccb4dcb5 100644
--- a/doc/texinfo/folder.texi
+++ b/doc/texinfo/folder.texi
@@ -1,14 +1,15 @@
@c This is part of the GNU Mailutils manual.
-@c Copyright (C) 1999,2000,2001,2002 Free Software Foundation, Inc.
+@c Copyright (C) 1999,2000,2001,2002,2003,2004 Free Software Foundation, Inc.
@c See file mailutils.texi for copying conditions.
@comment *******************************************************************
-@example
+
+@smallexample
@code{/* Prefix @emph{folder_} is reserve */}
@code{#include <mailutils/folder.h>}
-@end example
+@end smallexample
-@example
+@smallexample
@group
folder_t url_t
-/var/mail- +---//---->/-----------------\ +-->/-----------\
@@ -27,7 +28,7 @@
| mailbox_t(n) |
\-----------------/
@end group
-@end example
+@end smallexample
@deftypefun int folder_create (folder_t *, const char *@var{url})
@end deftypefun
diff --git a/doc/texinfo/framework.texi b/doc/texinfo/framework.texi
index 73b2e7bd1..f8d4e06fa 100644
--- a/doc/texinfo/framework.texi
+++ b/doc/texinfo/framework.texi
@@ -1,38 +1,38 @@
@c This is part of the GNU Mailutils manual.
-@c Copyright (C) 1999,2000,2001,2002 Free Software Foundation, Inc.
+@c Copyright (C) 1999,2000,2001,2002,2003,2004 Free Software Foundation, Inc.
@c See file mailutils.texi for copying conditions.
@comment *******************************************************************
+
@menu
-* Folder:: Folder.
-* Mailbox:: Mailbox.
-* Mailer:: Protocol Used to Send Mail.
-* Message:: Message.
-* Envelope:: Envelope.
-* Headers:: Headers.
-* Body:: Body.
-* Attribute:: Attribute.
-* Stream:: Stream.
-* Iterator:: Iterator.
-* Authenticator:: Authenticator.
-* Address:: Address.
-* Locker:: Locker.
-* URL:: Uniform Resource Locators.
-* Parse822:: Parsing RFC 822 headers.
-* Mailcap:: Parsing RFC 1524 file.
+* Folder:: Folder.
+* Mailbox:: Mailbox.
+* Mailer:: Protocol Used to Send Mail.
+* Message:: Message.
+* Envelope:: Envelope.
+* Headers:: Headers.
+* Body:: Body.
+* Attribute:: Attribute.
+* Stream:: Stream.
+* Iterator:: Iterator.
+* Authenticator:: Authenticator.
+* Address:: Address.
+* Locker:: Locker.
+* URL:: Uniform Resource Locators.
+* Parse822:: Parsing RFC 822 headers.
+* Mailcap:: Parsing RFC 1524 file.
@end menu
Wherever the mail is and whatever format it is stored in, it is operated
upon using the same set of functions. To unified the C API,
@sc{gnu} Mailutils offers a heteroclite set of objects that work in
-aggregation to do operations on
-emails. Each object does 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 ..).
+aggregation to do operations on emails.
+Each object does 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
+@smallexample
@group
-
folder_t url_t
-/var/mail- +- .. ->+-----------------+ +-->+------------+
( alain *-)-+ | | url_t *-|---+ | port |
@@ -67,130 +67,102 @@ created, it will indicate the storage format or protocol
| stream_t |
+--------------+
@end group
-@end example
+@end smallexample
As an example, here is a simplified version of @code{from} command. It
lists the @samp{From} and @samp{Subject} headers of every mail in a mailbox.
-@example
+@smallexample
@include sfrom.inc
-@end example
+@end smallexample
Here is a sample output produced by this program:
-@example
+@smallexample
@cartouche
-% MAIL=pop://alain@@localhost ./sfrom
+% ./sfrom pop://alain@@localhost
Passwd: xxxx
Jim Meyering <meyering@@foo.org> fetish(shellutils) beta
Fran@,{c}ois Pinard <pinard@@bar.org> recode new alpha
@dots{}
@end cartouche
-@end example
+@end smallexample
@node Folder
-@comment node-name, next, previous, up
-@section Folder
+@subsection Folder
@cindex Folder
-
@include folder.texi
@node Mailbox
-@comment node-name, next, previous, up
-@section Mailbox
+@subsection Mailbox
@cindex Mailbox
-
@include mailbox.texi
@node Mailer
-@comment node-name, next, previous, up
-@section Mailer
+@subsection Mailer
@cindex Mailer
-
@include mailer.texi
@node Message
-@comment node-name, next, previous, up
-@section Message
+@subsection Message
@cindex Message
-
@include message.texi
@node Envelope
-@comment node-name, next, previous, up
-@section Envelope
+@subsection Envelope
@cindex Envelope
-
@include envelope.texi
@node Headers
-@comment node-name, next, previous, up
-@section Headers
+@subsection Headers
@cindex Headers
-
@include headers.texi
@node Body
-@comment node-name, next, previous, up
-@section Body
+@subsection Body
@cindex Body
-
@include body.texi
@node Attribute
-@comment node-name, next, previous, up
-@section Attribute
+@subsection Attribute
@cindex Attribute
-
@include attribute.texi
@node Stream
-@comment node-name, next, previous, up
-@section Stream
+@subsection Stream
@cindex Stream
-
@include stream.texi
@node Iterator
-@comment node-name, next, previous, up
-@section Iterator
+@subsection Iterator
@cindex Iterator
-
@include iterator.texi
@node Authenticator
-@comment node-name, next, previous, up
-@section Authenticator
+@subsection Authenticator
@cindex Authenticator
-
@include auth.texi
@node Address
-@comment node-name, next, previous, up
-@section Address
+@subsection Address
@cindex Address
-
@include address.texi
@node Locker
-@comment node-name, next, previous, up
-@section Locker
+@subsection Locker
@cindex Locker
-
@include locker.texi
@node URL
-@comment node-name, next, previous, up
-@section URL
+@subsection URL
@cindex URL
-
@include url.texi
@node Parse822
-@section Parse822 --- Functions for Parsing RFC 822 Headers
+@subsection Parse822
@include parse822.texi
@node Mailcap
-@section Mailcap --- Functions for Parsing RFC 1524 Files
+@subsection Mailcap
@include mailcap.texi
diff --git a/doc/texinfo/headers.texi b/doc/texinfo/headers.texi
index 518ba011f..4a0c20dcf 100644
--- a/doc/texinfo/headers.texi
+++ b/doc/texinfo/headers.texi
@@ -1,12 +1,13 @@
@c This is part of the GNU Mailutils manual.
-@c Copyright (C) 1999,2000,2001,2002 Free Software Foundation, Inc.
+@c Copyright (C) 1999,2000,2001,2002,2003,2004 Free Software Foundation, Inc.
@c See file mailutils.texi for copying conditions.
@comment *******************************************************************
-@example
+
+@smallexample
@code{/* Prefix @emph{header_} is reserved */}
@code{#include <mailutils/header.h>}
-@end example
+@end smallexample
So far we plan support for RFC822 and plan for RFC1522. with RFC1522 non ASCII
characters will be encoded.
@@ -79,7 +80,6 @@ Content-Type
@item MU_HEADER_MIME_VERSION
MIME-Version
@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})
diff --git a/doc/texinfo/imap4.texi b/doc/texinfo/imap4.texi
index efe64b363..4431eef1f 100644
--- a/doc/texinfo/imap4.texi
+++ b/doc/texinfo/imap4.texi
@@ -1,12 +1,13 @@
@c This is part of the GNU Mailutils manual.
-@c Copyright (C) 1999,2000,2001,2002 Free Software Foundation, Inc.
+@c Copyright (C) 1999,2000,2001,2002,2003,2004 Free Software Foundation, Inc.
@c See file mailutils.texi for copying conditions.
@comment *******************************************************************
-@example
+
+@smallexample
@code{/* Prefix @emph{imap4_} is reserved */}
@code{#include <mailutils/imap4.h>}
-@end example
+@end smallexample
Internet Message Access Protocol - Version (4rev1). In IMAP4, the client
must be prepared to accept any responses at all times. The server responses
diff --git a/doc/texinfo/iterator.texi b/doc/texinfo/iterator.texi
index 4e70e5a76..9908f63e1 100644
--- a/doc/texinfo/iterator.texi
+++ b/doc/texinfo/iterator.texi
@@ -1,12 +1,12 @@
@c This is part of the GNU Mailutils manual.
-@c Copyright (C) 1999,2000,2001,2002 Free Software Foundation, Inc.
+@c Copyright (C) 1999,2000,2001,2002,2003,2004 Free Software Foundation, Inc.
@c See file mailutils.texi for copying conditions.
@comment *******************************************************************
-@example
+
+@smallexample
@code{/* Prefix @emph{iterator_} is reserved */}
@code{#include <mailutils/iterator.h>}
-
-@end example
+@end smallexample
@deftypefun int iterator_create (iterator_t *)
@end deftypefun
@@ -25,4 +25,3 @@
@deftypefun int iterator_is_done (iterator_t)
@end deftypefun
-
diff --git a/doc/texinfo/libmu_scm.texi b/doc/texinfo/libmu_scm.texi
index f38d65290..15f9c4a14 100644
--- a/doc/texinfo/libmu_scm.texi
+++ b/doc/texinfo/libmu_scm.texi
@@ -1,5 +1,5 @@
@c This is part of the GNU Mailutils manual.
-@c Copyright (C) 1999,2000,2001,2002 Free Software Foundation, Inc.
+@c Copyright (C) 1999,2000,2001,2002,2003,2004 Free Software Foundation, Inc.
@c See file mailutils.texi for copying conditions.
@comment *******************************************************************
@@ -11,24 +11,22 @@ about Scheme programming language, @xref{Top,,,r4rs,Revised(4) Report on
the Algorithmic Language Scheme}.
@menu
-Functions Provided by libmu_scm
+Functions Provided by @file{libmu_scm}
* Address Functions::
* Mailbox Functions::
* Message Functions::
* MIME Functions::
-* Log Functions::
+* Logging Functions::
-Using libmu_scm
+Using @file{libmu_scm}
* Direct Linking::
* Dynamic Linking::
-
@end menu
-
@node Address Functions
-@section Address Functions
+@subsection Address Functions
@deffn {Scheme Function} mu-address-get-personal ADDRESS NUM
Return personal part of an email address.
@@ -54,14 +52,14 @@ Return number of parts in email address.
@end deffn
@node Mailbox Functions
-@section Mailbox Functions
+@subsection Mailbox Functions
@deffn {Scheme Function} mu-mailbox-open URL MODE
-Opens a mailbox specified by URL.
+Opens a mailbox specified by @var{URL}.
@end deffn
@deffn {Scheme Function} mu-mailbox-close MBOX
-Closes mailbox MBOX
+Closes mailbox @var{MBOX}.
@end deffn
@deffn {Scheme Function} mu-mailbox-get-url MBOX
@@ -69,14 +67,14 @@ Returns the URL of the mailbox.
@end deffn
@deffn {Scheme Function} mu-mailbox-get-port MBOX MODE
-Returns a port associated with the contents of the MBOX.
-MODE is a string defining operation mode of the stream. It may
+Returns a port associated with the contents of the @var{MBOX}.
+@var{MODE} is a string defining operation mode of the stream. It may
contain any of the two characters: @samp{r} for reading, @samp{w} for
writing.
@end deffn
@deffn {Scheme Function} mu-mailbox-get-message MBOX MSGNO
-Retrieve from MBOX message # MSGNO.
+Retrieve from @var{MBOX} message # @var{MSGNO}.
@end deffn
@deffn {Scheme Function} mu-mailbox-messages-count MBOX
@@ -96,17 +94,17 @@ Appends the message to the mailbox
@end deffn
@node Message Functions
-@section Message Functions
+@subsection Message Functions
@deffn {Scheme Function} mu-message-copy MESG
Creates the copy of the given message.
@end deffn
@deffn {Scheme Function} mu-message-set-header MESG HEADER VALUE REPLACE
-Sets new VALUE to the header HEADER of the message MESG.
-If the HEADER is already present in the message its value
-is replaced with the supplied one if the optional REPLACE is
-#t. Otherwise new header is created and appended.
+Sets new @var{VALUE} to the header @var{HEADER} of the message @var{MESG}.
+If the @var{HEADER} is already present in the message its value
+is replaced with the supplied one if the optional @var{REPLACE}
+is @code{#t}. Otherwise new header is created and appended.
@end deffn
@deffn {Scheme Function} mu-message-get-size MESG
@@ -118,146 +116,146 @@ Returns number of lines in the given message.
@end deffn
@deffn {Scheme Function} mu-message-get-sender MESG
-Returns the sender email address for the message MESG.
+Returns the sender email address for the message @var{MESG}.
@end deffn
@deffn {Scheme Function} mu-message-get-header MESG HEADER
-Returns the header value of the HEADER in the MESG.
+Returns the header value of the @var{HEADER} in the @var{MESG}.
@end deffn
@deffn {Scheme Function} mu-message-get-header-fields MESG HEADERS
-Returns the list of headers in the MESG. If optional HEADERS is
-specified it should be a list of header names to restrict return
+Returns the list of headers in the @var{MESG}. If optional @var{HEADERS}
+is specified it should be a list of header names to restrict return
value to.
@end deffn
@deffn {Scheme Function} mu-message-set-header-fields MESG LIST REPLACE
-Set the headers in the message MESG from LIST
-LIST is a list of (cons HEADER VALUE)
-Optional parameter REPLACE specifies whether the new header
-values should replace the headers already present in the
-message.
+Set the headers in the message @var{MESG} from @var{LIST}.
+@var{LIST} is a list of @code{(cons @var{HEADER} @var{VALUE})}.
+Optional parameter @var{REPLACE} specifies whether the new header
+values should replace the headers already present in the message.
@end deffn
@deffn {Scheme Function} mu-message-delete MESG FLAG
-Mark given message as deleted. Optional FLAG allows to toggle deleted mark
-The message is deleted if it is #t and undeleted if it is #f
+Mark given message as deleted. Optional @var{FLAG} allows to toggle
+deleted mark. The message is deleted if it is @code{#t} and undeleted
+if it is @code{#f}.
@end deffn
@deffn {Scheme Function} mu-message-get-flag MESG FLAG
-Return value of the attribute FLAG.
+Return value of the attribute @var{FLAG}.
@end deffn
@deffn {Scheme Function} mu-message-set-flag MESG FLAG VALUE
-Set the given attribute of the message. If optional VALUE is #f, the