Projects

Organize test environments

Interactions with projects

Get a list of projects

get

List projects and their inboxes to which the API token has access.

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

Lists project attributes and inboxes of this project with their attributes.

• permissions returns the permissions of the token for the project

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}/projects

Node.jsPHPPythonRuby.NETJavacURL

import { MailtrapClient } from "mailtrap";

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

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

projects.forEach(project => {
  console.log(`Project: ${project.name}, ID: ${project.id}`);
});

[
  {
    "id": 2435,
    "name": "Viewer Project",
    "inboxes": [],
    "permissions": {
      "can_read": true,
      "can_update": false,
      "can_destroy": false,
      "can_leave": true
    }
  },
  {
    "id": 2436,
    "name": "Admin Project",
    "share_links": {
      "admin": "https://localhost/projects/2436/share/QEVuQwEAYWN-NIhmrB8qX6ZWzToqdOE9dw1ylIfOQ-_fKwYAD_CCkhRzmAanker219x25PM75TBaHgx1I4dsv058hghY_Ewaa3Vt7ET1aeg3ufVcit919V4baPLzxV9JaRzXWSjK",
      "viewer": "https://localhost/projects/2436/share/QEVuQwEAYWN-NIhmrB8qX6ZWzToqdOE9dw1ylIfOQ-_fKwYAD_CCkhRzmAanker219x25PM7YSu12_li4QtOGl363syqCpKX7vlXvIub7b_V1BU2qypVHfspL7qfSIja0edd7hSh"
    },
    "inboxes": [
      {
        "id": 3874,
        "name": "Admin Inbox",
        "username": "f796d276ca4d13",
        "password": "293caeb0f100e4",
        "max_size": 0,
        "status": "active",
        "email_username": "bcf11679c1-ad3171",
        "email_username_enabled": false,
        "sent_messages_count": 316,
        "forwarded_messages_count": 0,
        "used": false,
        "forward_from_email_address": "[email protected]",
        "project_id": 2436,
        "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": false
        }
      }
    ],
    "permissions": {
      "can_read": true,
      "can_update": true,
      "can_destroy": true,
      "can_leave": true
    }
  }
]

Create project

post

The project name is min 2 characters and max 100 characters long.

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

account_idinteger · int64 · min: 1Required

Unique account ID

Example: 3229

Body

application/json

Responses

200

Returns project details

application/json

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

post

/api/accounts/{account_id}/projects

Node.jsPHPPythonRuby.NETJavacURL

import { MailtrapClient } from "mailtrap";

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

const project = await client.testing.projects.create({
  name: 'My New Project'
});

console.log(project);

{
  "id": 2388,
  "name": "My New Project",
  "share_links": {
    "admin": "https://localhost/projects/2388/share/QEVuQwEAS-hQfYV1hqw15p7p9VcsuCrASDQUkcuV_N5G-zdVBPrd58V8Ce09AUl-JGFEJsQbt-K6IzRIMhjpU7zxAnIo9QpB8mJwuOqBiottfwdDhgKO-ab7t7WDCyyoGeG5dLK_",
    "viewer": "https://localhost/projects/2388/share/QEVuQwEAS-hQfYV1hqw15p7p9VcsuCrASDQUkcuV_N5G-zdVBPrd58V8Ce09AUl-JGFEJsQbHDFqI6Mk2wRVlVSxLNMgI-3LnWpSSSyCSbjqkQRAMPVoTPYF7WcXfw4H_CwkAc4e"
  },
  "inboxes": [],
  "permissions": {
    "can_read": true,
    "can_update": true,
    "can_destroy": true,
    "can_leave": false
  }
}

Get project by ID

get

Get the project and its 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

project_idinteger · int64 · min: 1Required

Unique project ID

Example: 4032

Responses

200

Returns project details

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}/projects/{project_id}

Node.jsPHPPythonRuby.NETJavacURL

