Skip to content
Mailgun Inspect/
/Link Validation

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/

Get Link Validation Results

Request

Returns the results of a link validation test.

Security
basicAuth
Path
idstringrequired

The ID of the validation test we want to check the results for

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

Responses

A 200 response

Bodyapplication/json
metaobject or null
itemsobject(github.com-mailgun-inspect-internal-linkvalidation-LinkValidation)
Response
application/json
{
  "meta": {
    "status": "Completed"
  },
  "items": {
    "id": "677eeda04fc661c900945dec",
    "results": [ … ]
  }
}

Reprocess Link Validation Test

Request

Reprocess a link validation test.

Security
basicAuth
Path
idstringrequired

Link Validation Test ID

curl -i -X POST \
  -u <username>:<password> \
  'https://api.mailgun.net/v1/inspect/links/{id}'

Responses

A 200 response

Bodyapplication/json
metaobject or null
itemsobject(github.com-mailgun-inspect-internal-linkvalidation-CreateResource)
Response
application/json
{
  "meta": {
    "status": "Processing"
  },
  "items": {
    "id": "67803c4b7061304b609e47d0",
    "links": { … }
  }
}

Delete Link Validation Test

Request

Delete a specific link validation test by its unique test ID. This endpoint allows you to remove a link validation test from the system. If the test ID does not exist, the appropriate error message is returned.

Security
basicAuth
Path
idstringrequired

The unique identifier of the test.

curl -i -X DELETE \
  -u <username>:<password> \
  'https://api.mailgun.net/v1/inspect/links/{id}'

Responses

A 200 response

Bodyapplication/json
messagestringrequired

Response message

Response
application/json
{
  "message": "Test <id> has been successfully deleted."
}

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