---
canonical_url: "https://docs.composio.dev/toolkits/mailslurp"
markdown_url: "https://docs.composio.dev/toolkits/mailslurp.md"
product: "platform"
version: null
last_updated: null
---

# MailSlurp

MailSlurp provides programmable email and SMS inboxes, sending, testing, webhooks, and deliverability tools through a REST API.

- **Category:** email
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 14
- **Triggers:** 0
- **Slug:** `MAILSLURP`
- **Version:** 00000000_00

## Tools

### Create Inbox

**Slug:** `MAILSLURP_CREATE_INBOX`

Create a MailSlurp HTTP or SMTP inbox. HTTP inboxes are the default and can send and receive; SMTP inboxes are receive-only.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Human-readable inbox name, also usable as the sender display name. |
| `tags` | array | No | Tags used to group and search inboxes. |
| `prefix` | string | No | Optional prefix for an automatically assigned email address. |
| `domain_id` | string | No | Optional verified custom-domain UUID. |
| `favourite` | boolean | No | Mark the new inbox as a favorite. |
| `expires_at` | string | No | Optional ISO-8601 expiration timestamp; do not combine with expires_in. |
| `expires_in` | integer | No | Optional lifetime in milliseconds; do not combine with expires_at. |
| `inbox_type` | string ("HTTP_INBOX" | "SMTP_INBOX") | No | HTTP_INBOX for send/receive workflows or SMTP_INBOX for receive-only workflows. |
| `description` | string | No | Description used for labeling and search. |
| `domain_name` | string | No | Optional verified domain name used with an assigned local part. |
| `email_address` | string | No | Optional address on a verified custom domain; omit for an assigned MailSlurp address. |
| `virtual_inbox` | boolean | No | Prevent real outbound delivery while still creating sent-email records. |
| `use_domain_pool` | boolean | No | Use MailSlurp's varied domain pool for an HTTP inbox. |
| `use_short_address` | boolean | No | Request an automatically generated address shorter than 31 characters. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Inbox

**Slug:** `MAILSLURP_DELETE_INBOX`

Permanently delete one MailSlurp inbox by UUID, including its email address and all emails it contains. This destructive action cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `inbox_id` | string | Yes | Exact inbox UUID to permanently delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account Info

**Slug:** `MAILSLURP_GET_ACCOUNT_INFO`

Return the connected MailSlurp account identity, state, account type, subscription type, and creation time. Use this to check account availability before attempting quota- or plan-sensitive operations.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Email

**Slug:** `MAILSLURP_GET_EMAIL`

Get one fully hydrated received email by UUID, including parsed headers, body content, recipients, and attachment IDs. Fetching hydrated content may mark the email as read.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_id` | string | Yes | Email UUID returned by list emails. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inbox

**Slug:** `MAILSLURP_GET_INBOX`

Get one MailSlurp inbox by UUID, including its email address, type, labels, and lifecycle state.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `inbox_id` | string | Yes | Inbox UUID returned by create or list inboxes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Contact Groups

**Slug:** `MAILSLURP_LIST_CONTACT_GROUPS`

List saved MailSlurp contact groups with optional creation-time filters. Returns one page and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Maximum groups in this page (1-100). |
| `sort` | string ("ASC" | "DESC") | No | Sort by creation time: ASC or DESC. |
| `since` | string | No | Only groups created at or after this ISO-8601 timestamp. |
| `before` | string | No | Only groups created before this ISO-8601 timestamp. |
| `next_cursor` | string | No | Opaque cursor returned by the previous page; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Contacts

**Slug:** `MAILSLURP_LIST_CONTACTS`

List saved MailSlurp contacts with optional search and creation-time filters. Returns one page and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Maximum contacts in this page (1-100). |
| `sort` | string ("ASC" | "DESC") | No | Sort by creation time: ASC or DESC. |
| `since` | string | No | Only contacts created at or after this ISO-8601 timestamp. |
| `before` | string | No | Only contacts created before this ISO-8601 timestamp. |
| `search` | string | No | Search contact names and addresses. |
| `next_cursor` | string | No | Opaque cursor returned by the previous page; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Domains

**Slug:** `MAILSLURP_LIST_DOMAINS`

List custom domains configured for the connected MailSlurp account, including identifiers, domain type, and DNS verification state.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Emails

**Slug:** `MAILSLURP_LIST_EMAILS`

List received emails across the account or one selected inbox with unread, exact-search, favorite, plus-address, and time filters. Returns one page and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Maximum emails in this page (1-100). |
| `sort` | string ("ASC" | "DESC") | No | Sort by received time: ASC or DESC. |
| `since` | string | No | Only emails received at or after this ISO-8601 timestamp. Set this explicitly to avoid the provider's default previous-24-hours window. |
| `before` | string | No | Only emails received before this ISO-8601 timestamp. |
| `inbox_id` | string | No | Inbox UUID to include; omit to search all account inboxes. |
| `favourited` | boolean | No | When set, filter by favorite status. |
| `next_cursor` | string | No | Opaque cursor returned by the previous page; omit for the first page. |
| `unread_only` | boolean | No | Return unread emails only. |
| `search_filter` | string | No | Exact match against email ID, inbox ID, sender, receiving address, or plus address. |
| `plus_address_id` | string | No | Optional plus-address UUID filter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Inboxes

**Slug:** `MAILSLURP_LIST_INBOXES`

List MailSlurp inboxes with optional search, tag, type, domain, favorite, and creation-time filters. Returns one page and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag` | string | No | Return inboxes containing this tag. |
| `size` | integer | No | Maximum inboxes in this page (1-100). |
| `sort` | string ("ASC" | "DESC") | No | Sort by creation time: ASC or DESC. |
| `since` | string | No | Only inboxes created at or after this ISO-8601 timestamp. |
| `before` | string | No | Only inboxes created before this ISO-8601 timestamp. |
| `search` | string | No | Partial search over inbox name and email address. |
| `domain_id` | string | No | Filter by custom domain UUID. |
| `favourite` | boolean | No | When set, filter by favorite status. |
| `inbox_type` | string ("HTTP_INBOX" | "SMTP_INBOX") | No | Filter by HTTP_INBOX or SMTP_INBOX. |
| `next_cursor` | string | No | Opaque cursor returned by the previous page; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Sent Emails

