# Mailtrap

Email Delivery Platform for testing and sending transactional emails

- **Category:** developer tools
- **Auth:** API_KEY, API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 49
- **Triggers:** 0
- **Slug:** `MAILTRAP`
- **Version:** 00000000_00

## Tools

### Clean Inbox

**Slug:** `MAILTRAP_CLEAN_INBOX`

Tool to clean an inbox in Mailtrap by deleting all messages. Use when you need to remove all emails from an inbox while keeping the inbox itself.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `inbox_id` | integer | Yes | Unique inbox ID to identify the specific inbox to clean. |
| `account_id` | integer | Yes | Unique account ID to identify the Mailtrap account. |

#### 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 |

### Create Contact

**Slug:** `MAILTRAP_CREATE_CONTACT`

Tool to create a new contact in Mailtrap. Use when you need to add a contact with an email address to a Mailtrap account. Optionally include custom fields and assign to contact lists.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact` | object | Yes | Contact details to create |
| `account_id` | integer | Yes | Unique account ID for the Mailtrap account |

#### 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 |

### Create Contact Event

**Slug:** `MAILTRAP_CREATE_CONTACT_EVENT`

Tool to create a contact event in Mailtrap. Use when you need to track custom events associated with a contact for segmentation or automation triggers.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Event name (max 255 characters) |
| `params` | object | No | A hash of string keys and scalar JSON values (string, number, boolean, or null) |
| `account_id` | integer | Yes | Unique account ID. You can obtain this from your Mailtrap account settings. |
| `contact_identifier` | string | Yes | Contact UUID or Email |

#### 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 |

### Create Contact Export

**Slug:** `MAILTRAP_CREATE_CONTACT_EXPORT`

Tool to create a contact export job for a Mailtrap account. Use when you need to export contacts with filters. The export is processed asynchronously - the response includes a job ID and status. Check the status field; when it becomes 'finished', the url field will contain the download link for the exported contacts file. Filters are required - you must specify at least one filter such as subscription_status (subscribed/unsubscribed) or list_id (array of list IDs).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filters` | array | Yes | Array of filters to apply when exporting contacts. Each filter specifies a field name, operator, and value. Required - must contain at least one filter. Common filters: 'subscription_status' (values: 'subscribed', 'unsubscribed') or 'list_id' (array of list IDs). |
| `account_id` | integer | Yes | Unique account ID to create the contact export for |

#### 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 |

### Create Contact Field

**Slug:** `MAILTRAP_CREATE_CONTACT_FIELD`

Tool to create a custom contact field in Mailtrap. Use when you need to add new contact attributes for personalization and segmentation in email campaigns.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the contact field (max 80 characters) |
| `data_type` | string ("text" | "integer" | "float" | "boolean" | "date") | Yes | Data type for the contact field. Choose from: text, integer, float, boolean, or date |
| `merge_tag` | string | Yes | Personalize your campaigns by adding a merge tag. This field will be replaced with unique contact details for each recipient (max 80 characters) |
| `account_id` | integer | Yes | Unique account ID |

#### 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 |

### Create Contact List

**Slug:** `MAILTRAP_CREATE_CONTACT_LIST`

Tool to create a new contact list in Mailtrap. Use when you need to organize contacts into groups or segments. Each contact list has a unique ID and name that can be used to add contacts to it later.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the contact list to create. Maximum length is 255 characters. |
| `account_id` | integer | Yes | Unique account ID |

#### 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 |

### Create Email Template

**Slug:** `MAILTRAP_CREATE_EMAIL_TEMPLATE`

Tool to create a new email template in Mailtrap account. Use when you need to create a reusable email template with HTML/text content, subject, and category. The template can be used for sending promotional, transactional, or newsletter emails.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | integer | Yes | Account ID where the email template will be created |
| `email_template` | object | Yes | Email template data containing name, subject, category, and optional HTML/text body content. Name, subject, and category are required fields. |

#### 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 |

### Create Sending Domain

**Slug:** `MAILTRAP_CREATE_SENDING_DOMAIN`

Tool to create a new sending domain in Mailtrap. Use when you need to register a domain for sending transactional emails. After creation, DNS records must be configured before the domain can be used for sending.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | integer | Yes | Account ID where the sending domain will be created |
| `sending_domain` | object | Yes | Object containing the domain configuration |

#### 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 Contact

**Slug:** `MAILTRAP_DELETE_CONTACT`

Tool to delete a contact from a Mailtrap account. Use when you need to permanently remove a contact by their UUID or email address. The deletion is permanent and cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | integer | Yes | Unique account ID for the Mailtrap account. |
| `contact_identifier` | string | Yes | Contact UUID or email address to identify the contact to 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 |