import { MailtrapClient } from "mailtrap";

const client = new MailtrapClient({
  token: process.env.MAILTRAP_API_KEY,
  accountId: YOUR_ACCOUNT_ID
});

const projectId = 12345;
const project = await client.testing.projects.get(projectId);

console.log("Project:", project);

{
  "id": 2388,
  "name": "My New Project",
  "share_links": {
    "admin": "https://localhost/projects/2388/share/QEVuQwEAS-hQfYV1hqw15p7p9VcsuCrASDQUkcuV_N5G-zdVBPrd58V8Ce09AUl-JGFEJsQbt-K6IzRIMhjpU7zxAnIo9QpB8mJwuOqBiottfwdDhgKO-ab7t7WDCyyoGeG5dLK_",
    "viewer": "https://localhost/projects/2388/share/QEVuQwEAS-hQfYV1hqw15p7p9VcsuCrASDQUkcuV_N5G-zdVBPrd58V8Ce09AUl-JGFEJsQbHDFqI6Mk2wRVlVSxLNMgI-3LnWpSSSyCSbjqkQRAMPVoTPYF7WcXfw4H_CwkAc4e"
  },
  "inboxes": [],
  "permissions": {
    "can_read": true,
    "can_update": true,
    "can_destroy": true,
    "can_leave": false
  }
}

Delete project

delete

Delete project and its 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

project_idinteger · int64 · min: 1Required

Unique project ID

Example: 4032

Responses

200

Returns id of the deleted project.

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}/projects/{project_id}

Node.jsPHPPythonRuby.NETJavacURL

import { MailtrapClient } from "mailtrap";

const client = new MailtrapClient({
  token: process.env.MAILTRAP_API_KEY,
  accountId: YOUR_ACCOUNT_ID
});

const projectId = 12345;
const result = await client.testing.projects.delete(projectId);

console.log("Project deleted:", result);

{
  "id": 4046
}

Update project

patch

Update project name. The project name is min 2 characters and max 100 characters long.

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 updated project details

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}/projects/{project_id}

Node.jsPHPPythonRuby.NETJavacURL

import { MailtrapClient } from "mailtrap";

const client = new MailtrapClient({
  token: process.env.MAILTRAP_API_KEY,
  accountId: YOUR_ACCOUNT_ID
});

const projectId = 12345;
const updatedProject = await client.testing.projects.update(
  projectId,
  "Updated Project Name"
);

console.log("Project updated:", updatedProject);

{
  "id": 2436,
  "name": "Admin Project",
  "share_links": {
    "admin": "https://localhost/projects/2436/share/QEVuQwEAYWN-NIhmrB8qX6ZWzToqdOE9dw1ylIfOQ-_fKwYAD_CCkhRzmAanker219x25PM75TBaHgx1I4dsv058hghY_Ewaa3Vt7ET1aeg3ufVcit919V4baPLzxV9JaRzXWSjK",
    "viewer": "https://localhost/projects/2436/share/QEVuQwEAYWN-NIhmrB8qX6ZWzToqdOE9dw1ylIfOQ-_fKwYAD_CCkhRzmAanker219x25PM7YSu12_li4QtOGl363syqCpKX7vlXvIub7b_V1BU2qypVHfspL7qfSIja0edd7hSh"
  },
  "inboxes": [
    {
      "id": 3874,
      "name": "Admin Inbox",
      "username": "f796d276ca4d13",
      "password": "293caeb0f100e4",
      "max_size": 0,
      "status": "active",
      "email_username": "bcf11679c1-ad3171",
      "email_username_enabled": false,
      "sent_messages_count": 316,
      "forwarded_messages_count": 0,
      "used": false,
      "forward_from_email_address": "[email protected]",
      "project_id": 2436,
      "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": false
      }
    }
  ],
  "permissions": {
    "can_read": true,
    "can_update": true,
    "can_destroy": true,
    "can_leave": true
  }
}