# HTML Email Debugger (`tempting_district/html-email-debugger`) Actor
Detect structural, CSS, and client-compatibility issues in HTML emails and receive precise, actionable fixes before sending.
- **URL**: https://apify.com/tempting\_district/html-email-debugger.md
- **Developed by:** [Lone](https://apify.com/tempting_district) (community)
- **Categories:** Developer tools, Other
- **Stats:** 2 total users, 1 monthly users, 0.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet
## Pricing
from $0.00001 / result
This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.
Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event
## What's an Apify Actor?
Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".
## How to integrate an Actor?
If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.
In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md):
```bash
npm install apify-client
```
In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md):
```bash
pip install apify-client
```
In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md):
````bash
# MacOS / Linux
curl -fsSL https://apify.com/install-cli.sh | bash
# Windows
irm https://apify.com/install-cli.ps1 | iex
```bash
In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md).
If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md).
For usage examples, see the [API](#api) section below.
For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).
# README
## HTML Email Debugger
Validate HTML email markup against real-world email client rendering constraints and generate deterministic, client-aware failure reports.
This Actor analyzes raw HTML email source code and applies a fixed rule set to identify structural, CSS, media, and compatibility issues that cause emails to break across clients such as Outlook, Gmail, Apple Mail, and Yahoo.
It is designed for **precision**, not design guidance.
---
### What This Actor Does
- Validates HTML email structure using deterministic rules
- Detects client-specific rendering failures
- Identifies exact failing elements with inspectable locations
- Produces a binary verdict (PASS / FAIL)
- Outputs structured, machine-readable diagnostics
---
### Supported Email Clients
- Outlook (Windows / Word rendering engine)
- Gmail (Web and Mobile)
- Apple Mail
- Yahoo Mail
---
### Built-In Test Presets
To support regression testing and deterministic validation, the Actor includes built-in presets:
- **broken-email-v0.1** — Deliberately broken email (expected FAIL)
- **clean-email-v0.1** — Minimal compliant email (expected PASS)
Presets can be selected directly in the Input UI.
---
### Input Parameters
#### Preset (Optional)
- **preset**
- `none` (default)
- `broken-email-v0.1`
- `clean-email-v0.1`
When a preset is selected, custom HTML input is ignored.
---
#### Custom HTML Validation
- **emailHtml** (string)
Raw HTML email source to validate. Required when `preset` is `none`.
---
#### Validation Options
- **intendedClients**
Target email clients to validate against
*(default: outlook, gmail)*
- **strictMode**
Fail if any critical violations are detected
*(default: true)*
- **maxViolations**
Maximum number of violations to record
*(default: 100)*
---
### Output
Each run produces a single dataset item with:
- **verdict** — PASS or FAIL
- **failureCount** — Total violations detected
- **violations** — Detailed rule-based failures
- **element locations** — Tag, selector, snippet, byte offset
- **metadata** — Rule version, preset used, hash, timestamp
---
### Rule Set
- 15 deterministic rules (v0.1)
- Covers structure, CSS, media, links, and compatibility
- No heuristics, scoring, or LLM-based analysis
- Same input always produces the same output
---
### What This Actor Does Not Do
- No visual previews
- No template generation
- No accessibility scoring
- No autofix or code rewriting
- No LLM interpretation
This is a debugger, not a designer.
---
### Legal and Compliance
- Processes only provided HTML input
- No scraping or external requests
- No personal data stored
- GDPR-friendly by design
---
### Performance
- Typical runtime: under 1 minute
- Memory usage: under 4 GB
- Deterministic and repeatable outputs
- Suitable for CI and automated pipelines
---
### Versioning
- **v0.1** — Initial deterministic rule set
- Future versions will expand rules only with explicit versioning
---
### Final Note
HTML email rendering failures are silent and costly.
This Actor exists to surface those failures deterministically, explain exactly why they occur, and make results trustworthy without interpretation.
# Actor input Schema
## `preset` (type: `string`):
Select a built-in regression test preset or choose 'none' to provide custom HTML.
## `emailHtml` (type: `string`):
Raw HTML email source. Required when preset is set to 'none'.
## `intendedClients` (type: `array`):
Email clients to validate against.
## `strictMode` (type: `boolean`):
Fail the run if any critical violations are detected.
## `maxViolations` (type: `integer`):
Maximum number of violations to record before stopping analysis.
## Actor input object example
```json
{
"preset": "none",
"emailHtml": "",
"intendedClients": [
"outlook",
"gmail"
],
"strictMode": true,
"maxViolations": 100
}
````
# Actor output Schema
## `overview` (type: `string`):
No description
# API
You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.
## JavaScript example
```javascript
import { ApifyClient } from 'apify-client';
// Initialize the ApifyClient with your Apify API token
// Replace the '' with your token
const client = new ApifyClient({
token: '',
});
// Prepare Actor input
const input = {};
// Run the Actor and wait for it to finish
const run = await client.actor("tempting_district/html-email-debugger").call(input);
// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
console.dir(item);
});
// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs
```
## Python example
```python
from apify_client import ApifyClient
# Initialize the ApifyClient with your Apify API token
# Replace '' with your token.
client = ApifyClient("")
# Prepare the Actor input
run_input = {}
# Run the Actor and wait for it to finish
run = client.actor("tempting_district/html-email-debugger").call(run_input=run_input)
# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
print(item)
# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start
```
## CLI example
```bash
echo '{}' |
apify call tempting_district/html-email-debugger --silent --output-dataset
```
## MCP server setup
```json
{
"mcpServers": {
"apify": {
"command": "npx",
"args": [
"mcp-remote",
"https://mcp.apify.com/?tools=tempting_district/html-email-debugger",
"--header",
"Authorization: Bearer "
]
}
}
}
```
## OpenAPI specification
```json
{
"openapi": "3.0.1",
"info": {
"title": "HTML Email Debugger",
"description": "Detect structural, CSS, and client-compatibility issues in HTML emails and receive precise, actionable fixes before sending.",
"version": "0.0",
"x-build-id": "pgyFGNPmR4xMj3uGQ"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/tempting_district~html-email-debugger/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-tempting_district-html-email-debugger",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/acts/tempting_district~html-email-debugger/runs": {
"post": {
"operationId": "runs-sync-tempting_district-html-email-debugger",
"x-openai-isConsequential": false,
"summary": "Executes an Actor and returns information about the initiated run in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/runsResponseSchema"
}
}
}
}
}
}
},
"/acts/tempting_district~html-email-debugger/run-sync": {
"post": {
"operationId": "run-sync-tempting_district-html-email-debugger",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
}
},
"components": {
"schemas": {
"inputSchema": {
"type": "object",
"properties": {
"preset": {
"title": "Built-in Test Preset",
"enum": [
"none",
"broken-email-v0.1",
"clean-email-v0.1"
],
"type": "string",
"description": "Select a built-in regression test preset or choose 'none' to provide custom HTML.",
"default": "none"
},
"emailHtml": {
"title": "Email HTML",
"type": "string",
"description": "Raw HTML email source. Required when preset is set to 'none'.",
"default": ""
},
"intendedClients": {
"title": "Target Email Clients",
"type": "array",
"description": "Email clients to validate against.",
"items": {
"type": "string",
"enum": [
"outlook",
"gmail",
"apple-mail",
"yahoo"
]
},
"default": [
"outlook",
"gmail"
]
},
"strictMode": {
"title": "Strict Mode",
"type": "boolean",
"description": "Fail the run if any critical violations are detected.",
"default": true
},
"maxViolations": {
"title": "Maximum Violations",
"type": "integer",
"description": "Maximum number of violations to record before stopping analysis.",
"default": 100
}
}
},
"runsResponseSchema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"actId": {
"type": "string"
},
"userId": {
"type": "string"
},
"startedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"finishedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"status": {
"type": "string",
"example": "READY"
},
"meta": {
"type": "object",
"properties": {
"origin": {
"type": "string",
"example": "API"
},
"userAgent": {
"type": "string"
}
}
},
"stats": {
"type": "object",
"properties": {
"inputBodyLen": {
"type": "integer",
"example": 2000
},
"rebootCount": {
"type": "integer",
"example": 0
},
"restartCount": {
"type": "integer",
"example": 0
},
"resurrectCount": {
"type": "integer",
"example": 0
},
"computeUnits": {
"type": "integer",
"example": 0
}
}
},
"options": {
"type": "object",
"properties": {
"build": {
"type": "string",
"example": "latest"
},
"timeoutSecs": {
"type": "integer",
"example": 300
},
"memoryMbytes": {
"type": "integer",
"example": 1024
},
"diskMbytes": {
"type": "integer",
"example": 2048
}
}
},
"buildId": {
"type": "string"
},
"defaultKeyValueStoreId": {
"type": "string"
},
"defaultDatasetId": {
"type": "string"
},
"defaultRequestQueueId": {
"type": "string"
},
"buildNumber": {
"type": "string",
"example": "1.0.0"
},
"containerUrl": {
"type": "string"
},
"usage": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "integer",
"example": 1
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
}
}
},
"usageTotalUsd": {
"type": "number",
"example": 0.00005
},
"usageUsd": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "number",
"example": 0.00005
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
}
}
}
}
}
}
}
}
}
}
```