**Slug:** `MAILSLURP_LIST_SENT_EMAILS`

List sent-email records, optionally filtered by source inbox, exact identifier/address search, and creation time. Returns one page and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Maximum sent-email records in this page (1-100). |
| `sort` | string ("ASC" | "DESC") | No | Sort by creation time: ASC or DESC. |
| `since` | string | No | Only records created at or after this ISO-8601 timestamp. |
| `before` | string | No | Only records created before this ISO-8601 timestamp. |
| `inbox_id` | string | No | Only messages sent from this inbox UUID. |
| `next_cursor` | string | No | Opaque cursor returned by the previous page; omit for the first page. |
| `search_filter` | string | No | Exact match for sent-email ID, inbox ID, sender, or reply-to address. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Email Templates

**Slug:** `MAILSLURP_LIST_TEMPLATES`

List saved MailSlurp email templates with optional creation-time filters. Returns one page and a continuation cursor without large template bodies.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Maximum templates in this page (1-100). |
| `sort` | string ("ASC" | "DESC") | No | Sort by creation time: ASC or DESC. |
| `since` | string | No | Only templates created at or after this ISO-8601 timestamp. |
| `before` | string | No | Only templates created before this ISO-8601 timestamp. |
| `next_cursor` | string | No | Opaque cursor returned by the previous page; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send Email

**Slug:** `MAILSLURP_SEND_EMAIL`

Send an email from a specific MailSlurp inbox to addresses, saved contacts, or one contact group. Supports plain text or HTML, uploaded attachment IDs, and saved templates. The legacy endpoint confirms acceptance but does not return a sent-email record.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cc` | array | No | CC recipient addresses. |
| `to` | array | No | RFC 5322 recipient addresses; provide this, contact_ids, or contact_group_id. |
| `bcc` | array | No | BCC recipient addresses. |
| `body` | string | No | Plain-text or HTML body; omit when template_id supplies the body. |
| `is_html` | boolean | No | Set true when body contains HTML. |
| `subject` | string | No | Email subject. |
| `inbox_id` | string | Yes | HTTP inbox UUID to send from; SMTP inboxes cannot send. |
| `reply_to` | string | No | Optional Reply-To address. |
| `contact_ids` | array | No | Saved contact UUIDs; each contact receives a separate message. |
| `template_id` | string | No | Saved template UUID; do not combine with body because the template overrides it. |
| `attachment_ids` | array | No | Previously uploaded MailSlurp attachment IDs. |
| `use_inbox_name` | boolean | No | Use the inbox name as the sender display name. |
| `contact_group_id` | string | No | Saved contact-group UUID; recipients receive separate messages. |
| `add_tracking_pixel` | boolean | No | Add an open-tracking pixel. |
| `template_variables` | object | No | Values for moustache variables used by the subject, body, or saved template. |
| `filter_bounced_recipients` | boolean | No | Remove recipients previously recorded as bounced. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Inbox

**Slug:** `MAILSLURP_UPDATE_INBOX`

Update an inbox's name, description, tags, expiration, or favorite status. Provide at least one field to update. The inbox email address cannot be changed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New inbox name; omit to leave unchanged. |
| `tags` | array | No | Replacement tag list; omit to leave unchanged. |
| `inbox_id` | string | Yes | Inbox UUID to update. |
| `favourite` | boolean | No | New favorite status; omit to leave unchanged. |
| `expires_at` | string | No | New ISO-8601 expiration timestamp; omit to leave unchanged or set null to make the inbox permanent. |
| `description` | string | No | New inbox description; omit to leave unchanged. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |