Skip to content

Commit 7312ae0

Browse files
committed
Add pointer to #317 for potential DAG flow usage
1 parent 3ed7dfd commit 7312ae0

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Transparently add OAuth 2.0 support to IMAP/POP/SMTP client applications, script
44

55
## Motivation and capabilities<a id="motivation-and-capabilities"></a>
66
Email services that support IMAP, POP and/or SMTP access are increasingly requiring the use of OAuth 2.0 to authenticate connections, but not all clients support this method.
7-
This tool creates a simple local proxy that intercepts the traditional IMAP/POP/SMTP authentication commands and transparently replaces them with the appropriate SASL (X)OAuth 2.0 commands and credentials.
7+
This tool creates a local proxy that intercepts the traditional IMAP/POP/SMTP authentication commands and transparently replaces them with the appropriate SASL (X)OAuth 2.0 commands and credentials.
88
Your email client can continue to use the `login` or `auth`/`authenticate` options, with no need to make it aware of OAuth's existence.
99
The proxy works in the background with a menu bar/taskbar helper or as a headless system service, and is compatible with macOS, Windows and Linux.
1010

emailproxy.config

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -166,10 +166,12 @@ documentation = Accounts are specified using your email address as the section h
166166
attempts before the first valid login, pre-encrypting account entries is highly recommended. See the example
167167
script at https://github.com/simonrob/email-oauth2-proxy/issues/61#issuecomment-1259110336.
168168

169-
- The proxy supports the device authorisation grant (DAG) OAuth 2.0 flow, which may better suit headless systems
170-
(currently only known to be available for Office 365 / Outlook). To use this flow, set `oauth2_flow = device`. With
169+
- The proxy supports the device authorisation grant (DAG) OAuth 2.0 flow (currently only known to be available for
170+
Office 365 / Outlook), which may better suit headless systems. To use this flow, set `oauth2_flow = device`. With
171171
this flow, the proxy receives authorisation responses directly from the service provider, so no `redirect_uri` is
172-
needed. An example account configuration is given below.
172+
needed. An example account configuration is given below. For additional customisation, the proxy modifications and
173+
scripts demonstrated at https://github.com/simonrob/email-oauth2-proxy/pull/317 show how the DAG flow authorisation
174+
message could be pushed to a separate device, which may be useful when running the proxy headless or without a GUI.
173175

174176
Gmail customisation:
175177
- The proxy supports the use of service accounts with Gmail for Google Workspace (note: normal Gmail accounts do not

0 commit comments

Comments
 (0)