### Delete Contact Field

**Slug:** `MAILTRAP_DELETE_CONTACT_FIELD`

Tool to delete a contact field by its ID. Use when you need to remove a custom contact field from an account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `field_id` | integer | Yes | Unique Contact Field ID to delete |
| `account_id` | integer | Yes | Unique account ID where the contact field exists |

#### 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 Contact List

**Slug:** `MAILTRAP_DELETE_CONTACT_LIST`

Tool to delete a contact list by its ID. Use when you need to remove a contact list from an account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | integer | Yes | Unique list ID to delete |
| `account_id` | integer | Yes | Unique account ID |

#### 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 Email Template

**Slug:** `MAILTRAP_DELETE_EMAIL_TEMPLATE`

Tool to delete an email template from a Mailtrap account. Use when you need to remove an existing email template.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | integer | Yes | Account ID where the email template is located |
| `email_template_id` | integer | Yes | Email template ID to 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 |

### Delete Project

**Slug:** `MAILTRAP_DELETE_PROJECT`

Tool to delete a project from Mailtrap. Use when you need to permanently remove a project and its associated resources. Returns the ID of the deleted project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | integer | Yes | Unique account ID to identify the Mailtrap account. |
| `project_id` | integer | Yes | Unique project ID to identify the specific project to 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 |

### Delete Sending Domain

**Slug:** `MAILTRAP_DELETE_SENDING_DOMAIN`

Tool to delete a sending domain from a Mailtrap account. Use when you need to remove a domain permanently.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | integer | Yes | Account ID where the sending domain belongs |
| `sending_domain_id` | integer | Yes | Sending domain ID to 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 Billing Usage

**Slug:** `MAILTRAP_GET_BILLING_USAGE`

Tool to retrieve current billing cycle usage for an account. Use when you need to check billing information, usage limits, or consumption for Email Sandbox and Email Sending services.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | integer | Yes | Unique account ID |

#### 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 Contact

**Slug:** `MAILTRAP_GET_CONTACT`

Tool to retrieve a contact by UUID or email address from Mailtrap. Use when you need to fetch details of a specific contact including their subscription status, lists, and custom fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | integer | Yes | Unique account ID for the Mailtrap account |
| `contact_identifier` | string | Yes | Contact UUID or Email address to identify the contact |

#### 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 Contact Export

**Slug:** `MAILTRAP_GET_CONTACT_EXPORT`

Tool to retrieve the status of a contact export. Use when you need to check the progress of an export or download the exported contacts file.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `export_id` | integer | Yes | Unique Contact Export ID to retrieve. |
| `account_id` | integer | Yes | Unique account ID for the Mailtrap account. |

#### 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 Contact Field

**Slug:** `MAILTRAP_GET_CONTACT_FIELD`

Tool to retrieve contact field details by field ID. Use when you need to get information about a specific custom field in your contacts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `field_id` | integer | Yes | Unique Contact Field ID |
| `account_id` | integer | Yes | Unique account ID |

#### 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 Contact Import Status

**Slug:** `MAILTRAP_GET_CONTACT_IMPORT`

Tool to retrieve the status of a contact import operation. Use when you need to check the progress or completion status of a contact import. Use after initiating a contact import to monitor its status and retrieve statistics once finished.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `import_id` | integer | Yes | Unique Contact Import ID for the import operation to retrieve. |
| `account_id` | integer | Yes | Unique account ID for the Mailtrap account. |

#### 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 Contact List

**Slug:** `MAILTRAP_GET_CONTACT_LIST`

Tool to retrieve a specific contact list by its ID. Use when you need to fetch details about a contact list in a Mailtrap account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | integer | Yes | Unique list ID |
| `account_id` | integer | Yes | Unique account ID |

#### 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 Template

**Slug:** `MAILTRAP_GET_EMAIL_TEMPLATE`

Tool to retrieve details of a specific email template by ID. Use when you need to fetch template content, metadata, or configuration for an existing email template.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | integer | Yes | Account ID |
| `email_template_id` | integer | Yes | Email template ID |

#### 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 Attributes

**Slug:** `MAILTRAP_GET_INBOX`

Tool to retrieve inbox attributes from Mailtrap. Use when you need to get details about a specific inbox including its configuration, statistics, and permissions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `inbox_id` | integer | Yes | Unique inbox ID to identify the specific inbox. |
| `account_id` | integer | Yes | Unique account ID to identify the Mailtrap account. |

#### 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 Message HTML Body

**Slug:** `MAILTRAP_GET_MESSAGE_HTML`

