diff options
author | Eli Zaretskii <eliz@gnu.org> | 2024-05-18 09:12:54 +0300 |
---|---|---|
committer | Eli Zaretskii <eliz@gnu.org> | 2024-05-18 09:12:54 +0300 |
commit | ca17bc8dd0b51b6dbacd6e63a97d81488d45ec71 (patch) | |
tree | 20ff9cd33e7ce1c69c51ea7b53b549b820341c0a | |
parent | d47aa33bcdbd24283f680285f17736bd758ccba9 (diff) | |
download | emacs-ca17bc8dd0b51b6dbacd6e63a97d81488d45ec71.tar.gz emacs-ca17bc8dd0b51b6dbacd6e63a97d81488d45ec71.tar.bz2 emacs-ca17bc8dd0b51b6dbacd6e63a97d81488d45ec71.zip |
Improve documentation of 'movemail'
* doc/emacs/rmail.texi (Movemail): Fix the name of the Mailutils
manual in the printed version. Add index entries. Move the
description of remote mailboxes to...
(Remote Mailboxes): ...here, to avoid duplication.
-rw-r--r-- | doc/emacs/rmail.texi | 44 |
1 files changed, 20 insertions, 24 deletions
diff --git a/doc/emacs/rmail.texi b/doc/emacs/rmail.texi index 6efc610a49d..9c20d30c442 100644 --- a/doc/emacs/rmail.texi +++ b/doc/emacs/rmail.texi @@ -1428,7 +1428,7 @@ encrypted/decrypted text. your Rmail file (@pxref{Rmail Inbox}). When loaded for the first time, Rmail attempts to locate the @command{movemail} program and determine its version. There are two versions of the @command{movemail} program: the -GNU Mailutils version (@pxref{movemail,,,mailutils,GNU Mailutils}), +GNU Mailutils version (@pxref{movemail,,,mailutils,GNU Mailutils Manual}), and an Emacs-specific version that is built and installed unless Emacs was configured @option{--with-mailutils} in effect. The two @command{movemail} versions support the same @@ -1446,7 +1446,7 @@ mailboxes, etc. It is able to access remote mailboxes using the POP3 or IMAP4 protocol, and can retrieve mail from them using a TLS encrypted channel. It also accepts mailbox arguments in @acronym{URL} form. The detailed description of mailbox @acronym{URL}s can be found -in @ref{Mailbox,,,mailutils,GNU Mailutils}. In short, a +in @ref{Mailbox,,,mailutils,GNU Mailutils Manual}. In short, a @acronym{URL} is: @smallexample @@ -1457,6 +1457,8 @@ in @ref{Mailbox,,,mailutils,GNU Mailutils}. In short, a where square brackets denote optional elements. @table @var +@cindex mailbox protocol, @command{movemail} +@cindex format, of @command{movemail} mailbox @item proto Specifies the @dfn{mailbox protocol}, or @dfn{format} to use. The exact semantics of the rest of @acronym{URL} elements depends @@ -1502,23 +1504,13 @@ automatically by @command{movemail}. @item pop @itemx pops -A remote mailbox to be accessed via POP3 protocol. @var{user} -specifies the remote user name to use, @var{pass} may be used to -specify the user password, @var{host-or-file-name} is the name or IP -address of the remote mail server to connect to, and @var{port} is the -port number; e.g., @code{pop://smith:guessme@@remote.server.net:995}. -If the server supports it, @command{movemail} tries to use an -encrypted connection---use the @samp{pops} form to require one. +A remote mailbox to be accessed via POP3 protocol. @xref{Remote +Mailboxes}, for details. @item imap @itemx imaps -A remote mailbox to be accessed via IMAP4 protocol. @var{user} -specifies the remote user name to use, @var{pass} may be used to -specify the user password, @var{host-or-file-name} is the name or IP -address of the remote mail server to connect to, and @var{port} is the -port number; e.g., @code{imap://smith:guessme@@remote.server.net:993}. -If the server supports it, @command{movemail} tries to use an -encrypted connection---use the @samp{imaps} form to require one. +A remote mailbox to be accessed via IMAP4 protocol. @xref{Remote +Mailboxes}, for details. @end table Alternatively, you can specify the file name of the mailbox to use. @@ -1540,6 +1532,7 @@ listed in @code{rmail-movemail-search-path}, then in @code{exec-path} @node Remote Mailboxes @section Retrieving Mail from Remote Mailboxes @pindex movemail +@cindex remote mailboxes, accessing by @command{movemail} Some sites use a method called POP3 for accessing users' inbox data instead of storing the data in inbox files. The Mailutils @@ -1564,8 +1557,9 @@ Additionally, you may specify the password in the mailbox @acronym{URL}: case, @var{password} takes preference over the one set by @code{rmail-remote-password} (see below). This is especially useful if you have several remote mailboxes with different passwords. -If using Mailutils @command{movemail}, you may wish to use -@samp{pops} in place of @samp{pop}. +If using Mailutils @command{movemail} and the server supports +encrypted connections, @command{movemail} tries to use it; specify +@samp{pops:} instead of @samp{pop:} to require such a connection. For backward compatibility, Rmail also supports an alternative way of specifying remote POP3 mailboxes. Specifying an inbox name in the form @@ -1575,12 +1569,14 @@ specifying remote POP3 mailboxes. Specifying an inbox name in the form the machine on which to look for the POP3 server. @cindex IMAP mailboxes - Another method for accessing remote mailboxes is IMAP@. This method is -supported only by the Mailutils @command{movemail}. To specify an IMAP -mailbox in the inbox list, use the following mailbox @acronym{URL}: -@samp{imap://@var{username}[:@var{password}]@@@var{hostname}:@var{port}}. The -@var{password} part is optional, as described above. You may wish to -use @samp{imaps} in place of @samp{imap}. + Another method for accessing remote mailboxes is IMAP@. This method +is supported only by the Mailutils @command{movemail}, and uses the +IMAP4 protocol. To specify an IMAP mailbox in the inbox list, use the +following mailbox @acronym{URL}: +@samp{imap://@var{username}[:@var{password}]@@@var{hostname}:@var{port}}. +The @var{password} part is optional, as described above. If the +server supports it, @command{movemail} tries to use an encrypted +connection---use the @samp{imaps:} form to require one. @vindex rmail-remote-password @vindex rmail-remote-password-required |