Inboxes

Manage test inboxes

Interactions with inboxes

Create an inbox

post

Create an inbox in a project.

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

account_idinteger · int64 · min: 1Required

Unique account ID

Example: 3229

project_idinteger · int64 · min: 1Required

Unique project ID

Example: 4032

Body

application/json

Responses

200

Returns attributes of the inbox.

• permissions returns the permissions of the token for the inbox.

application/json

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

404

Returns not found error message

application/json

post

/api/accounts/{account_id}/projects/{project_id}/inboxes

Node.jsPHPPython.NETJavacURL

import { MailtrapClient } from "mailtrap";

const client = new MailtrapClient({
  token: "YOUR_API_TOKEN",
  accountId: ACCOUNT_ID
});

const inbox = await client.testing.inboxes.create(
  projectId,
  'My Test Inbox'
);

console.log(`Inbox created: ${inbox.name}`);
console.log(`SMTP credentials - User: ${inbox.username}`);

{
  "id": 3538,
  "name": "Admin Inbox",
  "username": "b3a87978452ae1",
  "password": "6be9fcfc613a7c",
  "max_size": 0,
  "status": "active",
  "email_username": "b7eae548c3-54c542",
  "email_username_enabled": false,
  "sent_messages_count": 52,
  "forwarded_messages_count": 0,
  "used": false,
  "forward_from_email_address": "[email protected]",
  "project_id": 2293,
  "domain": "localhost",
  "pop3_domain": "localhost",
  "email_domain": "localhost",
  "api_domain": "localhost",
  "emails_count": 0,
  "emails_unread_count": 0,
  "last_message_sent_at": null,
  "smtp_ports": [
    25,
    465,
    587,
    2525
  ],
  "pop3_ports": [
    1100,
    9950
  ],
  "max_message_size": 5242880,
  "permissions": {
    "can_read": true,
    "can_update": true,
    "can_destroy": true,
    "can_leave": true
  }
}

Get inbox attributes

get

Get inbox attributes by inbox id. See the list of attributes in the example

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

account_idinteger · int64 · min: 1Required

Unique account ID

Example: 3229

inbox_idinteger · int64 · min: 1Required

Unique inbox ID

Example: 4015

Responses

200

Returns attributes of the inbox.

• permissions returns the permissions of the token for the inbox.

application/json

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

404

Returns not found error message

application/json

get

/api/accounts/{account_id}/inboxes/{inbox_id}

Node.jsPHPPython.NETJavacURL

const { MailtrapClient } = require("mailtrap");

const TOKEN = "YOUR_API_KEY";
const ACCOUNT_ID = "YOUR_ACCOUNT_ID";

const client = new MailtrapClient({ token: TOKEN, accountId: ACCOUNT_ID });

const inboxId = 12345;
const inboxAttributes = await client.testing.inboxes.getInboxAttributes(inboxId);

console.log(inboxAttributes);

{
  "id": 3538,
  "name": "Admin Inbox",
  "username": "b3a87978452ae1",
  "password": "6be9fcfc613a7c",
  "max_size": 0,
  "status": "active",
  "email_username": "b7eae548c3-54c542",
  "email_username_enabled": false,
  "sent_messages_count": 52,
  "forwarded_messages_count": 0,
  "used": false,
  "forward_from_email_address": "[email protected]",
  "project_id": 2293,
  "domain": "localhost",
  "pop3_domain": "localhost",
  "email_domain": "localhost",
  "api_domain": "localhost",
  "emails_count": 0,
  "emails_unread_count": 0,
  "last_message_sent_at": null,
  "smtp_ports": [
    25,
    465,
    587,
    2525
  ],
  "pop3_ports": [
    1100,
    9950
  ],
  "max_message_size": 5242880,
  "permissions": {
    "can_read": true,
    "can_update": true,
    "can_destroy": true,
    "can_leave": true
  }
}

Delete an inbox

delete

Delete an inbox with all its emails.

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

