# Html Email Debugger (`rocketagro/html-email-debugger`) Actor 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. - **URL**: https://apify.com/rocketagro/html-email-debugger.md - **Developed by:** [Jahid Hasan](https://apify.com/rocketagro) (community) - **Categories:** E-commerce, Lead generation, SEO tools - **Stats:** 9 total users, 0 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing $10.00 / 1,000 results 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 **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: | Parameter | Type | Description | Required | Default Value | | --------------- | -------- | ------------------------------------------------------------- | -------- | ----------------------------------- | | `htmlContent` | `string` | Raw HTML of the email you want to test. | ✅ | _None_ | | `subjectLine` | `string` | Subject line to include in the test report (optional). | ❌ | _Empty string_ | | `sender` | `string` | Sender address to display in the report (optional). | ❌ | _Empty string_ | | `targetClients` | `array` | Email clients to simulate (e.g., Gmail, Outlook, Apple Mail). | ❌ | `["Gmail", "Outlook", "AppleMail"]` | | `devices` | `array` | Device types to simulate (e.g., desktop, mobile). | ❌ | `["desktop"]` | #### Example Input ```json { "htmlContent": "

Welcome!

", "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 ```json { "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) ```bash 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": "

Welcome!

", "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. *** ### 🔗 Related Links - [Apify SDK Documentation](https://sdk.apify.com/) - [Playwright Documentation](https://playwright.dev/) - [Apify Actor Documentation](https://docs.apify.com/actors) *** ### 🛠 Plans & Availability - **Flat $5/Month Coffee Bill** → Run ad-hoc validations, view JSON/CSV reports. Available exclusively on [Apify Marketplace](https://apify.com/). *** ### 📞 Support Need help or a custom feature? 📧 Contact us at [support@mcp-validator.com](mailto://support@mcp-validator.com) (or via Apify support). # Actor input Schema ## `htmlContent` (type: `string`): Raw HTML of the email you want to test across different clients. ## `subjectLine` (type: `string`): Subject line to include in the test report (optional). ## `sender` (type: `string`): Optional email sender to display in reports (optional). ## `targetClients` (type: `array`): Select which email clients to simulate (Gmail, Outlook, Apple Mail). ## `devices` (type: `array`): Choose which device screen sizes to simulate. ## Actor input object example ```json { "htmlContent": "
Promo Banner

Limited Time Offer!

Get 50% off all subscriptions. Hurry, offer ends soon.

Claim Offer
", "subjectLine": "Your 50% OFF Coupon 🎉", "sender": "no-reply@example.com", "targetClients": [ "Gmail", "Outlook", "AppleMail" ], "devices": [ "desktop", "mobile" ] } ``` # 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 = { "htmlContent": "
Promo Banner

Limited Time Offer!

Get 50% off all subscriptions. Hurry, offer ends soon.

Claim Offer
", "subjectLine": "Your 50% OFF Coupon 🎉", "sender": "no-reply@example.com", "targetClients": [ "Gmail", "Outlook", "AppleMail" ], "devices": [ "desktop", "mobile" ] }; // Run the Actor and wait for it to finish const run = await client.actor("rocketagro/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 = { "htmlContent": "
Promo Banner

Limited Time Offer!

Get 50% off all subscriptions. Hurry, offer ends soon.

Claim Offer
", "subjectLine": "Your 50% OFF Coupon 🎉", "sender": "no-reply@example.com", "targetClients": [ "Gmail", "Outlook", "AppleMail", ], "devices": [ "desktop", "mobile", ], } # Run the Actor and wait for it to finish run = client.actor("rocketagro/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 '{ "htmlContent": "
\

Limited Time Offer!

Get 50% off all subscriptions. Hurry, offer ends soon.

Claim Offer
", "subjectLine": "Your 50% OFF Coupon 🎉", "sender": "no-reply@example.com", "targetClients": [ "Gmail", "Outlook", "AppleMail" ], "devices": [ "desktop", "mobile" ] }' | apify call rocketagro/html-email-debugger --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=rocketagro/html-email-debugger", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Html Email Debugger", "description": "Test and debug HTML emails across different email clients and devices.\nEnsure 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.", "version": "0.0", "x-build-id": "qWZOoVF1eCHOprwp3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rocketagro~html-email-debugger/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rocketagro-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/rocketagro~html-email-debugger/runs": { "post": { "operationId": "runs-sync-rocketagro-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/rocketagro~html-email-debugger/run-sync": { "post": { "operationId": "run-sync-rocketagro-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", "required": [ "htmlContent", "targetClients", "devices" ], "properties": { "htmlContent": { "title": "Email HTML content", "type": "string", "description": "Raw HTML of the email you want to test across different clients." }, "subjectLine": { "title": "Subject line (optional)", "type": "string", "description": "Subject line to include in the test report (optional)." }, "sender": { "title": "Sender Address", "type": "string", "description": "Optional email sender to display in reports (optional)." }, "targetClients": { "title": "Target email clients", "type": "array", "description": "Select which email clients to simulate (Gmail, Outlook, Apple Mail).", "items": { "type": "string", "enum": [ "Gmail", "Outlook", "AppleMail" ] } }, "devices": { "title": "Device Types", "type": "array", "description": "Choose which device screen sizes to simulate.", "items": { "type": "string", "enum": [ "desktop", "mobile" ] } } } }, "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 } } } } } } } } } } ```