Skip to content
Mailgun Inspect/API Documentation/
/
Returns PreviewShare reco...

Email Preview API (1.0.0)

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

Download OpenAPI description
openapi-final.json
openapi-final.yaml
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

Rotate PreviewShare

Request

Re-generates the uuid and share url, and resets the expiration.

Security
basicAuth
Path
test_idstringrequired

Test to rotate

Query
url_uuidstringrequired

UUID to rotate

curl -i -X POST \
  -u <username>:<password> \
  'https://api.mailgun.net/v1/preview/sharing/{test_id}/rotate?url_uuid=string'

Responses

A 200 response

Bodyapplication/json
test_idstringrequired
url_uuidstringrequired
urlstringrequired
enabledbooleanrequired
expires_atstring(date-time)required
Response
application/json
{
  "test_id": "some-test-id",
  "url_uuid": "some-new-uuid",
  "url": "share.mailgun.com/email-previews/some-new-uuid",
  "enabled": true,
  "expires_at": "0001-01-01T00:00:00Z"
}

Returns PreviewShare record by UUID.

Request

Security
basicAuth
Path
idstringrequired

UUID to get

curl -i -X GET \
  -u <username>:<password> \
  'https://api.mailgun.net/v1/preview/sharing/public/{id}'

Responses

A 200 response

Bodyapplication/json
subjectstringrequired
dateinteger(int32)required
resultsArray of objects(github.com-mailgun-emailpreview-clients-preview-TestResult)required
results[].​idstring
results[].​display_namestring
results[].​clientstring
results[].​osstring
results[].​categorystring
results[].​browserstring
results[].​screenshotsobject
results[].​thumbnailstring
results[].​full_thumbnailstring
results[].​statusstring
results[].​status_detailsobject or null
Response
application/json
{
  "subject": "some test",
  "date": 1,
  "results": []
}

List Emailpreview TestsDeprecated

Request

Returns a list of email preview tests.

WARNING: This endpoint is deprecated in favor of our V2 endpoint.

Security
basicAuth
curl -i -X GET \
  -u <username>:<password> \
  https://api.mailgun.net/v1/preview/tests

Responses

A 200 response

Bodyapplication/jsonArray [
idstring
dateinteger(int32)
typestring
subjectstring
headersobject
]
Response
application/json
[
  {
    "id": "",
    "date": 0,
    "type": "",
    "subject": "",
    "headers": { … }
  }
]