Inboxes

Receive inbound email

An inbox is the destination for inbound email. Each inbox is created inside a folder and gets a unique generated address that can receive mail from any sender.

List inboxes

get

Returns all inboxes in a folder.

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

API token in Api-Token header

Path parameters

folder_idintegerRequired

Inbound folder ID

Example: 1

Responses

200

List of inboxes

application/json

idintegerOptionalExample: 1

namestringOptionalExample: Support tickets

addressstring · emailOptional

Generated inbound address. Mail sent to this address is delivered to the inbox.

Example: [email protected]

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

get

/api/inbound/folders/{folder_id}/inboxes

cURL

curl -X GET https://mailtrap.io/api/inbound/folders/{folder_id}/inboxes \
  -H 'Authorization: Bearer YOUR_API_KEY'

[
  {
    "id": 1,
    "name": "Support tickets",
    "address": "[email protected]"
  },
  {
    "id": 2,
    "name": "Replies",
    "address": "[email protected]"
  }
]

Create an inbox

post

Create a new inbox in a folder. Mailtrap generates the inbox address automatically based on the name.

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

API token in Api-Token header

Path parameters

folder_idintegerRequired

Inbound folder ID

Example: 1

Body

application/json

namestring · max: 100RequiredExample: Support tickets

Responses

201

Inbox created

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

422

Validation error

application/json

post

/api/inbound/folders/{folder_id}/inboxes

cURL

curl -X POST https://mailtrap.io/api/inbound/folders/{folder_id}/inboxes \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Support tickets" }'

{
  "id": 1,
  "name": "Support tickets",
  "address": "[email protected]"
}

Get an inbox

get

Returns a single inbox.

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

API token in Api-Token header

Path parameters

folder_idintegerRequired

Inbound folder ID

Example: 1

inbox_idintegerRequired

Inbound inbox ID

Example: 1

Responses

200

Inbox details

application/json

idintegerOptionalExample: 1

namestringOptionalExample: Support tickets

addressstring · emailOptional

Generated inbound address. Mail sent to this address is delivered to the inbox.

Example: [email protected]

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

get

/api/inbound/folders/{folder_id}/inboxes/{inbox_id}

cURL

curl -X GET https://mailtrap.io/api/inbound/folders/{folder_id}/inboxes/{inbox_id} \
  -H 'Authorization: Bearer YOUR_API_KEY'

{
  "id": 1,
  "name": "Support tickets",
  "address": "[email protected]"
}

Delete an inbox

delete

Permanently delete an inbox and all its received messages.

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

API token in Api-Token header

Path parameters

folder_idintegerRequired

Inbound folder ID

Example: 1

inbox_idintegerRequired

Inbound inbox ID

Example: 1

Responses

204

Inbox deleted

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

delete

/api/inbound/folders/{folder_id}/inboxes/{inbox_id}

cURL

curl -X DELETE https://mailtrap.io/api/inbound/folders/{folder_id}/inboxes/{inbox_id} \
  -H 'Authorization: Bearer YOUR_API_KEY'

No content

Update an inbox

patch

Rename an inbox. The generated address does not change.

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

API token in Api-Token header

Path parameters

folder_idintegerRequired

Inbound folder ID

Example: 1

inbox_idintegerRequired

Inbound inbox ID

Example: 1

Body

application/json

namestring · max: 100RequiredExample: Support tickets

Responses

200

Inbox updated

application/json

idintegerOptionalExample: 1

namestringOptionalExample: Support tickets

addressstring · emailOptional

Generated inbound address. Mail sent to this address is delivered to the inbox.

Example: [email protected]

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

422

Validation error

application/json

patch

/api/inbound/folders/{folder_id}/inboxes/{inbox_id}

cURL

curl -X PATCH https://mailtrap.io/api/inbound/folders/{folder_id}/inboxes/{inbox_id} \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Support tickets v2" }'

{
  "id": 1,
  "name": "Support tickets",
  "address": "[email protected]"
}