account_idinteger · int64 · min: 1Required

Unique account ID

Example: 3229

inbox_idinteger · int64 · min: 1Required

Unique inbox ID

Example: 4015

Responses

200

Returns attributes of the inbox.

• permissions returns the permissions of the token for the inbox.

application/json

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

404

Returns not found error message

application/json

delete

/api/accounts/{account_id}/inboxes/{inbox_id}

Node.jsPHPPython.NETJavacURL

const { MailtrapClient } = require("mailtrap");

const TOKEN = "YOUR_API_KEY";
const ACCOUNT_ID = "YOUR_ACCOUNT_ID";

const client = new MailtrapClient({ token: TOKEN, accountId: ACCOUNT_ID });

const inboxId = 12345;
const result = await client.testing.inboxes.delete(inboxId);

console.log(result);

{
  "id": 3538,
  "name": "Admin Inbox",
  "username": "b3a87978452ae1",
  "password": "6be9fcfc613a7c",
  "max_size": 0,
  "status": "active",
  "email_username": "b7eae548c3-54c542",
  "email_username_enabled": false,
  "sent_messages_count": 52,
  "forwarded_messages_count": 0,
  "used": false,
  "forward_from_email_address": "[email protected]",
  "project_id": 2293,
  "domain": "localhost",
  "pop3_domain": "localhost",
  "email_domain": "localhost",
  "api_domain": "localhost",
  "emails_count": 0,
  "emails_unread_count": 0,
  "last_message_sent_at": null,
  "smtp_ports": [
    25,
    465,
    587,
    2525
  ],
  "pop3_ports": [
    1100,
    9950
  ],
  "max_message_size": 5242880,
  "permissions": {
    "can_read": true,
    "can_update": true,
    "can_destroy": true,
    "can_leave": true
  }
}

Update an inbox

patch

Update inbox name, inbox email username.

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

account_idinteger · int64 · min: 1Required

Unique account ID

Example: 3229

inbox_idinteger · int64 · min: 1Required

Unique inbox ID

Example: 4015

Body

application/json

Responses

200

Returns attributes of the inbox.

• permissions returns the permissions of the token for the inbox.

application/json

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

404

Returns not found error message

application/json

patch

/api/accounts/{account_id}/inboxes/{inbox_id}

Node.jsPHPPython.NETJavacURL

const { MailtrapClient } = require("mailtrap");

const TOKEN = "YOUR_API_KEY";
const ACCOUNT_ID = "YOUR_ACCOUNT_ID";

const client = new MailtrapClient({ token: TOKEN, accountId: ACCOUNT_ID });

const inboxId = 12345;
const updatedInbox = await client.testing.inboxes.updateInbox(
  inboxId,
  { name: 'Updated Inbox Name', emailUsername: 'new-username' }
);

console.log(updatedInbox);

{
  "id": 3538,
  "name": "Admin Inbox",
  "username": "b3a87978452ae1",
  "password": "6be9fcfc613a7c",
  "max_size": 0,
  "status": "active",
  "email_username": "b7eae548c3-54c542",
  "email_username_enabled": false,
  "sent_messages_count": 52,
  "forwarded_messages_count": 0,
  "used": false,
  "forward_from_email_address": "[email protected]",
  "project_id": 2293,
  "domain": "localhost",
  "pop3_domain": "localhost",
  "email_domain": "localhost",
  "api_domain": "localhost",
  "emails_count": 0,
  "emails_unread_count": 0,
  "last_message_sent_at": null,
  "smtp_ports": [
    25,
    465,
    587,
    2525
  ],
  "pop3_ports": [
    1100,
    9950
  ],
  "max_message_size": 5242880,
  "permissions": {
    "can_read": true,
    "can_update": true,
    "can_destroy": true,
    "can_leave": true
  }
}

Clean inbox

patch

Delete all messages (emails) from inbox.

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

account_idinteger · int64 · min: 1Required

Unique account ID

Example: 3229

inbox_idinteger · int64 · min: 1Required