Tool to retrieve the HTML body of a message from Mailtrap. Use when you need to get the formatted HTML content of a specific email message.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `inbox_id` | integer | Yes | Unique inbox ID to identify the specific inbox |
| `account_id` | integer | Yes | Unique account ID to identify the Mailtrap account |
| `message_id` | integer | Yes | Unique message ID to identify the specific message |

#### 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 Permission Resources

**Slug:** `MAILTRAP_GET_PERMISSION_RESOURCES`

Tool to retrieve all resources in account for permission management. Use when you need to see the hierarchical structure of projects, inboxes, and other resources with their access levels for the current authentication token.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | integer | Yes | Unique account ID for which to retrieve permission resources. |

#### 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 Project by ID

**Slug:** `MAILTRAP_GET_PROJECT`

Tool to retrieve project details from Mailtrap by project ID. Use when you need to get information about a specific project including its inboxes, permissions, and share links.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | integer | Yes | Unique account ID to identify the Mailtrap account. |
| `project_id` | integer | Yes | Unique project ID to identify the specific project. |

#### 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 Sending Domain

**Slug:** `MAILTRAP_GET_SENDING_DOMAIN`

Tool to retrieve sending domain details from Mailtrap. Use when you need to check domain configuration, DNS verification status, or tracking settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | integer | Yes | Account ID |
| `sending_domain_id` | integer | Yes | Sending domain ID |

#### 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 Sending Stats

**Slug:** `MAILTRAP_GET_SENDING_STATS`

Tool to retrieve email sending statistics from Mailtrap for a specific account. Use when you need metrics like delivery rate, bounce rate, open rate, click rate, and spam rate for a date range.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_date` | string | Yes | End date for which to include the results, in YYYY-MM-DD format. |
| `account_id` | integer | Yes | Account ID for which to retrieve sending statistics. |
| `categories` | array | No | Categories for which to include the results. If not provided, results for all categories will be included. |
| `start_date` | string | Yes | Start date for which to include the results, in YYYY-MM-DD format. |
| `sending_streams` | array | No | Sending streams for which to include the results. If not provided, results for all sending streams will be included. |
| `sending_domain_ids` | array | No | IDs of the sending domains for which to include the results. If not provided, results for all sending domains will be included. |
| `email_service_providers` | array | No | Email service providers for which to include the results. If not provided, results for all ESPs will be included. |

#### 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 Sending Stats by Categories

**Slug:** `MAILTRAP_GET_SENDING_STATS_BY_CATEGORIES`

Tool to retrieve email sending statistics grouped by categories. Use when you need to analyze email performance metrics (delivery, bounce, open, click, spam rates) segmented by email categories within a date range.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_date` | string | Yes | End date for the statistics period in YYYY-MM-DD format |
| `account_id` | integer | Yes | Account ID for which to retrieve statistics |
| `categories` | array | No | Email categories to filter results. If not provided, results for all categories will be included. |
| `start_date` | string | Yes | Start date for the statistics period in YYYY-MM-DD format |
| `sending_streams` | array | No | Sending streams to filter results (e.g., transactional, bulk). If not provided, results for all sending streams will be included. |
| `sending_domain_ids` | array | No | IDs of the sending domains to filter results. If not provided, results for all sending domains will be included. |
| `email_service_providers` | array | No | Email service providers to filter results (e.g., Google, Yahoo). If not provided, results for all ESPs will be included. |

#### 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 Sending Stats by Date

**Slug:** `MAILTRAP_GET_SENDING_STATS_BY_DATE`

Tool to retrieve email sending statistics aggregated by date. Use when you need to analyze email delivery performance, bounce rates, open rates, click rates, and spam rates for a specific date range.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_date` | string | Yes | End date for which to include the results in YYYY-MM-DD format |
| `account_id` | integer | Yes | Account ID for which to retrieve sending statistics |
| `categories` | array | No | Categories for which to include the results. If not provided, results for all categories will be included. |
| `start_date` | string | Yes | Start date for which to include the results in YYYY-MM-DD format |
| `sending_streams` | array | No | Sending streams for which to include the results. If not provided, results for all sending streams will be included. |
| `sending_domain_ids` | array | No | IDs of the sending domains for which to include the results. If not provided, results for all sending domains will be included. |
| `email_service_providers` | array | No | Email service providers for which to include the results. If not provided, results for all ESPs will be included. |

#### 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 Sending Stats by Domains

**Slug:** `MAILTRAP_GET_SENDING_STATS_BY_DOMAINS`

Tool to retrieve sending statistics grouped by domains for a Mailtrap account. Use when you need email delivery, bounce, open, click, and spam metrics broken down by sending domain for a specific date range. Supports filtering by domain IDs, sending streams, categories, and email service providers.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_date` | string | Yes | End date for which to include the results in YYYY-MM-DD format. |
| `account_id` | integer | Yes | Account ID for which to retrieve sending stats. |
| `categories` | array | No | Categories for which to include the results. If not provided, results for all categories will be included. |
| `start_date` | string | Yes | Start date for which to include the results in YYYY-MM-DD format. |
| `sending_streams` | array | No | Sending streams for which to include the results. If not provided, results for all sending streams will be included. Common values: transactional, bulk. |
| `sending_domain_ids` | array | No | IDs of the sending domains for which to include the results. If not provided, results for all sending domains will be included. |
| `email_service_providers` | array | No | Email service providers for which to include the results. If not provided, results for all ESPs will be included. Common values: Google, Yahoo, Microsoft, etc. |

