Skip to content
Mailgun Inspect/API Documentation/
/
Generate Preview Address

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

Create Export Job for Email Preview Test Screenshots

Request

Initiates an export job that collects screenshots for a specified Email Preview Test. Provide the list of client IDs whose screenshots you want to export. The job status can be monitored using the job ID returned in the response.

Security
basicAuth
Path
test_idstringrequired

Unique identifier of the Email Preview Test to export screenshots for

Bodyapplication/jsonrequired
clientsArray of stringsrequired
test_idstringrequired
curl -i -X POST \
  -u <username>:<password> \
  'https://api.mailgun.net/v2/preview/tests/{test_id}/exports' \
  -H 'Content-Type: application/json' \
  -d '{
    "clients": [
      "android11_gmailapp_pixel5_dm",
      "android12_gmailapp_pixel6_dm"
    ]
  }'

Responses

A 200 response

Bodyapplication/json
job_idstringrequired
test_idstringrequired
clientsArray of stringsrequired
job_statusstringrequired
zip_urlstring
failed_clientsArray of strings
errorgithub.com-mailgun-emailpreview-queue_tracking-APIError (object) or null
Any of:
Response
application/json
{
  "job_id": "67b469d74b911fa30a4d782e",
  "test_id": "98b469d74b956fa30a4d125f",
  "clients": [
    "android11_gmailapp_pixel5_dm",
    "android12_gmailapp_pixel6_dm"
  ],
  "job_status": "Processing"
}

Generate Preview Address

Request

Returns or generates an account's email preview address.

Security
basicAuth
curl -i -X POST \
  -u <username>:<password> \
  https://api.mailgun.net/v2/preview/address

Responses

A 200 response

Bodyapplication/json
preview_addressstringrequired
Response
application/json
{
  "preview_address": "string"
}

Create PreviewShare

Request

Create a shareable link to an email preview test.

Security
basicAuth
Bodyapplication/jsonrequired
test_idstringrequired
curl -i -X POST \
  -u <username>:<password> \
  https://api.mailgun.net/v1/preview/sharing \
  -H 'Content-Type: application/json' \
  -d '{
    "test_id": "some-id"
  }'

Responses

A 200 response

Bodyapplication/json
messagestringrequired

Response message

Response
application/json
{
  "message": "record created"
}