1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
emailproxy(1) "email-oauth2-proxy (2025.3.14)"
# NAME
emailproxy - transparently add OAuth 2.0 support to email client applications
# SYNOPSIS
*emailproxy* [ *--no-gui* ] [ *--external-auth* ] [ *--local-server-auth* ] [ *--config-file* _config_file_ ] [ *--cache-store* _cache_store_ ] [ *--log-file* _log_file_ ] [ *--debug* ] [ *--version* ] [ *-h* ]
# DESCRIPION
emailproxy is an Email OAuth 2.0 Proxy: it transparently adds OAuth 2.0 support
to IMAP/POP/SMTP client applications, scripts or any other email use-cases that
don't support this authentication method.
# COMMAND-LINE OPTIONS
## appearance
*--no-gui*
start the proxy without a menu bar icon (note: account
authorisation requests will fail unless a pre-authorised
*--config-file* is used, or you use
*--external-auth* or *--local-server-auth* and monitor
log/terminal output)
## authentication methods
*--external-auth*
handle authorisation externally: rather than
intercepting _redirect_uri_, the proxy will wait for
you to paste the result into either its popup window
(GUI mode) or the terminal (no-GUI mode; requires
*prompt_toolkit*)
*--local-server-auth*
handle authorisation by printing request URLs to the
log and starting a local web server on demand to
receive responses
## server, account and runtime configuration
*--config-file* _config_file_
the full path to the proxy's configuration file
(optional; default: emailproxy.config in the same
directory as the proxy script)
*--cache-store* _cache_store_
the full path to a local file to use for credential
caching (optional; default: save to *--config-file*);
alternatively, an external store such as a secrets
manager can be used - see readme for instructions and
requirements
## logging, debugging and help
*--log-file* _log_file_
the full path to a file where log output should be
sent (optional; default log behaviour varies by
platform - see readme for details)
*--debug*
enable debug mode, sending all client<->proxy<->server
communication to the proxy's log
*--version*
show the proxy's version string and exit
*-h*, *--help*
show this help message and exit
# FILES
*emailproxy.config*
# SEE ALSO
Full readme and guide: https://github.com/simonrob/email-oauth2-proxy. On
Debian systems, the python3-email-oauth2-proxy package installs its
documentation in /usr/share/doc/python3-email-oauth2-proxy/ .
# AUTHOR
Simon Robinson https://simon.robinson.ac
|
