Skip to main content

Image Protocol Compatibility

[!TIP] This feature is optional. To disable images, go to Settings > Image Display: OFF, you can also always turn it on for 1 email by pressing i

Matcha supports modern terminal image protocols for displaying images directly in your terminal. This allows for rich email viewing with inline images, including those embedded in HTML emails (CID references), remote images, and base64-encoded data URIs.

Supported Protocols

🖼️ Kitty Graphics Protocol

Full support is provided for terminals implementing the Kitty Graphics Protocol.

Supported Terminals:

🖼️ iTerm2 Inline Images

Native support is included for the iTerm2 inline image protocol.

Supported Terminals:

Features

  • Inline Email Images: Display images embedded in HTML emails.
  • Remote Image Fetching: Automatically fetches and displays remote images from URLs.
  • Data URI Support: Renders base64-encoded inline images.
  • Smart Fallback: Gracefully falls back to clickable links when images aren't supported.

Debugging

If images aren't displaying correctly, you can enable debug logging to troubleshoot:

export DEBUG_IMAGE_PROTOCOL=1
export DEBUG_IMAGE_PROTOCOL_LOG=/tmp/matcha-images.log
matcha

Check the log file at /tmp/matcha-images.log for detailed information about image rendering.