Skip to content
/
Returns PreviewShare reco...

Alerts (0.0.1)

Our alerting solution is centered around two concepts: events and channels. The occurrence of an event can be configured to trigger an alert. A channel describes the delivery method for an alert. Every configured alert consists of an event type / channel pair. This level of granularity allows alerting to be configured to your exact preference.

Download OpenAPI description
openapi-final.json
openapi-final.yaml
Languages
Servers
US Mailgun

https://api.mailgun.net/

EU Mailgun

https://api.eu.mailgun.net/

Domains

Operations

Inbox Placement

Inbox Placement testing allows you to see the likely deliverability of your email campaigns.

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-01 00:00:00 +0000 UTC"
}

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(Email_Preview_API_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
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": { … }
  }
]

Spam Traps Monitoring

Our spam trap monitoring service surfaces how much of your email is being sent to known spam traps.

Operations

Email Health Score

Operations

IP Blocklist Monitoring

Operations

Domain Blocklist Monitoring

Blocklist Monitoring enables you to keep an eye on your reputation. Monitor your domains against our curated list of blocklist providers to make sure you aren't being blocked.

Operations

Google Postmaster Tools

This API provides access to Google Postmaster data.

Operations

Microsoft SNDS

This API provides access to Microsoft SNDS data.

Operations

Alerts

Operations