summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorArash Esbati <arash@gnu.org>2023-02-27 10:10:13 +0100
committerEli Zaretskii <eliz@gnu.org>2023-02-27 14:30:29 +0200
commit44949c292f9133025b1a895bee622d74078255dd (patch)
tree969a475849794c2d1b7cd387be3a2e40da928f23
parent6c7078c66f429d8fa43aa7416ee7bb07b0e81386 (diff)
downloademacs-44949c292f9133025b1a895bee622d74078255dd.tar.gz
; Add `nnimap-user' to Gnus manual
* doc/misc/gnus.texi (Customizing the IMAP Connection): Document backend variable `nnimap-user' which was introduced with commit 5e68f8614f in 2011. Add index entries for all backend variables. (bug#61837)
-rw-r--r--doc/misc/gnus.texi17
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/misc/gnus.texi b/doc/misc/gnus.texi
index d513726979b..cf6820948ad 100644
--- a/doc/misc/gnus.texi
+++ b/doc/misc/gnus.texi
@@ -14510,13 +14510,23 @@ Here's an example method that's more complex:
@table @code
@item nnimap-address
+@vindex nnimap-address
The address of the server, like @samp{imap.gmail.com}.
+@item nnimap-user
+@vindex nnimap-user
+Username to use for authentication to the @acronym{IMAP} server. This
+corresponds to the value of the @samp{login} token in your
+@file{~/.authinfo} file. Set this variable if you want to access
+multiple accounts from the same @acronym{IMAP} server.
+
@item nnimap-server-port
+@vindex nnimap-server-port
If the server uses a non-standard port, that can be specified here. A
typical port would be @code{"imap"} or @code{"imaps"}.
@item nnimap-stream
+@vindex nnimap-stream
How @code{nnimap} should connect to the server. Possible values are:
@table @code
@@ -14547,6 +14557,7 @@ Non-encrypted and unsafe straight socket connection.
@end table
@item nnimap-authenticator
+@vindex nnimap-authenticator
Some @acronym{IMAP} servers allow anonymous logins. In that case,
this should be set to @code{anonymous}. If this variable isn't set,
the normal login methods will be used. If you wish to specify a
@@ -14556,6 +14567,7 @@ specific login method to be used, you can set this variable to either
requires using the @file{oauth2.el} library.)
@item nnimap-expunge
+@vindex nnimap-expunge
When to expunge deleted messages. If @code{never}, deleted articles
are marked with the IMAP @code{\\Delete} flag but not automatically
expunged. If @code{immediately}, deleted articles are immediately expunged
@@ -14571,27 +14583,32 @@ expunge ALL articles that are currently flagged as deleted
(i.e., potentially not only the article that was just deleted).
@item nnimap-streaming
+@vindex nnimap-streaming
Virtually all @acronym{IMAP} server support fast streaming of data.
If you have problems connecting to the server, try setting this to
@code{nil}.
@item nnimap-fetch-partial-articles
+@vindex nnimap-fetch-partial-articles
If non-@code{nil}, fetch partial articles from the server. If set to
a string, then it's interpreted as a regexp, and parts that have
matching types will be fetched. For instance, @samp{"text/"} will
fetch all textual parts, while leaving the rest on the server.
@item nnimap-record-commands
+@vindex nnimap-record-commands
If non-@code{nil}, record all @acronym{IMAP} commands in the
@samp{"*imap log*"} buffer.
@item nnimap-use-namespaces
+@vindex nnimap-use-namespaces
If non-@code{nil}, omit the IMAP namespace prefix in nnimap group
names. If your IMAP mailboxes are called something like @samp{INBOX}
and @samp{INBOX.Lists.emacs}, but you'd like the nnimap group names to
be @samp{INBOX} and @samp{Lists.emacs}, you should enable this option.
@item nnimap-keepalive-intervals
+@vindex nnimap-keepalive-intervals
By default, nnimap will send occasional @samp{NOOP} (keepalive)
commands to the server, to keep the connection alive. This option
governs how often that happens. It is a cons of two integers,