# 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/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
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.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — 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 '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_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 '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# 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(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).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": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,tempting_district/html-email-debugger"
        }
    }
}

```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/mREiSailtN4sZm2Tb/builds/pgyFGNPmR4xMj3uGQ/openapi.json