> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# mailtrap-sending
> Mailtrap Sending - domains, email logs, statistics, suppressions, and templates
**Server path:** `/mailtrap-sending` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- |
| [`mailtrap_sending_create_email_template`](#mailtrap_sending_create_email_template) | Create Email Template |
| [`mailtrap_sending_create_sending_domain`](#mailtrap_sending_create_sending_domain) | Create sending domain |
| [`mailtrap_sending_create_sending_domain_company_info`](#mailtrap_sending_create_sending_domain_company_info) | Create company info |
| [`mailtrap_sending_delete_domain`](#mailtrap_sending_delete_domain) | Delete sending domain |
| [`mailtrap_sending_delete_email_template`](#mailtrap_sending_delete_email_template) | Delete Email Template |
| [`mailtrap_sending_delete_suppression`](#mailtrap_sending_delete_suppression) | Delete suppression |
| [`mailtrap_sending_email_templates`](#mailtrap_sending_email_templates) | Get all Email Templates |
| [`mailtrap_sending_get_account_sending_stats`](#mailtrap_sending_get_account_sending_stats) | Get Sending Stats |
| [`mailtrap_sending_get_account_sending_stats_by_categories`](#mailtrap_sending_get_account_sending_stats_by_categories) | Get Sending Stats by Categories |
| [`mailtrap_sending_get_account_sending_stats_by_date`](#mailtrap_sending_get_account_sending_stats_by_date) | Get Sending Stats by Date |
| [`mailtrap_sending_get_account_sending_stats_by_domains`](#mailtrap_sending_get_account_sending_stats_by_domains) | Get Sending Stats by Domains |
| [`mailtrap_sending_get_account_sending_stats_by_email_service_providers`](#mailtrap_sending_get_account_sending_stats_by_email_service_providers) | Get Sending Stats by Email Service Providers |
| [`mailtrap_sending_get_domain`](#mailtrap_sending_get_domain) | Get sending domain |
| [`mailtrap_sending_get_domain_company_info`](#mailtrap_sending_get_domain_company_info) | Get company info |
| [`mailtrap_sending_get_domains`](#mailtrap_sending_get_domains) | List sending domains |
| [`mailtrap_sending_get_email_log_message`](#mailtrap_sending_get_email_log_message) | Get an email log message by ID |
| [`mailtrap_sending_get_email_template`](#mailtrap_sending_get_email_template) | Get Email Template |
| [`mailtrap_sending_get_suppressions`](#mailtrap_sending_get_suppressions) | List suppressions |
| [`mailtrap_sending_list_email_logs`](#mailtrap_sending_list_email_logs) | List email logs |
| [`mailtrap_sending_send_sending_domain_setup_instructions`](#mailtrap_sending_send_sending_domain_setup_instructions) | Send setup instructions |
| [`mailtrap_sending_update_email_template`](#mailtrap_sending_update_email_template) | Update Email Template |
| [`mailtrap_sending_update_sending_domain`](#mailtrap_sending_update_sending_domain) | Update sending domain |
| [`mailtrap_sending_update_sending_domain_company_info`](#mailtrap_sending_update_sending_domain_company_info) | Update company info |
***
## mailtrap\_sending\_create\_email\_template
Create Email Template
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------- | -------- | ------- | ----------------- |
| `account_id` | integer | Yes | — | Unique account ID |
| `email_template` | object | Yes | — | Email Template |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "integer",
"description": "Unique account ID"
},
"email_template": {
"type": "object",
"description": "Email Template",
"properties": {
"name": {
"type": "string",
"description": "The name value"
},
"category": {
"type": "string",
"description": "The category value"
},
"subject": {
"type": "string",
"description": "The subject value"
},
"body_text": {
"type": "string",
"description": "Body Text"
},
"body_html": {
"type": "string",
"description": "Body Html"
}
},
"required": [
"name",
"subject",
"category"
]
}
},
"required": [
"PCID",
"account_id",
"email_template"
]
}
```
***
## mailtrap\_sending\_create\_sending\_domain
Create sending domain
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------- | -------- | ------- | ----------------- |
| `account_id` | integer | Yes | — | Unique account ID |
| `sending_domain` | object | Yes | — | Sending Domain |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "integer",
"description": "Unique account ID"
},
"sending_domain": {
"type": "object",
"description": "Sending Domain",
"properties": {
"domain_name": {
"type": "string",
"description": "Your domain name"
}
},
"required": [
"domain_name"
]
}
},
"required": [
"PCID",
"account_id",
"sending_domain"
]
}
```
***
## mailtrap\_sending\_create\_sending\_domain\_company\_info
Create company info
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | ------- | -------- | ------- | ----------------- |
| `account_id` | integer | Yes | — | Unique account ID |
| `sending_domain_id` | integer | Yes | — | Sending domain ID |
| `company_info` | object | Yes | — | Company Info |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "integer",
"description": "Unique account ID"
},
"sending_domain_id": {
"type": "integer",
"description": "Sending domain ID"
},
"company_info": {
"type": "object",
"description": "Company Info",
"properties": {
"name": {
"type": "string",
"description": "Company or individual name"
},
"address": {
"type": "string",
"description": "Street address"
},
"city": {
"type": "string",
"description": "The city value"
},
"country": {
"type": "string",
"description": "The country value"
},
"phone": {
"type": "string",
"description": "Phone number"
},
"zip_code": {
"type": "string",
"description": "ZIP or postal code"
},
"privacy_policy_url": {
"type": "string",
"description": "URL to the privacy policy page"
},
"terms_of_service_url": {
"type": "string",
"description": "URL to the terms of service page"
},
"website_url": {
"type": "string",
"description": "Company website URL"
},
"info_level": {
"type": "string",
"description": "Whether the sender is a business or individual",
"enum": [
"business",
"individual"
]
}
},
"required": [
"name",
"address",
"city",
"country",
"zip_code",
"website_url"
]
}
},
"required": [
"PCID",
"account_id",
"sending_domain_id",
"company_info"
]
}
```
***
## mailtrap\_sending\_delete\_domain
Delete sending domain
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | ------- | -------- | ------- | ----------------- |
| `account_id` | integer | Yes | — | Unique account ID |
| `sending_domain_id` | integer | Yes | — | Sending domain ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "integer",
"description": "Unique account ID"
},
"sending_domain_id": {
"type": "integer",
"description": "Sending domain ID"
}
},
"required": [
"PCID",
"account_id",
"sending_domain_id"
]
}
```
***
## mailtrap\_sending\_delete\_email\_template
Delete Email Template
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | ------- | -------- | ------- | ----------------- |
| `account_id` | integer | Yes | — | Unique account ID |
| `email_template_id` | integer | Yes | — | Email template ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "integer",
"description": "Unique account ID"
},
"email_template_id": {
"type": "integer",
"description": "Email template ID"
}
},
"required": [
"PCID",
"account_id",
"email_template_id"
]
}
```
***
## mailtrap\_sending\_delete\_suppression
Delete suppression
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------- | -------- | ------- | ----------------- |
| `account_id` | integer | Yes | — | Unique account ID |
| `suppression_id` | integer | Yes | — | Suppression ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "integer",
"description": "Unique account ID"
},
"suppression_id": {
"type": "integer",
"description": "Suppression ID"
}
},
"required": [
"PCID",
"account_id",
"suppression_id"
]
}
```
***
## mailtrap\_sending\_email\_templates
Get all Email Templates
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ----------------- |
| `account_id` | integer | Yes | — | Unique account ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "integer",
"description": "Unique account ID"
}
},
"required": [
"PCID",
"account_id"
]
}
```
***
## mailtrap\_sending\_get\_account\_sending\_stats
Get Sending Stats
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------------- | ---------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `account_id` | integer | Yes | — | Unique account ID |
| `start_date` | string | Yes | — | Start date for which to include the results. |
| `end_date` | string | Yes | — | End date for which to include the results. |
| `sending_domain_ids[]` | integer\[] | No | — | IDs of the sending domains for which to include the results. If not provided, results for all sending domains will be included. |
| `sending_streams[]` | string\[] | No | — | Sending streams for which to include the results. If not provided, results for all sending streams will be included. |
| `categories[]` | string\[] | No | — | Categories for which to include the results. If not provided, results for all categories will be included. |
| `email_service_providers[]` | string\[] | No | — | Email service providers for which to include the results. If not provided, results for all ESPs will be included. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "integer",
"description": "Unique account ID"
},
"start_date": {
"type": "string",
"description": "Start date for which to include the results."
},
"end_date": {
"type": "string",
"description": "End date for which to include the results."
},
"sending_domain_ids[]": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "IDs of the sending domains for which to include the results. If not provided, results for all sending domains will be included."
},
"sending_streams[]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"transactional",
"bulk"
]
},
"description": "Sending streams for which to include the results. If not provided, results for all sending streams will be included."
},
"categories[]": {
"type": "array",
"items": {
"type": "string"
},
"description": "Categories for which to include the results. If not provided, results for all categories will be included."
},
"email_service_providers[]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"Google",
"Yahoo",
"Outlook",
"Hey",
"Google Workspace",
"Zoho Email",
"ProtonMail",
"Yandex",
"iCloud",
"Office 365",
"Amazon SES (Simple Email Service)",
"Proofpoint Email Protection",
"Mimecast Email Protection",
"GMX.net",
"Rackspace",
"OVH hosted",
"Linode hosted",
"GoDaddy",
"Symantec Email Protection",
"Barracuda Email Protection",
"Cisco Email Protection",
"FastMail",
"Naver",
"Seznam",
"Comcast",
"Spectrum"
]
},
"description": "Email service providers for which to include the results. If not provided, results for all ESPs will be included."
}
},
"required": [
"PCID",
"account_id",
"start_date",
"end_date"
]
}
```
***
## mailtrap\_sending\_get\_account\_sending\_stats\_by\_categories
Get Sending Stats by Categories
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------------- | ---------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `account_id` | integer | Yes | — | Unique account ID |
| `start_date` | string | Yes | — | Start date for which to include the results. |
| `end_date` | string | Yes | — | End date for which to include the results. |
| `sending_domain_ids[]` | integer\[] | No | — | IDs of the sending domains for which to include the results. If not provided, results for all sending domains will be included. |
| `sending_streams[]` | string\[] | No | — | Sending streams for which to include the results. If not provided, results for all sending streams will be included. |
| `categories[]` | string\[] | No | — | Categories for which to include the results. If not provided, results for all categories will be included. |
| `email_service_providers[]` | string\[] | No | — | Email service providers for which to include the results. If not provided, results for all ESPs will be included. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "integer",
"description": "Unique account ID"
},
"start_date": {
"type": "string",
"description": "Start date for which to include the results."
},
"end_date": {
"type": "string",
"description": "End date for which to include the results."
},
"sending_domain_ids[]": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "IDs of the sending domains for which to include the results. If not provided, results for all sending domains will be included."
},
"sending_streams[]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"transactional",
"bulk"
]
},
"description": "Sending streams for which to include the results. If not provided, results for all sending streams will be included."
},
"categories[]": {
"type": "array",
"items": {
"type": "string"
},
"description": "Categories for which to include the results. If not provided, results for all categories will be included."
},
"email_service_providers[]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"Google",
"Yahoo",
"Outlook",
"Hey",
"Google Workspace",
"Zoho Email",
"ProtonMail",
"Yandex",
"iCloud",
"Office 365",
"Amazon SES (Simple Email Service)",
"Proofpoint Email Protection",
"Mimecast Email Protection",
"GMX.net",
"Rackspace",
"OVH hosted",
"Linode hosted",
"GoDaddy",
"Symantec Email Protection",
"Barracuda Email Protection",
"Cisco Email Protection",
"FastMail",
"Naver",
"Seznam",
"Comcast",
"Spectrum"
]
},
"description": "Email service providers for which to include the results. If not provided, results for all ESPs will be included."
}
},
"required": [
"PCID",
"account_id",
"start_date",
"end_date"
]
}
```
***
## mailtrap\_sending\_get\_account\_sending\_stats\_by\_date
Get Sending Stats by Date
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------------- | ---------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `account_id` | integer | Yes | — | Unique account ID |
| `start_date` | string | Yes | — | Start date for which to include the results. |
| `end_date` | string | Yes | — | End date for which to include the results. |
| `sending_domain_ids[]` | integer\[] | No | — | IDs of the sending domains for which to include the results. If not provided, results for all sending domains will be included. |
| `sending_streams[]` | string\[] | No | — | Sending streams for which to include the results. If not provided, results for all sending streams will be included. |
| `categories[]` | string\[] | No | — | Categories for which to include the results. If not provided, results for all categories will be included. |
| `email_service_providers[]` | string\[] | No | — | Email service providers for which to include the results. If not provided, results for all ESPs will be included. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "integer",
"description": "Unique account ID"
},
"start_date": {
"type": "string",
"description": "Start date for which to include the results."
},
"end_date": {
"type": "string",
"description": "End date for which to include the results."
},
"sending_domain_ids[]": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "IDs of the sending domains for which to include the results. If not provided, results for all sending domains will be included."
},
"sending_streams[]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"transactional",
"bulk"
]
},
"description": "Sending streams for which to include the results. If not provided, results for all sending streams will be included."
},
"categories[]": {
"type": "array",
"items": {
"type": "string"
},
"description": "Categories for which to include the results. If not provided, results for all categories will be included."
},
"email_service_providers[]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"Google",
"Yahoo",
"Outlook",
"Hey",
"Google Workspace",
"Zoho Email",
"ProtonMail",
"Yandex",
"iCloud",
"Office 365",
"Amazon SES (Simple Email Service)",
"Proofpoint Email Protection",
"Mimecast Email Protection",
"GMX.net",
"Rackspace",
"OVH hosted",
"Linode hosted",
"GoDaddy",
"Symantec Email Protection",
"Barracuda Email Protection",
"Cisco Email Protection",
"FastMail",
"Naver",
"Seznam",
"Comcast",
"Spectrum"
]
},
"description": "Email service providers for which to include the results. If not provided, results for all ESPs will be included."
}
},
"required": [
"PCID",
"account_id",
"start_date",
"end_date"
]
}
```
***
## mailtrap\_sending\_get\_account\_sending\_stats\_by\_domains
Get Sending Stats by Domains
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------------- | ---------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `account_id` | integer | Yes | — | Unique account ID |
| `start_date` | string | Yes | — | Start date for which to include the results. |
| `end_date` | string | Yes | — | End date for which to include the results. |
| `sending_domain_ids[]` | integer\[] | No | — | IDs of the sending domains for which to include the results. If not provided, results for all sending domains will be included. |
| `sending_streams[]` | string\[] | No | — | Sending streams for which to include the results. If not provided, results for all sending streams will be included. |
| `categories[]` | string\[] | No | — | Categories for which to include the results. If not provided, results for all categories will be included. |
| `email_service_providers[]` | string\[] | No | — | Email service providers for which to include the results. If not provided, results for all ESPs will be included. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "integer",
"description": "Unique account ID"
},
"start_date": {
"type": "string",
"description": "Start date for which to include the results."
},
"end_date": {
"type": "string",
"description": "End date for which to include the results."
},
"sending_domain_ids[]": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "IDs of the sending domains for which to include the results. If not provided, results for all sending domains will be included."
},
"sending_streams[]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"transactional",
"bulk"
]
},
"description": "Sending streams for which to include the results. If not provided, results for all sending streams will be included."
},
"categories[]": {
"type": "array",
"items": {
"type": "string"
},
"description": "Categories for which to include the results. If not provided, results for all categories will be included."
},
"email_service_providers[]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"Google",
"Yahoo",
"Outlook",
"Hey",
"Google Workspace",
"Zoho Email",
"ProtonMail",
"Yandex",
"iCloud",
"Office 365",
"Amazon SES (Simple Email Service)",
"Proofpoint Email Protection",
"Mimecast Email Protection",
"GMX.net",
"Rackspace",
"OVH hosted",
"Linode hosted",
"GoDaddy",
"Symantec Email Protection",
"Barracuda Email Protection",
"Cisco Email Protection",
"FastMail",
"Naver",
"Seznam",
"Comcast",
"Spectrum"
]
},
"description": "Email service providers for which to include the results. If not provided, results for all ESPs will be included."
}
},
"required": [
"PCID",
"account_id",
"start_date",
"end_date"
]
}
```
***
## mailtrap\_sending\_get\_account\_sending\_stats\_by\_email\_service\_providers
Get Sending Stats by Email Service Providers
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------------- | ---------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `account_id` | integer | Yes | — | Unique account ID |
| `start_date` | string | Yes | — | Start date for which to include the results. |
| `end_date` | string | Yes | — | End date for which to include the results. |
| `sending_domain_ids[]` | integer\[] | No | — | IDs of the sending domains for which to include the results. If not provided, results for all sending domains will be included. |
| `sending_streams[]` | string\[] | No | — | Sending streams for which to include the results. If not provided, results for all sending streams will be included. |
| `categories[]` | string\[] | No | — | Categories for which to include the results. If not provided, results for all categories will be included. |
| `email_service_providers[]` | string\[] | No | — | Email service providers for which to include the results. If not provided, results for all ESPs will be included. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "integer",
"description": "Unique account ID"
},
"start_date": {
"type": "string",
"description": "Start date for which to include the results."
},
"end_date": {
"type": "string",
"description": "End date for which to include the results."
},
"sending_domain_ids[]": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "IDs of the sending domains for which to include the results. If not provided, results for all sending domains will be included."
},
"sending_streams[]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"transactional",
"bulk"
]
},
"description": "Sending streams for which to include the results. If not provided, results for all sending streams will be included."
},
"categories[]": {
"type": "array",
"items": {
"type": "string"
},
"description": "Categories for which to include the results. If not provided, results for all categories will be included."
},
"email_service_providers[]": {
"type": "array",
"items": {
"type": "string",
"enum": [
"Google",
"Yahoo",
"Outlook",
"Hey",
"Google Workspace",
"Zoho Email",
"ProtonMail",
"Yandex",
"iCloud",
"Office 365",
"Amazon SES (Simple Email Service)",
"Proofpoint Email Protection",
"Mimecast Email Protection",
"GMX.net",
"Rackspace",
"OVH hosted",
"Linode hosted",
"GoDaddy",
"Symantec Email Protection",
"Barracuda Email Protection",
"Cisco Email Protection",
"FastMail",
"Naver",
"Seznam",
"Comcast",
"Spectrum"
]
},
"description": "Email service providers for which to include the results. If not provided, results for all ESPs will be included."
}
},
"required": [
"PCID",
"account_id",
"start_date",
"end_date"
]
}
```
***
## mailtrap\_sending\_get\_domain
Get sending domain
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | ------- | -------- | ------- | ----------------- |
| `account_id` | integer | Yes | — | Unique account ID |
| `sending_domain_id` | integer | Yes | — | Sending domain ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "integer",
"description": "Unique account ID"
},
"sending_domain_id": {
"type": "integer",
"description": "Sending domain ID"
}
},
"required": [
"PCID",
"account_id",
"sending_domain_id"
]
}
```
***
## mailtrap\_sending\_get\_domain\_company\_info
Get company info
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | ------- | -------- | ------- | ----------------- |
| `account_id` | integer | Yes | — | Unique account ID |
| `sending_domain_id` | integer | Yes | — | Sending domain ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "integer",
"description": "Unique account ID"
},
"sending_domain_id": {
"type": "integer",
"description": "Sending domain ID"
}
},
"required": [
"PCID",
"account_id",
"sending_domain_id"
]
}
```
***
## mailtrap\_sending\_get\_domains
List sending domains
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ----------------- |
| `account_id` | integer | Yes | — | Unique account ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "integer",
"description": "Unique account ID"
}
},
"required": [
"PCID",
"account_id"
]
}
```
***
## mailtrap\_sending\_get\_email\_log\_message
Get an email log message by ID
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------- | ------- | -------- | ------- | ----------------- |
| `account_id` | integer | Yes | — | Unique account ID |
| `sending_message_id` | string | Yes | — | Message UUID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "integer",
"description": "Unique account ID"
},
"sending_message_id": {
"type": "string",
"description": "Message UUID"
}
},
"required": [
"PCID",
"account_id",
"sending_message_id"
]
}
```
***
## mailtrap\_sending\_get\_email\_template
Get Email Template
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | ------- | -------- | ------- | ----------------- |
| `account_id` | integer | Yes | — | Unique account ID |
| `email_template_id` | integer | Yes | — | Email template ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "integer",
"description": "Unique account ID"
},
"email_template_id": {
"type": "integer",
"description": "Email template ID"
}
},
"required": [
"PCID",
"account_id",
"email_template_id"
]
}
```
***
## mailtrap\_sending\_get\_suppressions
List suppressions
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | --------------------------------------------- |
| `account_id` | integer | Yes | — | Unique account ID |
| `email` | string | No | — | Search for specific email address |
| `start_time` | string | No | — | Search emails suppressed after this timestamp |
| `end_time` | string | No | — | Search emails suppressed after this timestamp |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "integer",
"description": "Unique account ID"
},
"email": {
"type": "string",
"description": "Search for specific email address"
},
"start_time": {
"type": "string",
"description": "Search emails suppressed after this timestamp"
},
"end_time": {
"type": "string",
"description": "Search emails suppressed after this timestamp"
}
},
"required": [
"PCID",
"account_id"
]
}
```
***
## mailtrap\_sending\_list\_email\_logs
List email logs
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `account_id` | integer | Yes | — | Unique account ID |
| `search_after` | string | No | — | Cursor for the next page (message\_id UUID from previous response next\_page\_cursor). |
| `filters` | object | No | — | Filter criteria (deep object). Pass as `filters[field][operator]` and `filters[field][value]`. When a filter accepts an array value, use bracket notation: `filters[field][value][]=item1&filters[field][value][]=item2`. Date range: use `filters[sent_after]` and `filters[sent_before]` (ISO 8601 strings). Unknown filters are ignored. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "integer",
"description": "Unique account ID"
},
"search_after": {
"type": "string",
"description": "Cursor for the next page (message_id UUID from previous response next_page_cursor)."
},
"filters": {
"type": "object",
"description": "Filter criteria (deep object). Pass as `filters[field][operator]` and `filters[field][value]`. When a filter accepts an array value, use bracket notation: `filters[field][value][]=item1&filters[field][value][]=item2`. Date range: use `filters[sent_after]` and `filters[sent_before]` (ISO 8601 strings). Unknown filters are ignored.",
"properties": {
"sent_after": {
"type": "string",
"description": "Start of sent-at range (ISO 8601). Must be before or equal to sent_before."
},
"sent_before": {
"type": "string",
"description": "End of sent-at range (ISO 8601). Must be after or equal to sent_after."
},
"to": {
"description": "The to value"
},
"from": {
"description": "The from value"
},
"subject": {
"description": "The subject value"
},
"status": {
"type": "object",
"description": "The status value"
},
"events": {
"type": "object",
"description": "The events value"
},
"clicks_count": {
"type": "object",
"description": "Clicks Count"
},
"opens_count": {
"type": "object",
"description": "Opens Count"
},
"client_ip": {
"description": "Client Ip"
},
"sending_ip": {
"description": "Sending Ip"
},
"email_service_provider_response": {
"description": "Email Service Provider Response"
},
"email_service_provider": {
"type": "object",
"description": "Email Service Provider"
},
"recipient_mx": {
"description": "Recipient Mx"
},
"category": {
"type": "object",
"description": "The category value"
},
"sending_domain_id": {
"type": "object",
"description": "Sending Domain Id"
},
"sending_stream": {
"type": "object",
"description": "Sending Stream"
}
}
}
},
"required": [
"PCID",
"account_id"
]
}
```
***
## mailtrap\_sending\_send\_sending\_domain\_setup\_instructions
Send setup instructions
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | ------- | -------- | ------- | ------------------------------------------- |
| `account_id` | integer | Yes | — | Unique account ID |
| `sending_domain_id` | integer | Yes | — | Sending domain ID |
| `email` | string | Yes | — | Email address to receive setup instructions |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "integer",
"description": "Unique account ID"
},
"sending_domain_id": {
"type": "integer",
"description": "Sending domain ID"
},
"email": {
"type": "string",
"description": "Email address to receive setup instructions"
}
},
"required": [
"PCID",
"account_id",
"sending_domain_id",
"email"
]
}
```
***
## mailtrap\_sending\_update\_email\_template
Update Email Template
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | ------- | -------- | ------- | ----------------- |
| `account_id` | integer | Yes | — | Unique account ID |
| `email_template_id` | integer | Yes | — | Email template ID |
| `email_template` | object | Yes | — | Email Template |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "integer",
"description": "Unique account ID"
},
"email_template_id": {
"type": "integer",
"description": "Email template ID"
},
"email_template": {
"type": "object",
"description": "Email Template",
"properties": {
"name": {
"type": "string",
"description": "The name value"
},
"category": {
"type": "string",
"description": "The category value"
},
"subject": {
"type": "string",
"description": "The subject value"
},
"body_text": {
"type": "string",
"description": "Body Text"
},
"body_html": {
"type": "string",
"description": "Body Html"
}
},
"required": [
"name",
"subject",
"category"
]
}
},
"required": [
"PCID",
"account_id",
"email_template_id",
"email_template"
]
}
```
***
## mailtrap\_sending\_update\_sending\_domain
Update sending domain
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | ------- | -------- | ------- | ----------------- |
| `account_id` | integer | Yes | — | Unique account ID |
| `sending_domain_id` | integer | Yes | — | Sending domain ID |
| `sending_domain` | object | Yes | — | Sending Domain |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "integer",
"description": "Unique account ID"
},
"sending_domain_id": {
"type": "integer",
"description": "Sending domain ID"
},
"sending_domain": {
"type": "object",
"description": "Sending Domain",
"properties": {
"open_tracking_enabled": {
"type": "boolean",
"description": "Enable open tracking for emails sent from this domain"
},
"click_tracking_enabled": {
"type": "boolean",
"description": "Enable click tracking for links in emails sent from this domain"
},
"auto_unsubscribe_link_enabled": {
"type": "boolean",
"description": "Automatically add an unsubscribe link to emails sent from this domain"
}
}
}
},
"required": [
"PCID",
"account_id",
"sending_domain_id",
"sending_domain"
]
}
```
***
## mailtrap\_sending\_update\_sending\_domain\_company\_info
Update company info
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------- |
| `account_id` | integer | Yes | — | Unique account ID |
| `sending_domain_id` | integer | Yes | — | Sending domain ID |
| `company_info` | object | Yes | — | All fields are optional. Only the fields provided in the request will be updated. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "integer",
"description": "Unique account ID"
},
"sending_domain_id": {
"type": "integer",
"description": "Sending domain ID"
},
"company_info": {
"type": "object",
"description": "All fields are optional. Only the fields provided in the request will be updated.",
"properties": {
"name": {
"type": "string",
"description": "Company or individual name"
},
"address": {
"type": "string",
"description": "Street address"
},
"city": {
"type": "string",
"description": "The city value"
},
"country": {
"type": "string",
"description": "The country value"
},
"phone": {
"type": "string",
"description": "Phone number"
},
"zip_code": {
"type": "string",
"description": "ZIP or postal code"
},
"privacy_policy_url": {
"type": "string",
"description": "URL to the privacy policy page"
},
"terms_of_service_url": {
"type": "string",
"description": "URL to the terms of service page"
},
"website_url": {
"type": "string",
"description": "Company website URL"
},
"info_level": {
"type": "string",
"description": "Whether the sender is a business or individual",
"enum": [
"business",
"individual"
]
}
}
}
},
"required": [
"PCID",
"account_id",
"sending_domain_id",
"company_info"
]
}
```