Email rendering checks for your CI
Fail your PR if emails have critical rendering issues. Checks HTML, React Email (JSX), MJML, and Maizzle email templates against 21 email clients and reports compatibility scores with framework-aware fix suggestions.
Also available as an MCP server — analyze and fix emails directly from Claude, Cursor, or any MCP-compatible AI assistant.
# .github/workflows/email-check.yml
name: Email Preview Check
on: [pull_request]
jobs:
check-emails:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: emailens/action@v1
with:
pattern: "emails/**/*.html"
threshold: "70"| Input | Description | Default |
|---|---|---|
pattern |
Glob pattern to find email HTML files | emails/**/*.html |
threshold |
Minimum score (0-100) per client | 70 |
format |
Input format: html, jsx, mjml, or maizzle |
html |
api-key |
API key for authenticated requests | - |
clients |
Comma-separated client IDs to check | all clients |
max-files |
Maximum files to check per run | 50 |
fail-on-error |
Fail if critical errors found | true |
| Output | Description |
|---|---|
passed |
true if all files pass, false otherwise |
summary |
Human-readable results summary |
results |
JSON array with per-file scores |
- uses: emailens/action@v1
with:
pattern: "src/emails/**/*.html"
threshold: "80"
format: "mjml"
api-key: ${{ secrets.EMAILENS_API_KEY }}
clients: "gmail-web,outlook-windows,apple-mail-macos"
max-files: "20"
fail-on-error: "true"Quota note: Free tier allows 30 previews/day. Each file counts as one preview. Use
max-filesandclientsto stay within limits, or add anapi-keyfor higher quotas.
gmail-web, gmail-android, gmail-ios, outlook-web, outlook-windows, outlook-windows-legacy, outlook-ios, outlook-android, outlook-macos, apple-mail-macos, apple-mail-ios, yahoo-mail, yahoo-mail-android, yahoo-mail-ios, samsung-mail, thunderbird, hey-mail, protonmail, aol, fastmail, superhuman
- MCP Server — Analyze and fix emails from Claude, Cursor, or any MCP client
- Engine — Core analysis library (npm)
- CLI — Command-line tool
- Web — Hosted version with screenshots and sharing
MIT