Mailtrap

https://docs.mailtrap.io/
Admin
Mailtrap is a complete email infrastructure platform for developers to send production emails, test...
Tokens:623,682
Snippets:5,191
Trust Score:10
Update:1 day ago
Show doc for...
Tokens:
Raw
### Install Mailtrap Go SDK

Source: https://docs.mailtrap.io/developers

Install the Mailtrap Go SDK using go get.

```bash
go get github.com/mailtrap/mailtrap-go
```

--------------------------------

### Query documentation via HTTP GET request

Source: https://docs.mailtrap.io/developers/account-management/api-tokens/get-api-token.md

Example HTTP GET request to query this documentation page with 'ask' and 'goal' query parameters. Use this to retrieve additional information not present on the page.

```http
GET https://docs.mailtrap.io/developers/account-management/api-tokens/get-api-token.md?ask=<question>&goal=<user_goal>
```

--------------------------------

### Example response for GET /api/sandboxes

Source: https://docs.mailtrap.io/developers/email-sandbox/sandboxes/get-a-list-of-sandboxes

Shows a 200 response with an array of sandbox objects. Each object includes fields like id, name, username, password (only if admin), status, and permissions. The example includes two sandboxes with different permission sets.

```json
[
  {
    "id": 3538,
    "name": "Admin Sandbox",
    "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": "a3538-i4088@forward.mailtrap.info",
    "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 Sandbox",
    "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": "a3538-i4089@forward.mailtrap.info",
    "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
    }
  }
]
```

--------------------------------

### 200 response for create project

Source: https://docs.mailtrap.io/developers/email-sandbox/projects/create-project

Example response returned when a project is successfully created. Contains the project ID, name, share links, sandboxes array, and permissions.

```json
{
  "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"
  },
  "sandboxes": [],
  "permissions": {
    "can_read": true,
    "can_update": true,
    "can_destroy": true,
    "can_leave": false
  }
}
```

--------------------------------

### Example response for get contact import

Source: https://docs.mailtrap.io/developers/email-marketing/contacts/bulk-import/get-contact-import

Example 200 OK response showing an import with status 'started'. When status is 'finished', additional fields like created_contacts_count are included.

```json
{
  "id": 1,
  "status": "started"
}
```

--------------------------------

### Example response for listing projects

Source: https://docs.mailtrap.io/developers/email-sandbox/projects/get-a-list-of-projects

Shows a 200 response with project attributes and sandboxes. The 'permissions' field indicates token permissions for each project.

```json
[
  {
    "id": 2435,
    "name": "Viewer Project",
    "sandboxes": [],
    "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"
    },
    "sandboxes": [
      {
        "id": 3874,
        "name": "Admin Sandbox",
        "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": "a3343-i3874@forward.mailtrap.info",
        "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
    }
  }
]
```

--------------------------------

### Install Mailtrap node via npm

Source: https://docs.mailtrap.io/guides/integrations/n8n.md

Command to manually install the Mailtrap node for local N8N setup. Run in your terminal.

```bash
npm install n8n-nodes-mailtrap
```

--------------------------------

### Example response for listing account accesses

Source: https://docs.mailtrap.io/developers/account-management/access-control/list-user-and-invite-account-accesses

Shows a 200 OK response with an array of account access objects, including specifier details, resources, and permissions.

```json
[
  {
    "id": 42,
    "specifier_type": "User",
    "specifier": {
      "id": 1,
      "email": "name@gmail.com",
      "name": "text",
      "two_factor_authentication_enabled": true
    },
    "resources": [
      {
        "resource_id": 1,
        "resource_type": "account",
        "access_level": 1000
      }
    ],
    "permissions": {
      "can_read": true,
      "can_update": true,
      "can_destroy": true,
      "can_leave": true
    }
  }
]
```

--------------------------------

### Example response for getting an inbox

Source: https://docs.mailtrap.io/developers/inbound/inboxes/get-an-inbox

Example JSON response returned with status 200 when the inbox is found. It includes the inbox id, name, address, and domain_id.

```json
{
  "id": 1,
  "name": "Support tickets",
  "address": "support-tickets-1a2b3c4d@inbound-mailtrap.io",
  "domain_id": 892
}
```

--------------------------------

### Example response for getting a forward rule

Source: https://docs.mailtrap.io/developers/inbound/forward-rules/get-a-forward-rule

Example JSON response for a successful request (200). Shows the forward rule details including conditions and destinations.

```json
{
  "data": {
    "id": 9,
    "name": "Escalate urgent tickets",
    "created_at": "2026-05-08T10:30:00.000Z",
    "updated_at": "2026-05-08T12:15:00.000Z",
    "conditions": [
      {
        "match_type": "header",
        "operator": "equal",
        "value": "high",
        "header_key": "X-Priority-Level"
      },
      {
        "match_type": "recipient",
        "operator": "starts_with",
        "value": "support",
        "header_key": null
      }
    ],
    "destinations": [
      {
        "email": "oncall@example.com"
      },
      {
        "email": "lead@example.com"
      }
    ]
  }
}
```

--------------------------------

### Create a project for sandbox

Source: https://docs.mailtrap.io/for-ai-agents/tools/mailtrap-cli-app

Creates a project for your sandbox and returns a project ID.

```bash
mailtrap projects create --name "My Project"
```

--------------------------------

### Example response for listing inbound folders

Source: https://docs.mailtrap.io/developers/inbound/folders/list-folders

Example JSON response returned by the GET /api/inbound/folders endpoint. Shows a list of folders with id and name fields.

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

--------------------------------

### Response: Folder created (201)

