view

README

view

The view package handles rendering email content for terminal display. It converts HTML email bodies into styled terminal text with support for inline images, hyperlinks, and quoted reply formatting.

Architecture

This package bridges raw email content (HTML/Markdown) and terminal output. It:

• Parses HTML email bodies using goquery and converts them to styled terminal text
• Renders hyperlinks using OSC 8 escape sequences (with fallback for unsupported terminals)
• Supports inline image rendering via multiple terminal graphics protocols:
  • Kitty Graphics Protocol (Kitty, Ghostty, WezTerm, Wayst, Konsole)
  • iTerm2 Image Protocol (iTerm2, Warp)
• Detects quoted reply sections (> prefixed lines and On DATE, EMAIL wrote: patterns) and renders them in styled quote boxes
• Manages image lifecycle: fetching remote images, resolving CID references, caching, uploading to terminal memory (Kitty IDs), and calculating terminal row placement
• Converts Markdown to HTML via Goldmark before processing

Documentation

Index

• Constants
• func ImageProtocolSupported() bool
• func RenderImageToStdout(placement *ImagePlacement, screenRow int, screenCol ...int)
• func SixelSupported() bool
• type ImagePlacement
  • func ProcessBody(rawBody, mimeType string, h1Style, h2Style, bodyStyle lipgloss.Style, ...) (string, []ImagePlacement, error)
  • func ProcessBodyWithInline(rawBody, mimeType string, inline []InlineImage, ...) (string, []ImagePlacement, error)
• type InlineImage

Constants

const (
	BodyMIMETypeHTML  = "text/html"
	BodyMIMETypePlain = "text/plain"
)

BodyMIMEType values understood by ProcessBody/ProcessBodyWithInline. Empty string means "unknown" — the renderer falls back to running markdownToHTML before HTML parsing, which is correct for plaintext-with-markdown bodies but can mangle complex HTML (e.g. tables with attribute-heavy <td style="...">).

Functions

func ImageProtocolSupported

func ImageProtocolSupported() bool

ImageProtocolSupported checks if any supported image protocol terminal is detected.

func RenderImageToStdout

func RenderImageToStdout(placement *ImagePlacement, screenRow int, screenCol ...int)

RenderImageToStdout writes an image directly to stdout at the given screen row using cursor positioning. This bypasses bubbletea's cell-based renderer which cannot handle graphics protocol escape sequences.

The escape sequence and row count were captured at HTML processing time by prerenderImage, so this call is a plain stdout write with no decode.

func SixelSupported

func SixelSupported() bool

SixelSupported returns true if the terminal uses the Sixel graphics protocol.

Types

type ImagePlacement

type ImagePlacement struct {
	Line    int    // Line number in the processed body text where the image starts
	Rows    int    // Number of terminal rows the rendered image occupies (from termimage)
	Encoded string // Cached terminal escape sequence from termimage (rendered once at layout time)
}

ImagePlacement holds the data needed to render an image at a specific line in the email body. Images are rendered directly to stdout (bypassing bubbletea's cell-based renderer which cannot handle graphics protocols).

Encoded and Rows are populated at HTML processing time by prerenderImage using termimage.DisplayWithSize, so paint-stage rendering is a plain stdout write and layout-stage row reservation matches the rendered output exactly.

func ProcessBody

func ProcessBody(rawBody, mimeType string, h1Style, h2Style, bodyStyle lipgloss.Style, disableImages bool) (string, []ImagePlacement, error)

ProcessBody takes a raw email body, decodes it, and formats it as plain text with terminal hyperlinks. mimeType is "text/html", "text/plain", or "" (unknown — falls back to legacy markdown→HTML pre-pass).

func ProcessBodyWithInline

func ProcessBodyWithInline(rawBody, mimeType string, inline []InlineImage, h1Style, h2Style, bodyStyle lipgloss.Style, disableImages bool) (string, []ImagePlacement, error)

ProcessBodyWithInline renders the body and resolves CID inline images when provided. Returns the rendered body text, image placements for out-of-band rendering, and any error. mimeType is "text/html", "text/plain", or "" (unknown — falls back to legacy markdown→HTML pre-pass).

type InlineImage

type InlineImage struct {
	CID    string
	Base64 string
}