Unique inbox ID

Example: 4015

Responses

200

Returns attributes of the inbox.

• permissions returns the permissions of the token for the inbox.

application/json

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

404

Returns not found error message

application/json

patch

/api/accounts/{account_id}/inboxes/{inbox_id}/clean

Node.jsPHPPython.NETJavacURL

const { MailtrapClient } = require("mailtrap");

const TOKEN = "YOUR_API_KEY";
const ACCOUNT_ID = "YOUR_ACCOUNT_ID";

const client = new MailtrapClient({ token: TOKEN, accountId: ACCOUNT_ID });

const inboxId = 12345;
const result = await client.testing.inboxes.clean(inboxId);

console.log(result);

{
  "id": 3538,
  "name": "Admin Inbox",
  "username": "b3a87978452ae1",
  "password": "6be9fcfc613a7c",
  "max_size": 0,
  "status": "active",
  "email_username": "b7eae548c3-54c542",
  "email_username_enabled": false,
  "sent_messages_count": 52,
  "forwarded_messages_count": 0,
  "used": false,
  "forward_from_email_address": "[email protected]",
  "project_id": 2293,
  "domain": "localhost",
  "pop3_domain": "localhost",
  "email_domain": "localhost",
  "api_domain": "localhost",
  "emails_count": 0,
  "emails_unread_count": 0,
  "last_message_sent_at": null,
  "smtp_ports": [
    25,
    465,
    587,
    2525
  ],
  "pop3_ports": [
    1100,
    9950
  ],
  "max_message_size": 5242880,
  "permissions": {
    "can_read": true,
    "can_update": true,
    "can_destroy": true,
    "can_leave": true
  }
}

Mark as read

patch

Mark all messages in the inbox as read.

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

account_idinteger · int64 · min: 1Required

Unique account ID

Example: 3229

inbox_idinteger · int64 · min: 1Required

Unique inbox ID

Example: 4015

Responses

200

Returns attributes of the inbox.

• permissions returns the permissions of the token for the inbox.

application/json

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

404

Returns not found error message

application/json

patch

/api/accounts/{account_id}/inboxes/{inbox_id}/all_read

Node.jsPHPPython.NETJavacURL

const { MailtrapClient } = require("mailtrap");

const TOKEN = "YOUR_API_KEY";
const ACCOUNT_ID = "YOUR_ACCOUNT_ID";

const client = new MailtrapClient({ token: TOKEN, accountId: ACCOUNT_ID });

const inboxId = 12345;
const result = await client.testing.inboxes.markAsRead(inboxId);

console.log(result);

{
  "id": 3538,
  "name": "Admin Inbox",
  "username": "b3a87978452ae1",
  "password": "6be9fcfc613a7c",
  "max_size": 0,
  "status": "active",
  "email_username": "b7eae548c3-54c542",
  "email_username_enabled": false,
  "sent_messages_count": 52,
  "forwarded_messages_count": 0,
  "used": false,
  "forward_from_email_address": "[email protected]",
  "project_id": 2293,
  "domain": "localhost",
  "pop3_domain": "localhost",
  "email_domain": "localhost",
  "api_domain": "localhost",
  "emails_count": 0,
  "emails_unread_count": 0,
  "last_message_sent_at": null,
  "smtp_ports": [
    25,
    465,
    587,
    2525
  ],
  "pop3_ports": [
    1100,
    9950
  ],
  "max_message_size": 5242880,
  "permissions": {
    "can_read": true,
    "can_update": true,
    "can_destroy": true,
    "can_leave": true
  }
}

Reset credentials

patch

Reset SMTP credentials of the inbox.

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

account_idinteger · int64 · min: 1Required

Unique account ID

Example: 3229

inbox_idinteger · int64 · min: 1Required

Unique inbox ID

Example: 4015

Responses

200

Returns attributes of the inbox.

• permissions returns the permissions of the token for the inbox.

application/json

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

404

Returns not found error message

application/json

patch

