Skip to content

Email Preview API (1.0.0)

Mailgun Email Preview service with RESTful JSON HTTP API for providing email previews.

Download OpenAPI description
Languages
Servers
US Mailgun

https://api.mailgun.net/

EU Mailgun

https://api.eu.mailgun.net/

Image Validation

The Image Validation API processes image URLs or uploads to provide comprehensive details such as dimensions, type, file size, and format, reports frame count, animation duration, color depth, and transparency for GIFs, and include image optimization capabilities.

Operations

Accessibility

The Accessibility API evaluates HTML emails against WCAG standards, providing a clear pass/fail assessment to ensure compliance with accessibility guidelines.

Operations

Code Analysis

The Code Analysis API analyzes HTML email content to detect CSS features and provides comprehensive compatibility reports across major email clients, including support statistics, version-specific compatibility data, and detailed feature breakdowns to ensure optimal email rendering.

Operations

Email Preview

This API provides functionality to create and manage email preview tests, as well as create shareable links.

Operations

Request

Reprocesses the test for the passed clients.

Security
basicAuth
Path
test_idstringrequired

Test to reprocess

curl -i -X PUT \
  -u <username>:<password> \
  'https://api.mailgun.net/v1/preview/tests/{test_id}/results/reprocess'

Responses

A 200 response

Bodyapplication/json
property name*github.com-mailgun-emailpreview-clients-preview-ReprocessInfo (object) or nulladditional property
Any of:
Response
application/json

Request

Gets HTML content of the passed test.

Security
basicAuth
Path
test_idstringrequired

Test to get the content of

curl -i -X GET \
  -u <username>:<password> \
  'https://api.mailgun.net/v1/preview/tests/{test_id}/content'

Responses

A 200 response

Bodyapplication/json
contentstringrequired
Response
application/json
{ "content": "string" }

Request

Gets HTML content of the passed test.

Security
basicAuth
Path
test_idstringrequired

Test to get the content of

contentstringrequired

Content to get: inlinecss or textonly

curl -i -X GET \
  -u <username>:<password> \
  'https://api.mailgun.net/v1/preview/tests/{test_id}/content/{content}'

Responses

A 200 response

Bodyapplication/json
contentstringrequired
Response
application/json
{ "content": "string" }