Commit f8153009 authored by Kevin J. McCarthy's avatar Kevin J. McCarthy

Add some brief documentation on OAUTH support.

These are just pulled from Brandon's commit message.
parent c9ab8553
Pipeline #35796232 passed with stages
in 14 minutes and 21 seconds
......@@ -8298,6 +8298,45 @@ most-secure to least-secure.
</sect1>
<sect1 id="oauth">
<title>OAUTHBEARER Support</title>
<para>
Preliminary OAUTH support for IMAP, POP, and SMTP is provided via
external scripts.
</para>
<para>
At least for Gmail, you can use the <literal>oauth2.py</literal>
script from Google's gmail-oauth2-tools: <ulink
url="https://github.com/google/gmail-oauth2-tools/blob/master/python/oauth2.py"
>https://github.com/google/gmail-oauth2-tools/blob/master/python/oauth2.py</ulink>
</para>
<para>
You'll need to get your own oauth client credentials for Gmail here:
<ulink url="https://console.developers.google.com/apis/credentials"
>https://console.developers.google.com/apis/credentials</ulink>
</para>
<para>
Then, you'd use <literal>oauth2.py</literal> with
<literal>--generate_oauth2_token</literal> to get a refresh token, and
configure mutt with:
</para>
<screen>
set imap_authenticators="oauthbearer"
set imap_oauth_refresh_command="/path/to/oauth2.py --quiet --user=[email_address]\
--client_id=[client_id] --client_secret=[client_secret]\
--refresh_token=[refresh_token]"
</screen>
<para>
Substitute pop or smtp for imap in the above example to configure for those.
</para>
</sect1>
<sect1 id="account-hook">
<title>Managing Multiple Accounts</title>
......
......@@ -1338,7 +1338,7 @@ struct option_t MuttVars[] = {
** The command to run to generate an OAUTH refresh token for
** authorizing your connection to your IMAP server. This command will be
** run on every connection attempt that uses the OAUTHBEARER authentication
** mechanism.
** mechanism. See ``$oauth'' for details.
*/
{ "imap_pass", DT_STR, R_NONE, UL &ImapPass, UL 0 },
/*
......@@ -2424,7 +2424,7 @@ struct option_t MuttVars[] = {
** The command to run to generate an OAUTH refresh token for
** authorizing your connection to your POP server. This command will be
** run on every connection attempt that uses the OAUTHBEARER authentication
** mechanism.
** mechanism. See ``$oauth'' for details.
*/
{ "pop_pass", DT_STR, R_NONE, UL &PopPass, UL "" },
/*
......@@ -3402,7 +3402,7 @@ struct option_t MuttVars[] = {
** The command to run to generate an OAUTH refresh token for
** authorizing your connection to your SMTP server. This command will be
** run on every connection attempt that uses the OAUTHBEARER authentication
** mechanism.
** mechanism. See ``$oauth'' for details.
*/
{ "smtp_pass", DT_STR, R_NONE, UL &SmtpPass, UL 0 },
/*
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment