aboutsummaryrefslogtreecommitdiff
path: root/doc/aerc-imap.5.scd
diff options
context:
space:
mode:
Diffstat (limited to 'doc/aerc-imap.5.scd')
-rw-r--r--doc/aerc-imap.5.scd18
1 files changed, 17 insertions, 1 deletions
diff --git a/doc/aerc-imap.5.scd b/doc/aerc-imap.5.scd
index 12dcfbe..4307238 100644
--- a/doc/aerc-imap.5.scd
+++ b/doc/aerc-imap.5.scd
@@ -19,7 +19,7 @@ In accounts.conf (see *aerc-config*(5)), the following IMAP-specific options are
available:
*source*
- imap[s][+insecure]://username[:password]@hostname[:port]
+ imap[s][+insecure|+oauthbearer]://username[:password]@hostname[:port]?[:oauth2_params]
Remember that all fields must be URL encoded. The "@" symbol, when URL
encoded, is *%40*.
@@ -35,6 +35,22 @@ available:
*imaps*:
IMAP with TLS/SSL
+ *imaps+oauthbearer://*
+ IMAP with TLS/SSL using OAUTHBEARER Authentication
+
+ *oauth2_params:*
+
+ If specified, the configured password is used as an refresh token that
+ is exhanged with an access token
+
+ - token_endpoint (required)
+ - client_id (optional)
+ - client_secret (optional)
+ - scope (optional)
+
+ Example:
+ imaps+oauthbearer://...?token_endpoint=https://...&client_id=
+
*source-cred-cmd*
Specifies the command to run to get the password for the IMAP
account. This command will be run using `sh -c [command]`. If a