#### 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 Sending Stats by ESP

**Slug:** `MAILTRAP_GET_SENDING_STATS_BY_ESP`

Tool to retrieve email sending statistics grouped by email service providers (ESPs) for a specified date range. Returns delivery, bounce, open, click, and spam metrics for each ESP. Use when you need to analyze email performance across different email providers like Google, Yahoo, Microsoft, etc.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_date` | string | Yes | End date for which to include the results in YYYY-MM-DD format |
| `account_id` | integer | Yes | Account ID for which to retrieve statistics |
| `categories` | array | No | Categories for which to include the results. If not provided, results for all categories will be included. |
| `start_date` | string | Yes | Start date for which to include the results in YYYY-MM-DD format |
| `sending_streams` | array | No | Sending streams for which to include the results. If not provided, results for all sending streams will be included. |
| `sending_domain_ids` | array | No | IDs of the sending domains for which to include the results. If not provided, results for all sending domains will be included. |
| `email_service_providers` | array | No | Email service providers for which to include the results. If not provided, results for all ESPs will be included. |

#### 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 |

### Import Contacts

**Slug:** `MAILTRAP_IMPORT_CONTACTS`

Tool to import contacts in bulk to Mailtrap. Use when you need to add or update multiple contacts at once. The import operation is asynchronous and returns a job ID that can be used to check the status later.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contacts` | array | Yes | List of contacts to import. Each contact must have an email address and can have optional custom fields and list associations. |
| `account_id` | integer | Yes | Unique account ID for the Mailtrap account. |

#### 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 Accounts

**Slug:** `MAILTRAP_LIST_ACCOUNTS`

Tool to list all Mailtrap accounts you have access to. Use when you need to retrieve account information or get account IDs for other operations. Returns account ID, name, and access levels (1000=owner, 100=admin, 10=viewer).

#### 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 Fields

**Slug:** `MAILTRAP_LIST_CONTACT_FIELDS`

Tool to get all contact fields for a Mailtrap account. Use when you need to retrieve custom field definitions for contacts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | integer | Yes | Unique account ID for the Mailtrap account. |

#### 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 Lists

**Slug:** `MAILTRAP_LIST_CONTACT_LISTS`

Tool to retrieve all contact lists for a Mailtrap account. Use when you need to view available contact lists or obtain contact list IDs for other operations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | integer | Yes | Unique account ID. You can obtain this from your Mailtrap account settings. |

#### 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:** `MAILTRAP_LIST_EMAIL_TEMPLATES`

Tool to retrieve all email templates for a Mailtrap account. Use when you need to list available templates, browse template configurations, or find a specific template by name or attributes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | integer | Yes | Account ID |

#### 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:** `MAILTRAP_LIST_INBOXES`

Tool to get a list of inboxes for a Mailtrap account. Use when you need to retrieve all inboxes associated with an account ID. Returns the list of inboxes with their configuration, permissions, and statistics.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | integer | Yes | Unique account ID to list inboxes for |

#### 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 Messages in Inbox

**Slug:** `MAILTRAP_LIST_MESSAGES`

Tool to get messages from a Mailtrap inbox. Use when you need to retrieve emails from a specific inbox, with support for search filtering and pagination. Returns up to 30 messages per request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (30 messages per page). Use this for offset-based pagination. |
| `search` | string | No | Filter emails by subject, to_email, or to_name (case insensitive). Use this to search for specific messages. |
| `last_id` | integer | No | Get messages with ID less than this value for cursor-based pagination. Alternative to page parameter. |
| `inbox_id` | integer | Yes | Unique inbox ID to identify the specific inbox |
| `account_id` | integer | Yes | Unique account ID to identify the Mailtrap account |

#### 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 Projects

**Slug:** `MAILTRAP_LIST_PROJECTS`

