Inbound email

Receive email: inbound domains, routes, received messages, allowlists and blocklists.

Get inbound email settings for a domain.

GET/v1/transactional/inbound/domains/{domainId}/settings

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

`application/json`

curl -X GET "https://example.com/v1/transactional/inbound/domains/string/settings"

curl -X GET "https://example.com/v1/transactional/inbound/domains/string/settings"

{
  "domainId": "string",
  "domainName": "string",
  "isEnabled": true,
  "catchAllEnabled": true,
  "maxMessageSizeBytes": 0,
  "dailyLimit": 0,
  "retentionDays": 0,
  "storeEmails": true,
  "routeCount": 0,
  "defaults": null
}

{  "domainId": "string",  "domainName": "string",  "isEnabled": true,  "catchAllEnabled": true,  "maxMessageSizeBytes": 0,  "dailyLimit": 0,  "retentionDays": 0,  "storeEmails": true,  "routeCount": 0,  "defaults": null}

Update inbound email settings for a domain.

PUT/v1/transactional/inbound/domains/{domainId}/settings

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

isEnabled?null|boolean

catchAllEnabled?null|boolean

maxMessageSizeBytes?||

Match^-?(?:0|[1-9]\d*)$

Formatint32

dailyLimit?||

Match^-?(?:0|[1-9]\d*)$

Formatint32

retentionDays?||

Match^-?(?:0|[1-9]\d*)$

Formatint32

storeEmails?null|boolean

`application/json`

curl -X PUT "https://example.com/v1/transactional/inbound/domains/string/settings" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X PUT "https://example.com/v1/transactional/inbound/domains/string/settings" \  -H "Content-Type: application/json" \  -d '{}'

{
  "domainId": "string",
  "domainName": "string",
  "isEnabled": true,
  "catchAllEnabled": true,
  "maxMessageSizeBytes": 0,
  "dailyLimit": 0,
  "retentionDays": 0,
  "storeEmails": true,
  "routeCount": 0,
  "defaults": null
}

{  "domainId": "string",  "domainName": "string",  "isEnabled": true,  "catchAllEnabled": true,  "maxMessageSizeBytes": 0,  "dailyLimit": 0,  "retentionDays": 0,  "storeEmails": true,  "routeCount": 0,  "defaults": null}

List all routes for a domain.

GET/v1/transactional/inbound/domains/{domainId}/routes

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

`application/json`

curl -X GET "https://example.com/v1/transactional/inbound/domains/string/routes"

curl -X GET "https://example.com/v1/transactional/inbound/domains/string/routes"

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "domainId": "string",
      "domainName": null,
      "priority": 0,
      "isEnabled": true,
      "matchType": "string",
      "matchPattern": "string",
      "actions": [
        "string"
      ],
      "webhookId": null,
      "webhookName": null,
      "webhookUrl": null,
      "forwardToEmail": null,
      "forwardDestination": null,
      "rejectStatus": null,
      "rejectMessage": null,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "totalCount": 0
}

{  "items": [    {      "id": "string",      "name": "string",      "domainId": "string",      "domainName": null,      "priority": 0,      "isEnabled": true,      "matchType": "string",      "matchPattern": "string",      "actions": [        "string"      ],      "webhookId": null,      "webhookName": null,      "webhookUrl": null,      "forwardToEmail": null,      "forwardDestination": null,      "rejectStatus": null,      "rejectMessage": null,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "totalCount": 0}

Create a new inbound route for a domain.

POST/v1/transactional/inbound/domains/{domainId}/routes

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

priority?||

Match^-?(?:0|[1-9]\d*)$

Formatint32

matchType*string

matchPattern*string

actions?array<string>

webhookId?null|string

forwardToEmail?null|string

rejectStatus?null|string

rejectMessage?null|string

`application/json`

curl -X POST "https://example.com/v1/transactional/inbound/domains/string/routes" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "matchType": "string",
    "matchPattern": "string"
  }'

curl -X POST "https://example.com/v1/transactional/inbound/domains/string/routes" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "matchType": "string",    "matchPattern": "string"  }'