/api/accounts/{account_id}/inboxes/{inbox_id}/reset_credentials

Node.jsPHPPython.NETJavacURL

const { MailtrapClient } = require("mailtrap");

const TOKEN = "YOUR_API_KEY";
const ACCOUNT_ID = "YOUR_ACCOUNT_ID";

const client = new MailtrapClient({ token: TOKEN, accountId: ACCOUNT_ID });

const inboxId = 12345;
const result = await client.testing.inboxes.resetCredentials(inboxId);

console.log(result);

{
  "id": 3538,
  "name": "Admin Inbox",
  "username": "b3a87978452ae1",
  "password": "6be9fcfc613a7c",
  "max_size": 0,
  "status": "active",
  "email_username": "b7eae548c3-54c542",
  "email_username_enabled": false,
  "sent_messages_count": 52,
  "forwarded_messages_count": 0,
  "used": false,
  "forward_from_email_address": "[email protected]",
  "project_id": 2293,
  "domain": "localhost",
  "pop3_domain": "localhost",
  "email_domain": "localhost",
  "api_domain": "localhost",
  "emails_count": 0,
  "emails_unread_count": 0,
  "last_message_sent_at": null,
  "smtp_ports": [
    25,
    465,
    587,
    2525
  ],
  "pop3_ports": [
    1100,
    9950
  ],
  "max_message_size": 5242880,
  "permissions": {
    "can_read": true,
    "can_update": true,
    "can_destroy": true,
    "can_leave": true
  }
}

Enable email address

patch

Turn the email address of the inbox on/off.

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

account_idinteger · int64 · min: 1Required

Unique account ID

Example: 3229

inbox_idinteger · int64 · min: 1Required

Unique inbox ID

Example: 4015

Responses

200

Returns attributes of the inbox.

• permissions returns the permissions of the token for the inbox.

application/json

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

404

Returns not found error message

application/json

patch

/api/accounts/{account_id}/inboxes/{inbox_id}/toggle_email_username

Node.jsPHPPython.NETJavacURL

const { MailtrapClient } = require("mailtrap");

const TOKEN = "YOUR_API_KEY";
const ACCOUNT_ID = "YOUR_ACCOUNT_ID";

const client = new MailtrapClient({ token: TOKEN, accountId: ACCOUNT_ID });

const inboxId = 12345;
const result = await client.testing.inboxes.enableEmailAddress(inboxId);

console.log(result);

{
  "id": 3538,
  "name": "Admin Inbox",
  "username": "b3a87978452ae1",
  "password": "6be9fcfc613a7c",
  "max_size": 0,
  "status": "active",
  "email_username": "b7eae548c3-54c542",
  "email_username_enabled": false,
  "sent_messages_count": 52,
  "forwarded_messages_count": 0,
  "used": false,
  "forward_from_email_address": "[email protected]",
  "project_id": 2293,
  "domain": "localhost",
  "pop3_domain": "localhost",
  "email_domain": "localhost",
  "api_domain": "localhost",
  "emails_count": 0,
  "emails_unread_count": 0,
  "last_message_sent_at": null,
  "smtp_ports": [
    25,
    465,
    587,
    2525
  ],
  "pop3_ports": [
    1100,
    9950
  ],
  "max_message_size": 5242880,
  "permissions": {
    "can_read": true,
    "can_update": true,
    "can_destroy": true,
    "can_leave": true
  }
}

Reset email address

patch

Reset username of email address per inbox.

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

account_idinteger · int64 · min: 1Required

Unique account ID

Example: 3229

inbox_idinteger · int64 · min: 1Required

Unique inbox ID

Example: 4015

Responses

200

Returns attributes of the inbox.

• permissions returns the permissions of the token for the inbox.

application/json

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

404

Returns not found error message

application/json

patch

/api/accounts/{account_id}/inboxes/{inbox_id}/reset_email_username

Node.jsPHPPython.NETJavacURL

const { MailtrapClient } = require("mailtrap");