Tool to get a list of projects for a Mailtrap account. Use when you need to retrieve all projects and their associated inboxes for a specific account. Returns project attributes, permissions, and nested inbox information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | integer | Yes | Unique account ID to list projects for |

#### 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 Sending Domains

**Slug:** `MAILTRAP_LIST_SENDING_DOMAINS`

Tool to list all sending domains for a Mailtrap account. Use when you need to retrieve configured domains for email sending.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | integer | Yes | Account ID to list sending domains for |

#### 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 Suppressions

**Slug:** `MAILTRAP_LIST_SUPPRESSIONS`

Tool to list suppressed email addresses for a Mailtrap account. Use when you need to view which emails are blocked from receiving messages due to bounces, complaints, unsubscribes, or manual suppression.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | Search for a specific email address. Use this to check if a particular email is suppressed. |
| `end_time` | string | No | Search emails suppressed before this timestamp in ISO 8601 format (e.g., 2025-12-31T23:59:59Z). |
| `account_id` | integer | Yes | Account ID to list suppressions for. This is your Mailtrap account identifier. |
| `start_time` | string | No | Search emails suppressed after this timestamp in ISO 8601 format (e.g., 2025-01-01T00:00:00Z). |

#### 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 |

### Mark Inbox as Read

**Slug:** `MAILTRAP_MARK_INBOX_AS_READ`

Tool to mark all messages in a Mailtrap inbox as read. Use when you need to mark all unread messages as read in a specific inbox.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `inbox_id` | integer | Yes | Unique inbox ID to identify the specific inbox |
| `account_id` | integer | Yes | Unique account ID to identify the Mailtrap account |

#### 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 |

### Reset Inbox Credentials

**Slug:** `MAILTRAP_RESET_INBOX_CREDENTIALS`

Tool to reset SMTP credentials for a Mailtrap inbox. Use when you need to regenerate the username and password for inbox access.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `inbox_id` | integer | Yes | Unique inbox ID to identify the specific inbox. |
| `account_id` | integer | Yes | Unique account ID to identify the Mailtrap account. |

#### 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 contact

**Slug:** `MAILTRAP_UPDATE_CONTACT`

Tool to update an existing contact in Mailtrap. Use when you need to modify contact details such as email, custom fields, list memberships, or subscription status. If the contact doesn't exist, it will be created.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact` | object | Yes | Contact data to update. At least one field must be provided |
| `account_id` | integer | Yes | Unique account ID |
| `contact_identifier` | string | Yes | Contact UUID or Email 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 |

### Update Contact Field

**Slug:** `MAILTRAP_UPDATE_CONTACT_FIELD`

Tool to update a contact field in Mailtrap. Use when you need to modify the name or merge tag of an existing contact field.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the contact field |
| `field_id` | integer | Yes | Unique Contact Field ID |
| `merge_tag` | string | No | Personalize your campaigns by adding a merge tag. This field will be replaced with unique contact details for each recipient. |
| `account_id` | integer | Yes | Unique account ID |

#### 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 Contact List

**Slug:** `MAILTRAP_UPDATE_CONTACT_LIST`

Tool to update a contact list's name in Mailtrap. Use when you need to rename an existing contact list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | New name for the contact list. Maximum length is 255 characters. |
| `list_id` | integer | Yes | Unique list ID |
| `account_id` | integer | Yes | Unique account ID |

#### 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 Email Template

**Slug:** `MAILTRAP_UPDATE_EMAIL_TEMPLATE`

Tool to update an existing email template in Mailtrap account. Use when you need to modify template properties such as name, subject, category, HTML body, or plain text body. All fields in the email_template object are optional - only provide the fields you want to update.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | integer | Yes | Account ID to which the email template belongs |
| `email_template` | object | Yes | Email template data containing fields to update. At least name, subject, and category are required. |
| `email_template_id` | integer | Yes | Email template ID to update |

#### 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:** `MAILTRAP_UPDATE_INBOX`

Tool to update an inbox's settings in Mailtrap. Use when you need to change the inbox name or email username.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `inbox` | object | Yes | Inbox data to update. Provide at least one field (name or email_username) to update. |
| `inbox_id` | integer | Yes | Unique inbox ID |
| `account_id` | integer | Yes | Unique account ID |

#### 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 project

**Slug:** `MAILTRAP_UPDATE_PROJECT`

Tool to update a project's name in Mailtrap. Use when you need to rename an existing project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project` | object | Yes | Project data to update. Must provide the new project name. |
| `account_id` | integer | Yes | Unique account ID |
| `project_id` | integer | Yes | Unique project ID |

#### 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 |