Mailercloud Email Review API - Help Guide

What is the Email Review API?

This API allows you to review emails before sending them to identify potential issues such as:

AMP validation errors (Ensures your AMP emails follow proper formatting)
Broken links (Checks for incorrect or dead links in your email)
Blacklisted domains (Alerts you if any domain used in your email is blacklisted)
Email size compliance (Ensures your email meets size limitations for better performance)

By using this API, you can enhance email deliverability and prevent sending emails with errors that could affect engagement or inbox placement.

How to Use the Email Review API?

API Endpoint

This is the URL where you need to send your request:

POST https://email-api.mailercloud.com/email/review

Authentication

To use this API, you must include your API key in the request headers.

Headers:

Content-Type: application/json
Authorization: Bearer YOUR_API_KEY

Required Information

Parameter	Type	Description
text_content	String	The plain text version of the email
html_content	String	The HTML version of the email
amp_content	String	The AMP version of the email (if applicable)

Example Request

{
  "text_content": "Welcome to our platform!",
  "html_content": "<h1>Welcome!</h1><p>We are excited to have you.</p>",
  "amp_content": "<amp-img src='logo.png'></amp-img>"
}

Understanding API Responses

Once you submit your email content for review, the API will return details about any detected issues.

Success Response Example:

{
  "broken_links": ["example.com"],
  "blacklist_domains": [
    {
      "target_domain": "example.com",
      "target_ip": "160.0.232.217",
      "results": [
        {
          "blacklist": "blacklist.net",
          "status": "listed",
          "details": "addresses: [127.0.0.2]"
        }
      ]
    }
  ],
  "template": {
    "total_size": "809 bytes",
    "html_template_size": "500 bytes",
    "text_template_size": "309 bytes"
  }
}

Handling AMP Validation Errors

If the API detects AMP validation errors, the response will include detailed error messages explaining what needs to be corrected.

Example AMP Error Response:

{
  "error": "AMP validation errors",
  "validation_errors": [
    {
      "line": 1,
      "position": 15,
      "message": "The mandatory attribute '⚡4email' is missing in tag 'html'."
    },
    {
      "line": 1,
      "position": 49,
      "message": "The attribute 'http-equiv' may not appear in tag 'meta'."
    }
  ]
}

Response Fields Explained

Field	Description
broken_links	A list of broken links found in the email content
blacklist_domains	Information about blacklisted domains present in the email
template	Provides size details for different parts of the email
error	Displays an error message if the email content has validation issues
validation_errors	Detailed AMP validation errors including the line number, position, and issue description

Best Practices for Using the Email Review API

Ensure AMP Compliance: If you're using AMP emails, make sure all required AMP tags and attributes are correctly implemented.

Fix Broken Links: Regularly check your email content for outdated or non-working links.

Monitor Blacklisted Domains: Avoid sending emails containing links to domains flagged by spam filters.

Optimize Email Size: Keep email size within recommended limits to improve deliverability and loading speed.

Need More Help?

If you have any questions or need assistance, feel free to reach out to our support team.

Help center