imio.emailkit

Transactional email templating for iMio's Plone ecosystem: author HTML mails with Maizzle 6 (Vue SFC + Tailwind CSS 4), rendered at runtime by Chameleon. No Node.js runs in production.

Installing it restyles Plone's password-reset, registration and username-reminder mails.

Documentation

https://imio.github.io/imio.emailkit/

Covers the quickstart, architecture, API reference, authoring rules, shipping, and overrides:

Installation

pip install imio.emailkit

Install the add-on in Site Setup, or apply imio.emailkit:default for Plone's transactional mails; imio.emailkit:base is runtime-only.

from imio.emailkit import Email

Email("imio.emailkit:notification").to(member).with_context(
    title=title, intro=intro, cta_url=url
).send()

Compatibility

Plone 6.0–6.2 on Python 3.10–3.13.

Contribute

• Issue tracker
• Source
• Contributing guide

Prerequisites

• An operating system meeting these requirements.
• uv
• Make
• Git
• Node.js 22+, only for building templates

Installation

1. Clone this repository and enter it.

   git clone git@github.com:IMIO/imio.emailkit.git
   cd imio.emailkit
   

2. Install it.

   make install
   

make help lists every target; common ones: make test, make check (format then lint), make start, make create-site, make build-emails, make check-emails, make preview-emails.

Working on the docs

SKILL.md covers authoring conventions for AI-assisted work; the documentation site lives in docs/site/ — see its README to add a page.

License

Licensed under GPLv2.