Folders

Organize inbound inboxes

Folders group inbound inboxes within an account. Every inbox belongs to exactly one folder.

List folders

get

Returns all inbound folders in the account.

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

API token in Api-Token header

Responses

200

List of folders

application/json

idintegerOptionalExample: 1

namestringOptionalExample: Support

401

Unauthorized

application/json

403

Forbidden

application/json

get

/api/inbound/folders

cURL

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

[
  {
    "id": 1,
    "name": "Support"
  },
  {
    "id": 2,
    "name": "Sales"
  }
]

Create a folder

post

Create a new inbound folder.

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

API token in Api-Token header

Body

application/json

namestring · max: 100RequiredExample: Support

Responses

201

Folder created

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

422

Validation error

application/json

post

/api/inbound/folders

cURL

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

{
  "id": 1,
  "name": "Support"
}

Get a folder

get

Returns a single inbound folder.

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

API token in Api-Token header

Path parameters

folder_idintegerRequired

Inbound folder ID

Example: 1

Responses

200

Folder details

application/json

idintegerOptionalExample: 1

namestringOptionalExample: Support

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

get

/api/inbound/folders/{folder_id}

cURL

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

{
  "id": 1,
  "name": "Support"
}

Delete a folder

delete

Permanently delete an inbound folder along with all of its inboxes.

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

API token in Api-Token header

Path parameters

folder_idintegerRequired

Inbound folder ID

Example: 1

Responses

204

Folder deleted

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

delete

/api/inbound/folders/{folder_id}

cURL

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

No content

Update a folder

patch

Update an inbound folder.

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

Responses

200

Folder updated

application/json

idintegerOptionalExample: 1

namestringOptionalExample: Support

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

422

Validation error

application/json

patch

/api/inbound/folders/{folder_id}

cURL

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

{
  "id": 1,
  "name": "Support"
}