Html Email Debugger avatar
Html Email Debugger

Pricing

$5.00/month + usage

Go to Apify Store
Html Email Debugger

Html Email Debugger

Developed by

Jahid Hasan

Jahid Hasan

Maintained by Community

Test and debug HTML emails across different email clients and devices. Ensure your email campaigns render perfectly everywhere before hitting send. This Actor helps developers, designers, and marketers identify rendering issues, broken links, and missing assets in their email templates.

0.0 (0)

Pricing

$5.00/month + usage

0

2

2

Last modified

6 days ago

Test and debug HTML emails across different email clients and devices.
Ensure your email campaigns render perfectly everywhere before hitting send. The HTML Email Debugger Actor helps developers, designers, and marketers identify rendering issues, broken links, and missing assets in their email templates.


๐Ÿš€ Features

  • Multi-Client Testing: Simulate email rendering in Gmail, Outlook, and Apple Mail.
  • Device Compatibility: Test across desktop and mobile screen resolutions.
  • Rendering Issue Detection: Identify broken layouts, missing images, and CSS issues.
  • Screenshots: Capture screenshots of email renderings for visual debugging.
  • Detailed Reports: Export structured debugging reports with metadata, rendering issues, and screenshot URLs.
  • Automation Ready: Integrate with your marketing workflows using the Apify platform.

๐Ÿ“ฅ Input Parameters

The HTML Email Debugger accepts the following input parameters:

ParameterTypeDescriptionRequiredDefault Value
htmlContentstringRaw HTML of the email you want to test.โœ…None
subjectLinestringSubject line to include in the test report (optional).โŒEmpty string
senderstringSender address to display in the report (optional).โŒEmpty string
targetClientsarrayEmail clients to simulate (e.g., Gmail, Outlook, Apple Mail).โŒ["Gmail", "Outlook", "AppleMail"]
devicesarrayDevice types to simulate (e.g., desktop, mobile).โŒ["desktop"]

Example Input

{
"htmlContent": "<!DOCTYPE html><html><body><h1>Welcome!</h1></body></html>",
"subjectLine": "Welcome Email",
"sender": "no-reply@example.com",
"targetClients": ["Gmail", "Outlook"],
"devices": ["desktop", "mobile"]
}

๐Ÿ“ค Output

The Actor generates a detailed report containing the following:

Metadata:

  • subjectLine: The subject line of the email.
  • sender: The sender address.
  • testedAt: The timestamp when the test was performed.

Screenshots:

  • client: The email client used for rendering (e.g., Gmail, Outlook).
  • device: The device type (e.g., desktop, mobile).
  • url: The URL of the screenshot saved in the Apify Key-Value Store.
  • issues: Rendering issues detected, including:
    • brokenLinks: List of links that returned HTTP errors.
    • missingAssets: List of assets (e.g., images) that failed to load.

Example Output

{
"meta": {
"subjectLine": "Welcome Email",
"sender": "no-reply@example.com",
"testedAt": "2023-10-01T12:00:00Z"
},
"screenshots": [
{
"client": "Gmail",
"device": "desktop",
"url": "https://api.apify.com/v2/key-value-stores/STORE_ID/records/Gmail_desktop.png",
"issues": {
"brokenLinks": ["https://example.com/broken-link"],
"missingAssets": ["https://example.com/missing-image.png"]
}
}
]
}

๐Ÿ› ๏ธ How It Works

  1. Input Your Email: Provide the HTML content, subject line, sender details, and target clients/devices.
  2. Run the Actor: The Actor renders the email in the specified clients and devices.
  3. Debugging: The Actor captures screenshots, detects rendering issues, and generates a detailed report.
  4. Export Results: Access the report and screenshots via the Apify platform.

๐ŸŒŸ Use Cases

  • Email Campaign QA: Ensure your email campaigns render correctly across all major clients.
  • Debugging Layout Issues: Identify broken layouts, missing images, or CSS problems.
  • Automated Testing: Integrate with CI/CD pipelines for automated pre-send email testing.
  • Support Teams: Empower developers, designers, and marketers with structured email QA.

๐Ÿ“˜ API Integration

The HTML Email Debugger API provides structured feedback on email rendering issues. You can integrate it with your workflows using JavaScript, Node.js, Python, or curl.

Example API Call (curl)

curl -X POST "https://api.apify.com/v2/acts/USERNAME~html-email-debugger/run-sync" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"htmlContent": "<!DOCTYPE html><html><body><h1>Welcome!</h1></body></html>",
"targetClients": ["Gmail", "Outlook"],
"devices": ["desktop"]
}'

๐Ÿ“ฆ Deployment

This Actor is built using the Apify SDK and Playwright. It runs in a Docker container based on the apify/actor-node-playwright-chrome image.

Development

  1. Clone the repository.
  2. Install dependencies: npm install.
  3. Run locally: apify run.

Deployment to Apify

  1. Push the Actor to Apify: apify push.
  2. Configure input parameters in the Apify console.
  3. Run the Actor and review the results.


๐Ÿ›  Plans & Availability

  • Flat $5/Month Coffee Bill โ†’ Run ad-hoc validations, view JSON/CSV reports. Available exclusively on Apify Marketplace.

๐Ÿ“ž Support

Need help or a custom feature? ๐Ÿ“ง Contact us at support@mcp-validator.com (or via Apify support).