const TOKEN = "YOUR_API_KEY";
const ACCOUNT_ID = "YOUR_ACCOUNT_ID";

const client = new MailtrapClient({ token: TOKEN, accountId: ACCOUNT_ID });

const inboxId = 12345;
const result = await client.testing.inboxes.resetEmailAddress(inboxId);

console.log(result);

{
  "id": 3538,
  "name": "Admin Inbox",
  "username": "b3a87978452ae1",
  "password": "6be9fcfc613a7c",
  "max_size": 0,
  "status": "active",
  "email_username": "b7eae548c3-54c542",
  "email_username_enabled": false,
  "sent_messages_count": 52,
  "forwarded_messages_count": 0,
  "used": false,
  "forward_from_email_address": "[email protected]",
  "project_id": 2293,
  "domain": "localhost",
  "pop3_domain": "localhost",
  "email_domain": "localhost",
  "api_domain": "localhost",
  "emails_count": 0,
  "emails_unread_count": 0,
  "last_message_sent_at": null,
  "smtp_ports": [
    25,
    465,
    587,
    2525
  ],
  "pop3_ports": [
    1100,
    9950
  ],
  "max_message_size": 5242880,
  "permissions": {
    "can_read": true,
    "can_update": true,
    "can_destroy": true,
    "can_leave": true
  }
}

Get a list of inboxes

get

Get a list of inboxes.

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

account_idinteger · int64 · min: 1Required

Unique account ID

Example: 3229

Responses

200

Returns the list of inboxes in the account to which the API token has access.

• permissions returns the permissions of the token for the inbox.

application/json

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

get

/api/accounts/{account_id}/inboxes

Node.jsPHPPython.NETJavacURL

const { MailtrapClient } = require("mailtrap");

const TOKEN = "YOUR_API_KEY";
const ACCOUNT_ID = "YOUR_ACCOUNT_ID";

const client = new MailtrapClient({ token: TOKEN, accountId: ACCOUNT_ID });

const inboxes = await client.testing.inboxes.getList();

console.log(inboxes);

[
  {
    "id": 3538,
    "name": "Admin Inbox",
    "username": "b3a87978452ae1",
    "password": "6be9fcfc613a7c",
    "max_size": 0,
    "status": "active",
    "email_username": "b7eae548c3-54c542",
    "email_username_enabled": false,
    "sent_messages_count": 52,
    "forwarded_messages_count": 0,
    "used": false,
    "forward_from_email_address": "[email protected]",
    "project_id": 2293,
    "domain": "localhost",
    "pop3_domain": "localhost",
    "email_domain": "localhost",
    "emails_count": 0,
    "emails_unread_count": 0,
    "last_message_sent_at": null,
    "smtp_ports": [
      25,
      465,
      587,
      2525
    ],
    "pop3_ports": [
      1100,
      9950
    ],
    "max_message_size": 5242880,
    "permissions": {
      "can_read": true,
      "can_update": true,
      "can_destroy": true,
      "can_leave": true
    }
  },
  {
    "id": 4089,
    "name": "Viewer Inbox",
    "username": "1d0aa0282f7712",
    "password": "5667a20f611ae7",
    "max_size": 0,
    "status": "active",
    "email_username": "f25402f8df-b77899",
    "email_username_enabled": false,
    "sent_messages_count": 527,
    "forwarded_messages_count": 0,
    "used": false,
    "forward_from_email_address": "[email protected]",
    "project_id": 2293,
    "domain": "localhost",
    "pop3_domain": "localhost",
    "email_domain": "localhost",
    "emails_count": 0,
    "emails_unread_count": 0,
    "last_message_sent_at": null,
    "smtp_ports": [
      25,
      465,
      587,
      2525
    ],
    "pop3_ports": [
      1100,
      9950
    ],
    "max_message_size": 5242880,
    "permissions": {
      "can_read": true,
      "can_update": false,
      "can_destroy": false,
      "can_leave": true
    }
  }
]