Mailgun Email Preview service with RESTful JSON HTTP API for providing email previews.
Mailgun Inspect/API Documentation//
- Generate Preview Address
List Clients
Get Test Results
Reprocess Emailpreview Test
Get Test Content (empty)
Get Test Content
Generate Preview Address
List/Search Tests V2
Create Email Preview Test V2
Get Test Results by client ID V2
Get Emailpreview Test Information V2
Delete Emailpreview Test V2
Retrieve Export Job Details for Email Preview Test Screenshots
Retrieve Export Job Details for Email Preview Test Screenshots
Create Export Job for Email Preview Test Screenshots
Create PreviewShare
Get PreviewShare
Update PreviewShare
Delete PreviewShare
Rotate PreviewShare
Returns PreviewShare record by UUID.
List Emailpreview Tests
Create Emailpreview Test
Get Emailpreview Test Info
Delete Emailpreview Test
Generate Preview Address
Email Preview API (1.0.0)
Download OpenAPI description
Languages
Servers
US Mailgun
https://api.mailgun.net
EU Mailgun
https://api.eu.mailgun.net
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
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
- US Mailgunhttps://api.mailgun.net/v2/preview/tests/{test_id}/exports
- EU Mailgunhttps://api.eu.mailgun.net/v2/preview/tests/{test_id}/exports
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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"
]
}'Response
application/json
{ "job_id": "67b469d74b911fa30a4d782e", "test_id": "98b469d74b956fa30a4d125f", "clients": [ "android11_gmailapp_pixel5_dm", "android12_gmailapp_pixel6_dm" ], "job_status": "Processing" }
- US Mailgunhttps://api.mailgun.net/v2/preview/address
- EU Mailgunhttps://api.eu.mailgun.net/v2/preview/address
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://api.mailgun.net/v2/preview/addressResponse
application/json
{ "preview_address": "string" }
- US Mailgunhttps://api.mailgun.net/v1/preview/sharing
- EU Mailgunhttps://api.eu.mailgun.net/v1/preview/sharing
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://api.mailgun.net/v1/preview/sharing \
-H 'Content-Type: application/json' \
-d '{
"test_id": "some-id"
}'Response
application/json
{ "message": "record created" }