GitHub Action
Inputs & Outputs
Complete reference for GitHub Action inputs and outputs.
Inputs
| Input | Required | Default | Description |
|---|---|---|---|
pattern | No | emails/**/*.html | Glob pattern to find email HTML files |
threshold | No | 70 | Minimum compatibility score (0-100) per client |
format | No | html | Input format: html, jsx, mjml, or maizzle |
api-key | No | , | API key for authenticated requests |
clients | No | all clients | Comma-separated list of client IDs to check |
max-files | No | 50 | Maximum number of files to check per run |
fail-on-error | No | true | Also fail a file when any client reports an error-severity issue, even if its score is above the threshold |
Outputs
| Output | Description |
|---|---|
passed | "true" if all files pass the threshold, "false" otherwise |
summary | Human-readable summary of results |
results | JSON array with per-file scores |
Using outputs
- uses: emailens/action@v1
id: email-check
with:
pattern: "emails/**/*.html"
threshold: "70"
- name: Comment on PR
if: steps.email-check.outputs.passed == 'false'
uses: actions/github-script@v7
env:
SUMMARY: ${{ steps.email-check.outputs.summary }}
with:
script: |
github.rest.issues.createComment({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: context.issue.number,
body: `Email compatibility check failed:\n\n${process.env.SUMMARY}`
});Available client IDs
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