{
  "id": "string",
  "name": "string",
  "domainId": "string",
  "domainName": null,
  "priority": 0,
  "isEnabled": true,
  "matchType": "string",
  "matchPattern": "string",
  "actions": [
    "string"
  ],
  "webhookId": null,
  "webhookName": null,
  "webhookUrl": null,
  "forwardToEmail": null,
  "forwardDestination": null,
  "rejectStatus": null,
  "rejectMessage": null,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

{  "id": "string",  "name": "string",  "domainId": "string",  "domainName": null,  "priority": 0,  "isEnabled": true,  "matchType": "string",  "matchPattern": "string",  "actions": [    "string"  ],  "webhookId": null,  "webhookName": null,  "webhookUrl": null,  "forwardToEmail": null,  "forwardDestination": null,  "rejectStatus": null,  "rejectMessage": null,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Get a specific route by ID.

GET/v1/transactional/inbound/routes/{routeId}

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

`application/json`

curl -X GET "https://example.com/v1/transactional/inbound/routes/string"

curl -X GET "https://example.com/v1/transactional/inbound/routes/string"

{
  "id": "string",
  "name": "string",
  "domainId": "string",
  "domainName": null,
  "priority": 0,
  "isEnabled": true,
  "matchType": "string",
  "matchPattern": "string",
  "actions": [
    "string"
  ],
  "webhookId": null,
  "webhookName": null,
  "webhookUrl": null,
  "forwardToEmail": null,
  "forwardDestination": null,
  "rejectStatus": null,
  "rejectMessage": null,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

{  "id": "string",  "name": "string",  "domainId": "string",  "domainName": null,  "priority": 0,  "isEnabled": true,  "matchType": "string",  "matchPattern": "string",  "actions": [    "string"  ],  "webhookId": null,  "webhookName": null,  "webhookUrl": null,  "forwardToEmail": null,  "forwardDestination": null,  "rejectStatus": null,  "rejectMessage": null,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Update an existing route.

PUT/v1/transactional/inbound/routes/{routeId}

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?null|string

priority?||

Match^-?(?:0|[1-9]\d*)$

Formatint32

isEnabled?null|boolean

matchType?null|string

matchPattern?null|string

actions?null|array<string>

webhookId?null|string

forwardToEmail?null|string

rejectStatus?null|string

rejectMessage?null|string

`application/json`

curl -X PUT "https://example.com/v1/transactional/inbound/routes/string" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X PUT "https://example.com/v1/transactional/inbound/routes/string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": "string",
  "name": "string",
  "domainId": "string",
  "domainName": null,
  "priority": 0,
  "isEnabled": true,
  "matchType": "string",
  "matchPattern": "string",
  "actions": [
    "string"
  ],
  "webhookId": null,
  "webhookName": null,
  "webhookUrl": null,
  "forwardToEmail": null,
  "forwardDestination": null,
  "rejectStatus": null,
  "rejectMessage": null,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

{  "id": "string",  "name": "string",  "domainId": "string",  "domainName": null,  "priority": 0,  "isEnabled": true,  "matchType": "string",  "matchPattern": "string",  "actions": [    "string"  ],  "webhookId": null,  "webhookName": null,  "webhookUrl": null,  "forwardToEmail": null,  "forwardDestination": null,  "rejectStatus": null,  "rejectMessage": null,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Get a forward destination and whether mail may be forwarded to it.

GET/v1/transactional/inbound/forward-destinations/{destinationId}

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

`application/json`

curl -X GET "https://example.com/v1/transactional/inbound/forward-destinations/string"

curl -X GET "https://example.com/v1/transactional/inbound/forward-destinations/string"

{
  "id": "string",
  "email": "string",
  "status": "string",
  "confirmedVia": null,
  "lastSentAt": null,
  "confirmedAt": null,
  "declinedAt": null
}

{  "id": "string",  "email": "string",  "status": "string",  "confirmedVia": null,  "lastSentAt": null,  "confirmedAt": null,  "declinedAt": null}

Send the destination's confirmation email again.

POST/v1/transactional/inbound/forward-destinations/{destinationId}/resend

Allowed only while the destination is pending, at most once every 5 minutes and 5 times a day per destination, and 50 times a day per organisation. A destination on one of your own sending-verified domains needs no confirmation.

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Path Parameters

destinationId*string

Response Body

`application/json`

curl -X POST "https://example.com/v1/transactional/inbound/forward-destinations/string/resend"

curl -X POST "https://example.com/v1/transactional/inbound/forward-destinations/string/resend"

{
  "id": "string",
  "email": "string",
  "status": "string",
  "confirmedVia": null,
  "lastSentAt": null,
  "confirmedAt": null,
  "declinedAt": null
}

{  "id": "string",  "email": "string",  "status": "string",  "confirmedVia": null,  "lastSentAt": null,  "confirmedAt": null,  "declinedAt": null}

Toggle route enabled/disabled status.

POST/v1/transactional/inbound/routes/{routeId}/toggle

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Path Parameters

routeId*string

Response Body

`application/json`

curl -X POST "https://example.com/v1/transactional/inbound/routes/string/toggle"

curl -X POST "https://example.com/v1/transactional/inbound/routes/string/toggle"

{
  "id": "string",
  "name": "string",
  "domainId": "string",
  "domainName": null,
  "priority": 0,
  "isEnabled": true,
  "matchType": "string",
  "matchPattern": "string",
  "actions": [
    "string"
  ],
  "webhookId": null,
  "webhookName": null,
  "webhookUrl": null,
  "forwardToEmail": null,
  "forwardDestination": null,
  "rejectStatus": null,
  "rejectMessage": null,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

{  "id": "string",  "name": "string",  "domainId": "string",  "domainName": null,  "priority": 0,  "isEnabled": true,  "matchType": "string",  "matchPattern": "string",  "actions": [    "string"  ],  "webhookId": null,  "webhookName": null,  "webhookUrl": null,  "forwardToEmail": null,  "forwardDestination": null,  "rejectStatus": null,  "rejectMessage": null,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Reorder routes by priority.

POST/v1/transactional/inbound/domains/{domainId}/routes/reorder

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Path Parameters

domainId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

routeIds*array<string>

Response Body

`application/json`

curl -X POST "https://example.com/v1/transactional/inbound/domains/string/routes/reorder" \
  -H "Content-Type: application/json" \
  -d '{
    "routeIds": [
      "string"
    ]
  }'

curl -X POST "https://example.com/v1/transactional/inbound/domains/string/routes/reorder" \  -H "Content-Type: application/json" \  -d '{    "routeIds": [      "string"    ]  }'

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "domainId": "string",
      "domainName": null,
      "priority": 0,
      "isEnabled": true,
      "matchType": "string",
      "matchPattern": "string",
      "actions": [
        "string"
      ],
      "webhookId": null,
      "webhookName": null,
      "webhookUrl": null,
      "forwardToEmail": null,
      "forwardDestination": null,
      "rejectStatus": null,
      "rejectMessage": null,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "totalCount": 0
}

{  "items": [    {      "id": "string",      "name": "string",      "domainId": "string",      "domainName": null,      "priority": 0,      "isEnabled": true,      "matchType": "string",      "matchPattern": "string",      "actions": [        "string"      ],      "webhookId": null,      "webhookName": null,      "webhookUrl": null,      "forwardToEmail": null,      "forwardDestination": null,      "rejectStatus": null,      "rejectMessage": null,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "totalCount": 0}

Test which route matches a given email address.

POST/v1/transactional/inbound/domains/{domainId}/routes/test

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Path Parameters

domainId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

emailAddress*string

Response Body

`application/json`

curl -X POST "https://example.com/v1/transactional/inbound/domains/string/routes/test" \
  -H "Content-Type: application/json" \
  -d '{
    "emailAddress": "string"
  }'

curl -X POST "https://example.com/v1/transactional/inbound/domains/string/routes/test" \  -H "Content-Type: application/json" \  -d '{    "emailAddress": "string"  }'

{
  "matched": true,
  "matchedRouteId": null,
  "matchedRouteName": null,
  "actions": null
}

{  "matched": true,  "matchedRouteId": null,  "matchedRouteName": null,  "actions": null}

List inbound emails with pagination and filters.

GET/v1/transactional/inbound/emails

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Query Parameters

Limit?|

Match^-?(?:0|[1-9]\d*)$

Formatint32

Cursor?string

DomainId?string

Status?string

RouteId?string

IsSpam?boolean

From?string

Formatdate-time

To?string

Formatdate-time

Search?string

SortBy?string

SortDesc?boolean

ExcludeQuarantined?boolean

QuarantinedOnly?boolean

IncludeWebhookOnly?boolean

Response Body

`application/json`

curl -X GET "https://example.com/v1/transactional/inbound/emails"

curl -X GET "https://example.com/v1/transactional/inbound/emails"

{
  "items": [
    {
      "id": "string",
      "domainId": "string",
      "domainName": null,
      "matchedRouteId": null,
      "matchedRouteName": null,
      "fromAddress": null,
      "fromName": null,
      "subject": "string",
      "textPreview": null,
      "hasHtml": true,
      "hasText": true,
      "attachmentCount": 0,
      "sizeBytes": 0,
      "status": "string",
      "spfResult": null,
      "dkimResult": null,
      "dmarcResult": null,
      "isSpam": true,
      "spamScore": null,
      "receivedAt": "2019-08-24T14:15:22Z",
      "expiresAt": "2019-08-24T14:15:22Z",
      "actionBadge": null,
      "forwardedTo": null,
      "forwards": [
        {
          "destination": "string",
          "status": "string",
          "reason": null,
          "omittedAttachmentCount": 0,
          "messageId": null,
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z"
        }
      ]
    }
  ],
  "nextCursor": null,
  "hasMore": true
}

{  "items": [    {      "id": "string",      "domainId": "string",      "domainName": null,      "matchedRouteId": null,      "matchedRouteName": null,      "fromAddress": null,      "fromName": null,      "subject": "string",      "textPreview": null,      "hasHtml": true,      "hasText": true,      "attachmentCount": 0,      "sizeBytes": 0,      "status": "string",      "spfResult": null,      "dkimResult": null,      "dmarcResult": null,      "isSpam": true,      "spamScore": null,      "receivedAt": "2019-08-24T14:15:22Z",      "expiresAt": "2019-08-24T14:15:22Z",      "actionBadge": null,      "forwardedTo": null,      "forwards": [        {          "destination": "string",          "status": "string",          "reason": null,          "omittedAttachmentCount": 0,          "messageId": null,          "createdAt": "2019-08-24T14:15:22Z",          "updatedAt": "2019-08-24T14:15:22Z"        }      ]    }  ],  "nextCursor": null,  "hasMore": true}

List quarantined emails (spam/suspicious).

GET/v1/transactional/inbound/quarantine

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Query Parameters

limit?|

Match^-?(?:0|[1-9]\d*)$

Formatint32

Default20

cursor?string

domainId?string

from?string

Formatdate-time

to?string

Formatdate-time

search?string

Response Body

`application/json`

curl -X GET "https://example.com/v1/transactional/inbound/quarantine"

curl -X GET "https://example.com/v1/transactional/inbound/quarantine"

{
  "items": [
    {
      "id": "string",
      "domainId": "string",
      "domainName": null,
      "matchedRouteId": null,
      "matchedRouteName": null,
      "fromAddress": null,
      "fromName": null,
      "subject": "string",
      "textPreview": null,
      "hasHtml": true,
      "hasText": true,
      "attachmentCount": 0,
      "sizeBytes": 0,
      "status": "string",
      "spfResult": null,
      "dkimResult": null,
      "dmarcResult": null,
      "isSpam": true,
      "spamScore": null,
      "receivedAt": "2019-08-24T14:15:22Z",
      "expiresAt": "2019-08-24T14:15:22Z",
      "actionBadge": null,
      "forwardedTo": null,
      "forwards": [
        {
          "destination": "string",
          "status": "string",
          "reason": null,
          "omittedAttachmentCount": 0,
          "messageId": null,
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z"
        }
      ]
    }
  ],
  "nextCursor": null,
  "hasMore": true
}

{  "items": [    {      "id": "string",      "domainId": "string",      "domainName": null,      "matchedRouteId": null,      "matchedRouteName": null,      "fromAddress": null,      "fromName": null,      "subject": "string",      "textPreview": null,      "hasHtml": true,      "hasText": true,      "attachmentCount": 0,      "sizeBytes": 0,      "status": "string",      "spfResult": null,      "dkimResult": null,      "dmarcResult": null,      "isSpam": true,      "spamScore": null,      "receivedAt": "2019-08-24T14:15:22Z",      "expiresAt": "2019-08-24T14:15:22Z",      "actionBadge": null,      "forwardedTo": null,      "forwards": [        {          "destination": "string",          "status": "string",          "reason": null,          "omittedAttachmentCount": 0,          "messageId": null,          "createdAt": "2019-08-24T14:15:22Z",          "updatedAt": "2019-08-24T14:15:22Z"        }      ]    }  ],  "nextCursor": null,  "hasMore": true}

Release an email from quarantine.

POST/v1/transactional/inbound/quarantine/{publicId}/release

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Path Parameters

publicId*string

Query Parameters

addToAllowlist?boolean

Defaultfalse

Response Body

`application/json`

curl -X POST "https://example.com/v1/transactional/inbound/quarantine/string/release"

curl -X POST "https://example.com/v1/transactional/inbound/quarantine/string/release"

{
  "id": "string",
  "domainId": "string",
  "domainName": null,
  "matchedRouteId": null,
  "matchedRouteName": null,
  "fromAddress": null,
  "fromName": null,
  "subject": "string",
  "textPreview": null,
  "hasHtml": true,
  "hasText": true,
  "attachmentCount": 0,
  "sizeBytes": 0,
  "status": "string",
  "spfResult": null,
  "dkimResult": null,
  "dmarcResult": null,
  "isSpam": true,
  "spamScore": null,
  "receivedAt": "2019-08-24T14:15:22Z",
  "expiresAt": "2019-08-24T14:15:22Z",
  "actionBadge": null,
  "forwardedTo": null,
  "forwards": [
    {
      "destination": "string",
      "status": "string",
      "reason": null,
      "omittedAttachmentCount": 0,
      "messageId": null,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ]
}

{  "id": "string",  "domainId": "string",  "domainName": null,  "matchedRouteId": null,  "matchedRouteName": null,  "fromAddress": null,  "fromName": null,  "subject": "string",  "textPreview": null,  "hasHtml": true,  "hasText": true,  "attachmentCount": 0,  "sizeBytes": 0,  "status": "string",  "spfResult": null,  "dkimResult": null,  "dmarcResult": null,  "isSpam": true,  "spamScore": null,  "receivedAt": "2019-08-24T14:15:22Z",  "expiresAt": "2019-08-24T14:15:22Z",  "actionBadge": null,  "forwardedTo": null,  "forwards": [    {      "destination": "string",      "status": "string",      "reason": null,      "omittedAttachmentCount": 0,      "messageId": null,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ]}

Get inbound email details by ID.

GET/v1/transactional/inbound/emails/{publicId}

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Path Parameters

publicId*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/transactional/inbound/emails/string"

curl -X GET "https://example.com/v1/transactional/inbound/emails/string"

{
  "envelopeFrom": "string",
  "replyTo": null,
  "messageId": null,
  "inReplyTo": null,
  "dateHeader": null,
  "authResultsHeader": null,
  "spamReason": null,
  "sourceIp": null,
  "heloHostname": null,
  "processingError": null,
  "processedAt": null,
  "envelopeRecipients": [
    {
      "address": "string",
      "localPart": "string",
      "matchedRouteId": null
    }
  ],
  "headerRecipients": [
    {
      "type": "string",
      "address": "string",
      "name": null
    }
  ],
  "attachments": [
    {
      "id": "string",
      "fileName": "string",
      "contentType": "string",
      "sizeBytes": 0,
      "isInline": true,
      "contentId": null
    }
  ],
  "webhookAttempts": [
    {
      "attemptNumber": 0,
      "status": "string",
      "webhookUrl": "string",
      "httpStatusCode": null,
      "errorMessage": null,
      "durationMs": 0,
      "attemptedAt": "2019-08-24T14:15:22Z",
      "nextRetryAt": null
    }
  ],
  "id": "string",
  "domainId": "string",
  "domainName": null,
  "matchedRouteId": null,
  "matchedRouteName": null,
  "fromAddress": null,
  "fromName": null,
  "subject": "string",
  "textPreview": null,
  "hasHtml": true,
  "hasText": true,
  "attachmentCount": 0,
  "sizeBytes": 0,
  "status": "string",
  "spfResult": null,
  "dkimResult": null,
  "dmarcResult": null,
  "isSpam": true,
  "spamScore": null,
  "receivedAt": "2019-08-24T14:15:22Z",
  "expiresAt": "2019-08-24T14:15:22Z",
  "actionBadge": null,
  "forwardedTo": null,
  "forwards": [
    {
      "destination": "string",
      "status": "string",
      "reason": null,
      "omittedAttachmentCount": 0,
      "messageId": null,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ]
}

{  "envelopeFrom": "string",  "replyTo": null,  "messageId": null,  "inReplyTo": null,  "dateHeader": null,  "authResultsHeader": null,  "spamReason": null,  "sourceIp": null,  "heloHostname": null,  "processingError": null,  "processedAt": null,  "envelopeRecipients": [    {      "address": "string",      "localPart": "string",      "matchedRouteId": null    }  ],  "headerRecipients": [    {      "type": "string",      "address": "string",      "name": null    }  ],  "attachments": [    {      "id": "string",      "fileName": "string",      "contentType": "string",      "sizeBytes": 0,      "isInline": true,      "contentId": null    }  ],  "webhookAttempts": [    {      "attemptNumber": 0,      "status": "string",      "webhookUrl": "string",      "httpStatusCode": null,      "errorMessage": null,      "durationMs": 0,      "attemptedAt": "2019-08-24T14:15:22Z",      "nextRetryAt": null    }  ],  "id": "string",  "domainId": "string",  "domainName": null,  "matchedRouteId": null,  "matchedRouteName": null,  "fromAddress": null,  "fromName": null,  "subject": "string",  "textPreview": null,  "hasHtml": true,  "hasText": true,  "attachmentCount": 0,  "sizeBytes": 0,  "status": "string",  "spfResult": null,  "dkimResult": null,  "dmarcResult": null,  "isSpam": true,  "spamScore": null,  "receivedAt": "2019-08-24T14:15:22Z",  "expiresAt": "2019-08-24T14:15:22Z",  "actionBadge": null,  "forwardedTo": null,  "forwards": [    {      "destination": "string",      "status": "string",      "reason": null,      "omittedAttachmentCount": 0,      "messageId": null,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ]}

Delete an inbound email.

DELETE/v1/transactional/inbound/emails/{publicId}

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Path Parameters

publicId*string

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/transactional/inbound/emails/string"

curl -X DELETE "https://example.com/v1/transactional/inbound/emails/string"

Empty

Bulk delete inbound emails.

POST/v1/transactional/inbound/emails/bulk-delete

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

ids?array<string>

Response Body

`application/json`

curl -X POST "https://example.com/v1/transactional/inbound/emails/bulk-delete" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X POST "https://example.com/v1/transactional/inbound/emails/bulk-delete" \  -H "Content-Type: application/json" \  -d '{}'

{
  "affectedCount": 0,
  "message": null
}

{  "affectedCount": 0,  "message": null}

Bulk mark inbound emails as spam.

POST/v1/transactional/inbound/emails/bulk-mark-spam

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

ids?array<string>

addToBlocklist?boolean

Response Body

`application/json`

curl -X POST "https://example.com/v1/transactional/inbound/emails/bulk-mark-spam" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X POST "https://example.com/v1/transactional/inbound/emails/bulk-mark-spam" \  -H "Content-Type: application/json" \  -d '{}'

{
  "affectedCount": 0,
  "message": null
}

{  "affectedCount": 0,  "message": null}

Download raw email file (.eml) content.

GET/v1/transactional/inbound/emails/{publicId}/raw

Downloads the original email from R2 storage and streams it with Content-Type: message/rfc822 for .eml file download.

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Path Parameters

publicId*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/transactional/inbound/emails/string/raw"

curl -X GET "https://example.com/v1/transactional/inbound/emails/string/raw"

{
  "fileStream": "string",
  "contentType": null,
  "fileDownloadName": null,
  "lastModified": null,
  "entityTag": null,
  "enableRangeProcessing": true
}

{  "fileStream": "string",  "contentType": null,  "fileDownloadName": null,  "lastModified": null,  "entityTag": null,  "enableRangeProcessing": true}

The email's HTML and plain-text bodies, read from the stored raw MIME (UNG-268).

GET/v1/transactional/inbound/emails/{publicId}/body

The HTML is returned as data, UNSANITIZED: nothing on this origin renders it. The dashboard sanitizes it and shows it only in a sandboxed frame with no scripts, no same-origin access and remote images blocked by default. An HTML body larger than int InboundMimeContentReader.MaxHtmlBodyChars is withheld (htmlOmitted).

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Path Parameters

publicId*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/transactional/inbound/emails/string/body"

curl -X GET "https://example.com/v1/transactional/inbound/emails/string/body"

{
  "html": null,
  "text": null,
  "htmlOmitted": true
}

{  "html": null,  "text": null,  "htmlOmitted": true}

Download one attachment of an inbound email (UNG-268). Both ids are public ids; an unknown id, an attachment of a different email, or another tenant's email is 404.

GET/v1/transactional/inbound/emails/{publicId}/attachments/{attachmentId}

Streams the decoded part out of the stored raw MIME — attachments are not stored as separate objects, so there is nothing to sign a link to. Always Content-Disposition: attachment, nosniff and a sandbox CSP; the declared type is served only for the image and PDF types the dashboard previews, and everything else as application/octet-stream.

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Path Parameters

publicId*string

attachmentId*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/transactional/inbound/emails/string/attachments/string"

curl -X GET "https://example.com/v1/transactional/inbound/emails/string/attachments/string"

{
  "fileStream": "string",
  "contentType": null,
  "fileDownloadName": null,
  "lastModified": null,
  "entityTag": null,
  "enableRangeProcessing": true
}

{  "fileStream": "string",  "contentType": null,  "fileDownloadName": null,  "lastModified": null,  "entityTag": null,  "enableRangeProcessing": true}

Replay webhook delivery for an email: one durable delivery to the matched route's webhook (UNG-250 / D-161(b)). 202 only once that delivery has been committed.

POST/v1/transactional/inbound/emails/{publicId}/replay-webhook

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Path Parameters

publicId*string

Response Body

`application/json`

curl -X POST "https://example.com/v1/transactional/inbound/emails/string/replay-webhook"

curl -X POST "https://example.com/v1/transactional/inbound/emails/string/replay-webhook"

{
  "emailId": "string",
  "queued": true,
  "webhookUrl": null,
  "message": null
}

{  "emailId": "string",  "queued": true,  "webhookUrl": null,  "message": null}

Get inbound email statistics.

GET/v1/transactional/inbound/stats

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Query Parameters

domainId?string

from?string

Formatdate-time

to?string

Formatdate-time

Response Body

`application/json`

curl -X GET "https://example.com/v1/transactional/inbound/stats"

curl -X GET "https://example.com/v1/transactional/inbound/stats"

{
  "totalEmails": 0,
  "todayEmails": 0,
  "receivedCount": 0,
  "processingCount": 0,
  "processedCount": 0,
  "failedCount": 0,
  "spamCount": 0,
  "webhookFailedCount": 0,
  "storageUsedBytes": 0,
  "byDomain": [
    {
      "domainId": "string",
      "domainName": "string",
      "count": 0
    }
  ],
  "byStatus": {
    "property1": 0,
    "property2": 0
  },
  "dailyStats": [
    {
      "date": "2019-08-24T14:15:22Z",
      "total": 0,
      "processed": 0,
      "spam": 0
    }
  ]
}

{  "totalEmails": 0,  "todayEmails": 0,  "receivedCount": 0,  "processingCount": 0,  "processedCount": 0,  "failedCount": 0,  "spamCount": 0,  "webhookFailedCount": 0,  "storageUsedBytes": 0,  "byDomain": [    {      "domainId": "string",      "domainName": "string",      "count": 0    }  ],  "byStatus": {    "property1": 0,    "property2": 0  },  "dailyStats": [    {      "date": "2019-08-24T14:15:22Z",      "total": 0,      "processed": 0,      "spam": 0    }  ]}

List all inbound routes across all domains.

GET/v1/transactional/inbound/routes

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Query Parameters

limit?|

Match^-?(?:0|[1-9]\d*)$

Formatint32

Default50

cursor?string

Response Body

`application/json`

curl -X GET "https://example.com/v1/transactional/inbound/routes"

curl -X GET "https://example.com/v1/transactional/inbound/routes"

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "domainId": "string",
      "domainName": null,
      "priority": 0,
      "isEnabled": true,
      "matchType": "string",
      "matchPattern": "string",
      "actions": [
        "string"
      ],
      "webhookId": null,
      "webhookName": null,
      "webhookUrl": null,
      "forwardToEmail": null,
      "forwardDestination": null,
      "rejectStatus": null,
      "rejectMessage": null,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "nextCursor": null,
  "hasMore": true
}

{  "items": [    {      "id": "string",      "name": "string",      "domainId": "string",      "domainName": null,      "priority": 0,      "isEnabled": true,      "matchType": "string",      "matchPattern": "string",      "actions": [        "string"      ],      "webhookId": null,      "webhookName": null,      "webhookUrl": null,      "forwardToEmail": null,      "forwardDestination": null,      "rejectStatus": null,      "rejectMessage": null,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "nextCursor": null,  "hasMore": true}

List all allowlist entries, optionally filtered by domain.

GET/v1/transactional/inbound/allowlist

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Query Parameters

domainId?string

limit?|

Match^-?(?:0|[1-9]\d*)$

Formatint32

Default50

cursor?string

Response Body

`application/json`

curl -X GET "https://example.com/v1/transactional/inbound/allowlist"

curl -X GET "https://example.com/v1/transactional/inbound/allowlist"

{
  "items": [
    {
      "id": "string",
      "domainId": null,
      "domainName": null,
      "matchType": "string",
      "pattern": "string",
      "description": null,
      "isEnabled": true,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "nextCursor": null,
  "hasMore": true
}

{  "items": [    {      "id": "string",      "domainId": null,      "domainName": null,      "matchType": "string",      "pattern": "string",      "description": null,      "isEnabled": true,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "nextCursor": null,  "hasMore": true}

Create a new allowlist entry.

POST/v1/transactional/inbound/allowlist

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

domainId?null|string

matchType?string

pattern*string

description?null|string

Response Body

`application/json`

curl -X POST "https://example.com/v1/transactional/inbound/allowlist" \
  -H "Content-Type: application/json" \
  -d '{
    "pattern": "string"
  }'

curl -X POST "https://example.com/v1/transactional/inbound/allowlist" \  -H "Content-Type: application/json" \  -d '{    "pattern": "string"  }'

{
  "id": "string",
  "domainId": null,
  "domainName": null,
  "matchType": "string",
  "pattern": "string",
  "description": null,
  "isEnabled": true,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

{  "id": "string",  "domainId": null,  "domainName": null,  "matchType": "string",  "pattern": "string",  "description": null,  "isEnabled": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Get an allowlist entry by ID.

GET/v1/transactional/inbound/allowlist/{publicId}

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Path Parameters

publicId*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/transactional/inbound/allowlist/string"

curl -X GET "https://example.com/v1/transactional/inbound/allowlist/string"

{
  "id": "string",
  "domainId": null,
  "domainName": null,
  "matchType": "string",
  "pattern": "string",
  "description": null,
  "isEnabled": true,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

{  "id": "string",  "domainId": null,  "domainName": null,  "matchType": "string",  "pattern": "string",  "description": null,  "isEnabled": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Update an allowlist entry.

PUT/v1/transactional/inbound/allowlist/{publicId}

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Path Parameters

publicId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

description?null|string

isEnabled?null|boolean

Response Body

`application/json`

curl -X PUT "https://example.com/v1/transactional/inbound/allowlist/string" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X PUT "https://example.com/v1/transactional/inbound/allowlist/string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": "string",
  "domainId": null,
  "domainName": null,
  "matchType": "string",
  "pattern": "string",
  "description": null,
  "isEnabled": true,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

{  "id": "string",  "domainId": null,  "domainName": null,  "matchType": "string",  "pattern": "string",  "description": null,  "isEnabled": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Delete an allowlist entry.

DELETE/v1/transactional/inbound/allowlist/{publicId}

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Path Parameters

publicId*string

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/transactional/inbound/allowlist/string"

curl -X DELETE "https://example.com/v1/transactional/inbound/allowlist/string"

Empty

List all blocklist entries, optionally filtered by domain.

GET/v1/transactional/inbound/blocklist

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Query Parameters

domainId?string

limit?|

Match^-?(?:0|[1-9]\d*)$

Formatint32

Default50

cursor?string

Response Body

`application/json`

curl -X GET "https://example.com/v1/transactional/inbound/blocklist"

curl -X GET "https://example.com/v1/transactional/inbound/blocklist"

{
  "items": [
    {
      "id": "string",
      "domainId": null,
      "domainName": null,
      "matchType": "string",
      "pattern": "string",
      "action": "string",
      "description": null,
      "isEnabled": true,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "nextCursor": null,
  "hasMore": true
}

{  "items": [    {      "id": "string",      "domainId": null,      "domainName": null,      "matchType": "string",      "pattern": "string",      "action": "string",      "description": null,      "isEnabled": true,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "nextCursor": null,  "hasMore": true}

Create a new blocklist entry.

POST/v1/transactional/inbound/blocklist

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

domainId?null|string

matchType?string

pattern*string

action?string

description?null|string

Response Body

`application/json`

curl -X POST "https://example.com/v1/transactional/inbound/blocklist" \
  -H "Content-Type: application/json" \
  -d '{
    "pattern": "string"
  }'

curl -X POST "https://example.com/v1/transactional/inbound/blocklist" \  -H "Content-Type: application/json" \  -d '{    "pattern": "string"  }'

{
  "id": "string",
  "domainId": null,
  "domainName": null,
  "matchType": "string",
  "pattern": "string",
  "action": "string",
  "description": null,
  "isEnabled": true,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

{  "id": "string",  "domainId": null,  "domainName": null,  "matchType": "string",  "pattern": "string",  "action": "string",  "description": null,  "isEnabled": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Get a blocklist entry by ID.

GET/v1/transactional/inbound/blocklist/{publicId}

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Path Parameters

publicId*string

Response Body

`application/json`

curl -X GET "https://example.com/v1/transactional/inbound/blocklist/string"

curl -X GET "https://example.com/v1/transactional/inbound/blocklist/string"

{
  "id": "string",
  "domainId": null,
  "domainName": null,
  "matchType": "string",
  "pattern": "string",
  "action": "string",
  "description": null,
  "isEnabled": true,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

{  "id": "string",  "domainId": null,  "domainName": null,  "matchType": "string",  "pattern": "string",  "action": "string",  "description": null,  "isEnabled": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Update a blocklist entry.

PUT/v1/transactional/inbound/blocklist/{publicId}

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Path Parameters

publicId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

action?null|string

description?null|string

isEnabled?null|boolean

Response Body

`application/json`

curl -X PUT "https://example.com/v1/transactional/inbound/blocklist/string" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X PUT "https://example.com/v1/transactional/inbound/blocklist/string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": "string",
  "domainId": null,
  "domainName": null,
  "matchType": "string",
  "pattern": "string",
  "action": "string",
  "description": null,
  "isEnabled": true,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

{  "id": "string",  "domainId": null,  "domainName": null,  "matchType": "string",  "pattern": "string",  "action": "string",  "description": null,  "isEnabled": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Delete a blocklist entry.

DELETE/v1/transactional/inbound/blocklist/{publicId}

Authorization

ApiKey

X-API-Key<token>

Your API key, created in the dashboard under API keys. Production sending keys start with ml_pet_ (transactional) or ml_pem_ (marketing); sandbox keys with ml_set_ or ml_sem_.

In: header

Path Parameters

publicId*string

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/transactional/inbound/blocklist/string"

curl -X DELETE "https://example.com/v1/transactional/inbound/blocklist/string"

Empty

Inbound email

Get inbound email settings for a domain.نسخ رابط القسم

Authorizationنسخ رابط القسم

Path Parametersنسخ رابط القسم

Response Bodyنسخ رابط القسم

200application/json

404application/json

Update inbound email settings for a domain.نسخ رابط القسم

Authorizationنسخ رابط القسم

Path Parametersنسخ رابط القسم

Request Bodyنسخ رابط القسم

Response Bodyنسخ رابط القسم

200application/json

404application/json

List all routes for a domain.نسخ رابط القسم

Authorizationنسخ رابط القسم

Path Parametersنسخ رابط القسم

Response Bodyنسخ رابط القسم

200application/json

404application/json

Create a new inbound route for a domain.نسخ رابط القسم

Authorizationنسخ رابط القسم

Path Parametersنسخ رابط القسم

Request Bodyنسخ رابط القسم

Response Bodyنسخ رابط القسم

201application/json

400application/json

404application/json

Get a specific route by ID.نسخ رابط القسم

Authorizationنسخ رابط القسم

Path Parametersنسخ رابط القسم

Response Bodyنسخ رابط القسم

200application/json

404application/json

Update an existing route.نسخ رابط القسم

Authorizationنسخ رابط القسم

Path Parametersنسخ رابط القسم

Request Bodyنسخ رابط القسم

Response Bodyنسخ رابط القسم

200application/json

400application/json

404application/json

Delete a route.نسخ رابط القسم

Authorizationنسخ رابط القسم

Path Parametersنسخ رابط القسم

Response Bodyنسخ رابط القسم

204

404application/json

Get a forward destination and whether mail may be forwarded to it.نسخ رابط القسم

Authorizationنسخ رابط القسم

Path Parametersنسخ رابط القسم

Response Bodyنسخ رابط القسم

200application/json

404application/json

Send the destination's confirmation email again.نسخ رابط القسم

Authorizationنسخ رابط القسم

Path Parametersنسخ رابط القسم

Response Bodyنسخ رابط القسم

200application/json

404application/json

409application/json

429application/json

Toggle route enabled/disabled status.نسخ رابط القسم

Authorizationنسخ رابط القسم

Path Parametersنسخ رابط القسم

Response Bodyنسخ رابط القسم

200application/json

404application/json

Reorder routes by priority.نسخ رابط القسم

Authorizationنسخ رابط القسم

Path Parametersنسخ رابط القسم

Request Bodyنسخ رابط القسم

Response Bodyنسخ رابط القسم

200application/json

404application/json

Test which route matches a given email address.نسخ رابط القسم

Authorizationنسخ رابط القسم

Path Parametersنسخ رابط القسم

Request Bodyنسخ رابط القسم

Response Bodyنسخ رابط القسم

Get inbound email settings for a domain.

Authorization

Path Parameters

Response Body

`application/json`

`application/json`

Update inbound email settings for a domain.

Authorization

Path Parameters

Request Body

Response Body

`application/json`

`application/json`

List all routes for a domain.

Authorization

Path Parameters

Response Body

`application/json`

`application/json`

Create a new inbound route for a domain.

Authorization

Path Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

Get a specific route by ID.

Authorization

Path Parameters

Response Body

`application/json`

`application/json`

Update an existing route.

Authorization

Path Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

Delete a route.

Authorization

Path Parameters

Response Body

`application/json`

Get a forward destination and whether mail may be forwarded to it.

Authorization

Path Parameters

Response Body

`application/json`

`application/json`

Send the destination's confirmation email again.

Authorization

Path Parameters

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

Toggle route enabled/disabled status.

Authorization

Path Parameters

Response Body

`application/json`

`application/json`

Reorder routes by priority.

Authorization

Path Parameters

Request Body

Response Body

`application/json`

`application/json`

Test which route matches a given email address.

Authorization

Path Parameters

Request Body

Response Body

`application/json`

`application/json`