Skip to main content
Documentation

Changelog

All notable changes to CoffeeMail.

  1. SDK

    Official Python SDK & SDK Response Examples

    • Official coffeemail Python SDK release on PyPI with full support for sync (CoffeeMail) and async (AsyncCoffeeMail) clients.
    • Dedicated documentation section (/docs/sdk/python) with pip, uv, and poetry setup guides.
    • Standardized code blocks across all documentation: removed macOS window dots and added active tab copy button.
    • Complete expected response payload (data) examples for 100% of methods across both SDKs.
  2. Docs

    Public documentation 1.0

    • Full REST reference for the Product API (/v1/product/*).
    • Step-by-step guides: first email, domain, React Email templates, webhooks and broadcasts.
    • Node SDK @coffeemail/node v0.1.0 documented with safe returns in the data, error pattern.
  3. API

    Webhooks with HMAC SHA-256

    • Cryptographic validation of payloads via X-CoffeeMail-Signature header.
    • New events: email.opened, email.clicked, email.suppressed, email.delivery_delayed.
    • POST /v1/product/webhooks/:id/test endpoint to fire simulated events.
  4. Feature

    React Email templates

    • Server-side rendering via @react-email/render.
    • New POST /v1/product/templates/render-preview endpoint for real-time preview.
    • Typed variable support with defaultValue.
  5. Feature

    Broadcasts with RFC 8058

    • List-Unsubscribe and List-Unsubscribe-Post: List-Unsubscribe=One-Click headers injected automatically.
    • Automatic suppression on email.complained events.
    • POST /v1/product/broadcasts and POST /v1/product/broadcasts/:id/send endpoints.
  6. API

    Domains & DNS

    • Verification and diagnostic endpoints (/domains/:id/verify, /domains/:id/health).
    • Automatic generation of SPF, DKIM, DMARC and Ownership records.
  7. SDK

    Initial Node SDK

    • Release of @coffeemail/node with strict typing and safe returns.
    • Coverage: emails, domains, templates, audiences, broadcasts, suppressions, webhooks, stats.
    • ESM and CommonJS support, locale pt-BR/en/es.