Skip to content
Mailgun Inspect
/
API Reference
/
Email Preview
/
Get Emailpreview Test Info

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/

Email Preview

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

Operations

Create Emailpreview TestDeprecated

Request

Creates a new email preview test.

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

Security
basicAuth
Bodyapplication/jsonrequired
subjectstringrequired
htmlstring
mimestring
urlstring
transfer_encodingstring
charsetstring
reference_idstring
customer_idstring
clientsArray of strings
image_blockingboolean
headersobject
spamobject
content_checkingobject(github.com-mailgun-emailpreview-clients-preview-TestRequestContentChecking)
curl -i -X POST \
  -u <username>:<password> \
  https://api.mailgun.net/v1/preview/tests \
  -H 'Content-Type: application/json' \
  -d '{
    "subject": "some subject",
    "url": "https://example.com",
    "content_checking": {}
  }'

Responses

A 200 response

Bodyapplication/json
idstring
reference_idstring
customer_idstring
spamobject
warningsArray of objects(github.com-mailgun-emailpreview-clients-preview-Warning)
content_checkingobject(github.com-mailgun-emailpreview-clients-preview-ContentCheckingResult)
Response
application/json
{
  "id": "gmail"
}

Get Emailpreview Test InfoDeprecated

Request

Returns test info.

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

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}'

Responses

A 200 response

Bodyapplication/json
subjectstringrequired
dateinteger(int32)required
completedArray of strings
processingArray of strings
bouncedArray of strings
content_checkingobject(github.com-mailgun-emailpreview-clients-preview-ContentCheckingResult)
Response
application/json
{
  "subject": "string",
  "date": 0,
  "completed": [
    "string"
  ],
  "processing": [
    "string"
  ],
  "bounced": [
    "string"
  ],
  "content_checking": {
    "link_validation": { … },
    "image_validation": { … },
    "accessibility": { … }
  }
}

Delete Emailpreview TestDeprecated

Request

Deletes the specified test.

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

Security
basicAuth
Path
test_idstringrequired

Test to delete

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

Responses

A 200 response

Bodyapplication/json
successbooleanrequired
Response
application/json
{
  "success": true
}

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