Source: https://docs.mailtrap.io/developers/inbound/folders/create-a-folder

Example JSON response for a successful folder creation, containing the folder's id and name.

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

--------------------------------

### Example response for getting a contact list

Source: https://docs.mailtrap.io/developers/email-marketing/contacts/contact-lists/get-contact-list

Example JSON response returned when the request is successful (HTTP 200). It contains the contact list's id and name.

```json
{
  "id": 26730,
  "name": "My Contact List"
}
```

--------------------------------

### Install Mailtrap .NET SDK

Source: https://docs.mailtrap.io/developers

Install the Mailtrap .NET package from the GitHub source.

```bash
dotnet add package Mailtrap -s github-mailtrap
```

--------------------------------

### Example JSON response for GET /api/permissions/resources

Source: https://docs.mailtrap.io/developers/account-management/permissions/get-resources

This is an example response showing the nested resource tree. The access_level field represents the access level of the token used to make the request.

```json
[
  {
    "id": 1774100,
    "name": "Account",
    "type": "account",
    "access_level": 100,
    "resources": [
      {
        "id": 1774100,
        "name": "Templates",
        "type": "email_template_permission_scope",
        "access_level": 100,
        "resources": []
      },
      {
        "id": 2550469,
        "name": "My Project",
        "type": "project",
        "access_level": 100,
        "resources": [
          {
            "id": 4117907,
            "name": "My Sandbox",
            "type": "sandbox",
            "access_level": 100,
            "resources": []
          }
        ]
      }
    ]
  }
]
```

--------------------------------

### Example response for get all contact fields

Source: https://docs.mailtrap.io/developers/email-marketing/contacts/contact-fields/get-all-contact-fields

Example JSON response returned by the API when the request is successful. It contains an array of contact field objects with id, name, data_type, and merge_tag.

```json
[
  {
    "id": 6730,
    "name": "First name",
    "data_type": "text",
    "merge_tag": "first_name"
  },
  {
    "id": 6731,
    "name": "Birthdate",
    "data_type": "date",
    "merge_tag": "birthdate"
  },
  {
    "id": 6732,
    "name": "Cats count",
    "data_type": "integer",
    "merge_tag": "cats_count"
  }
]
```

--------------------------------

### Example response for get API token

Source: https://docs.mailtrap.io/developers/account-management/api-tokens/get-api-token

Example JSON response for a successful 200 request, showing the token details including id, name, last_4_digits, created_by, expires_at, and resources.

```json
{
  "id": 12345,
  "name": "My API Token",
  "last_4_digits": "x7k9",
  "created_by": "user@example.com",
  "expires_at": null,
  "resources": [
    {
      "resource_type": "account",
      "resource_id": 3229,
      "access_level": 100
    }
  ]
}
```

--------------------------------

### Install Composio SDK for Python

Source: https://docs.mailtrap.io/guides/integrations/composio.md

Install the composio package for Python projects.

```bash
pip install composio
```

--------------------------------

### Example JSON response for GET /api/domains

Source: https://docs.mailtrap.io/developers/email-sending/domains/list-domains

This is the example response body returned with a 200 status code. It shows a list of domains with their verification status, DNS records, tracking settings, and permissions.

```json
{
  "data": [
    {
      "id": 435,
      "domain_name": "mailtrap.io",
      "demo": false,
      "compliance_status": "compliant",
      "dns_verified": true,
      "dns_verified_at": "2024-12-26T09:40:44.161Z",
      "dns_records": [
        {
          "key": "verification",
          "domain": "ve6wza2rbpe60x7z.mailtrap.io",
          "type": "CNAME",
          "value": "smtp.mailtrap.live",
          "status": "pass",
          "name": "ve6wza2rbpe60x7z"
        },
        {
          "key": "dkim1",
          "domain": "rwmt1._domainkey.mailtrap.io",
          "type": "CNAME",
          "value": "rwmt1.dkim.smtp.mailtrap.live",
          "status": "pass",
          "name": "rwmt1._domainkey"
        },
        {
          "key": "dkim2",
          "domain": "rwmt2._domainkey.mailtrap.io",
          "type": "CNAME",
          "value": "rwmt2.dkim.smtp.mailtrap.live",
          "status": "pass",
          "name": "rwmt2._domainkey"
        },
        {
          "key": "dmarc",
          "domain": "_dmarc.mailtrap.io",
          "type": "TXT",
          "value": "v=DMARC1; p=none; rua=mailto:dmarc@smtp.mailtrap.live; ruf=mailto:dmarc@smtp.mailtrap.live; rf=afrf; pct=100",
          "status": "pass",
          "name": "_dmarc"
        },
        {
          "key": "link_verification",
          "domain": "mt-link.mailtrap.io",
          "type": "CNAME",
          "value": "t.mailtrap.live",
          "status": "pass",
          "name": "mt-link"
        },
        {
          "key": "inbound_mx",
          "domain": "mailtrap.io",
          "type": "MX",
          "value": "inbound-mailtrap.io",
          "status": "pass",
          "name": "@"
        }
      ],
      "open_tracking_enabled": true,
      "click_tracking_enabled": true,
      "tracking_opt_out_enabled": false,
      "auto_unsubscribe_link_enabled": true,
      "custom_domain_tracking_enabled": true,
      "health_alerts_enabled": true,
      "critical_alerts_enabled": true,
      "alert_recipient_email": "john.doe@mailtrap.io",
      "inbound_enabled": true,
      "inbound_verified": true,
      "permissions": {
        "can_read": true,
        "can_update": true,
        "can_destroy": true
      }
    }
  ]
}
```
Tokens:
Raw