Skip to content
Mailgun Optimize
/
Mailgun Optimize API Reference
/
Inbox Placement
/
Run Inbox Placement Test

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
inboxready.json
inboxready.yaml
Languages
Servers
US Mailgun

https://api.mailgun.net/

EU Mailgun

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

Domains

Operations

DMARC Reports

DMARC reporting provides valuable insights into your infrastructure, helping you identify potential issues like senders, misconfigured email servers, or phishing attempts.

Operations

Inbox Placement

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

Operations

Get Result by a Share ID

Request

Get a result by the share ID.

Security
basicAuth
Path
shareidstringrequired
curl -i -X GET \
  -u <username>:<password> \
  'https://api.mailgun.net/v4/inbox/sharing/public/{shareid}'

Responses

A 200 response

Bodyapplication/json
ridstringrequired
result_idstringrequired
keybox_emailstringrequired
subjectstringrequired
senderstringrequired
seedlist_namestringrequired
created_atstring(date-time)required
updated_atstring(date-time)required
statusstringrequired
attributesobjectrequired
attributes.​property name*stringadditional property
campaign_idstringrequired
sharing_enabledbooleanrequired
sharing_idstringrequired
sharing_expires_atstring(date-time)required
seed_resultsArray of objectsrequired
seed_results[].​emailstringrequired
seed_results[].​providerstringrequired
seed_results[].​destinationstringrequired
seed_results[].​statestringrequired
seed_results[].​originating_ipstringrequired
seed_results[].​tagsArray of stringsrequired
seed_results[].​dkimstring
seed_results[].​spfstring
seed_results[].​dmarcstring
seed_results[].​headersArray of objects(Service_Documentation_github.com-mailgun-spy-model-MessageHeader)
seed_results[].​extensionsobjectrequired
seed_results[].​extensions.​categorystringrequired
spamassassinobject(Service_Documentation_github.com-mailgun-spy-spamassassin-Result)required
spamassassin.​is_spambooleanrequired
spamassassin.​scorenumber(float)required
spamassassin.​requirednumber(float)required
spamassassin.​rulesArray of objectsrequired
spamassassin.​rules[].​namestringrequired
spamassassin.​rules[].​pointsnumber(float)required
spamassassin.​rules[].​short_descriptionstringrequired
spamassassin.​rules[].​long_descriptionstringrequired
delivery_statsobjectrequired
delivery_stats.​property name*objectadditional property
bodystringrequired

Only for GET /inbox/results/{result}

Response
application/json
{
  "BasicTestResult": {
    "created_at": "0001-01-01 00:00:00 +0000 UTC",
    "updated_at": "0001-01-01 00:00:00 +0000 UTC",
    "sharing_expires_at": "0001-01-01 00:00:00 +0000 UTC"
  },
  "spamassassin": {}
}

Run Inbox Placement Test

Request

Create and run a new inbox placement test.

Either 'html' or 'template_name' field should be provided.

'variables' are Template variables, which could be used in html or template. You can use next recipient variables inside Template variables, which will be filled for every seed automatically: %recipient.first_name%, %recipient.last_name%.

Security
basicAuth
Bodyapplication/jsonrequired
fromstringrequired
subjectstringrequired
htmlstring
template_namestring

template from Mailgun Send

variablesobject
seed_liststring

Use existing Seed List. If omitted creates new Seed List

provider_filterArray of strings

missing/null/[] means all providers

curl -i -X POST \
  -u <username>:<password> \
  https://api.mailgun.net/v4/inbox/tests \
  -H 'Content-Type: application/json' \
  -d '{
    "from": "First Last <mail@example.com>",
    "subject": "Buy our elephants",
    "html": "<html><body>Hello {{first_name}} {{last_name}}. Visit our new shop at {{address}}. <b>Our elephants are the best.</b> </body></html>",
    "template_name": "template1",
    "variables": {
      "address": "108, Robinson Ave, Richmond",
      "first_name": "%recipient.first_name%",
      "last_name": "%recipient.last_name%"
    },
    "seed_list": "ibp-123@mailgun.com",
    "provider_filter": [
      "gmail.com",
      "hotmail.com"
    ]
  }'

Responses

A 202 response

Bodyapplication/json
result_idstringrequired
linksobject(Service_Documentation_github.com-mailgun-spy-api-CreateTestRespLinks)required
links.​resultsstringrequired
Response
application/json
{
  "result_id": "uuid4",
  "links": {
    "results": "https://api.mailgun.net/v4/inbox/results/uuid4"
  }
}

List Email Providers

Request

List all available email providers.

Security
basicAuth
curl -i -X GET \
  -u <username>:<password> \
  https://api.mailgun.net/v4/inbox/providers

Responses

A 200 response

Bodyapplication/json
itemsArray of objects(Service_Documentation_github.com-mailgun-spy-api-Provider)required
items[].​domainstringrequired
items[].​display_namestringrequired
items[].​regionstringrequired
items[].​created_atstring(date-time)required
items[].​updated_atstring(date-time)required
items[].​max_email_countinteger(int32)required
items[].​seeds_limitinteger(int32)required
items[].​unsupported_authenticationsobject(Service_Documentation_github.com-mailgun-spy-api-UnsupportedAuthentications)required
items[].​unsupported_authentications.​dkimbooleanrequired
items[].​unsupported_authentications.​spfbooleanrequired
items[].​unsupported_authentications.​dmarcbooleanrequired
items[].​virtualbooleanrequired
Response
application/json
{
  "items": [
    { … }
  ]
}

Bounce Classification

Operations

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