emailproxy(1)

📦 version 2025.3.14, in ubuntu resolute, ubuntu stonking

💖 emailproxy(1) — the manual page, but make it slay 💖

okay bestie, welcome to the General Commands Manual entry for emailproxy — she's the icon, the moment, the whole vibe. let's get into it. ✨

🌸 NAME 🌸

emailproxy — transparently adds 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 🎀

(not me spelling it like that — it's in the original, iykyk 💀)

emailproxy is an Email OAuth 2.0 Proxy: it transparently adds OAuth 2.0 support to IMAP/POP/SMTP client applications, scripts, or literally any other email use-case that just... doesn't support this authentication method. no cap. it just slides in and handles it for you. 💅

👑 COMMAND-LINE OPTIONS 👑

🎀 appearance

  • --no-gui — starts the proxy with no menu bar icon. big note tho bestie: account authorisation requests will fail unless you're using a pre-authorised --config-file, OR you use --external-auth or --local-server-auth and keep an eye on the log/terminal output. so like, don't be shocked. 🙈

🔐 authentication methods

  • --external-auth — handles authorisation externally: instead of intercepting redirect_uri, the proxy just waits for you to paste the result into either its popup window (GUI mode) or the terminal (no-GUI mode — this one needs prompt_toolkit). you're the main character here. 💅
  • --local-server-auth — handles authorisation by printing request URLs to the log and starting a local web server on demand to receive the responses. she's serving. 🌈

⚙️ server, account and runtime configuration

  • --config-file config_file — the full path to the proxy's configuration file. it's optional; default is 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 is to save to --config-file. alternatively you can use an external store, like a secrets manager — see the readme for the instructions and requirements (yes there are requirements, don't skip them 🫶).

🐛 logging, debugging and help

  • --log-file log_file — the full path to a file where log output should be sent. optional; the default log behaviour varies by platform — see the readme for details. 🌸
  • --debug — enables debug mode, which sends all client<->proxy<->server communication to the proxy's log. every last crumb. 👀
  • --version — shows the proxy's version string and exits. short, sweet, iconic. ⭐
  • -h, --help — shows this help message and exits. hi hello, here's the tea. 🍓

📁 FILES 📁

  • emailproxy.config

🔗 SEE ALSO 🔗

💜 AUTHOR 💜

Simon Robinson https://simon.robinson.ac — the actual legend behind all this. 👑

and that's the whole page, bestie!! this version is email-oauth2-proxy (2025.3.14), dated 2026-01-12, and yes you got the emailproxy(1) manual. go forth and authenticate slayfully 💖✨🎀🦋🌸💅🫶

📦 where this page comes from