Mailtrap
mailtrapEmail Delivery Platform for testing and sending transactional emails
Acciones disponibles (49)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Clean InboxMAILTRAP_CLEAN_INBOXAcciónTool 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.
MAILTRAP_CLEAN_INBOXAcciónTool 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.
Parámetros de entrada
inbox_idintegerObligatorioUnique inbox ID to identify the specific inbox to clean.
account_idintegerObligatorioUnique account ID to identify the Mailtrap account.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create ContactMAILTRAP_CREATE_CONTACTAcciónTool 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.
MAILTRAP_CREATE_CONTACTAcciónTool 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.
Parámetros de entrada
contactobjectObligatorioContact details to create
account_idintegerObligatorioUnique account ID for the Mailtrap account
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Contact EventMAILTRAP_CREATE_CONTACT_EVENTAcciónTool to create a contact event in Mailtrap. Use when you need to track custom events associated with a contact for segmentation or automation triggers.
MAILTRAP_CREATE_CONTACT_EVENTAcciónTool to create a contact event in Mailtrap. Use when you need to track custom events associated with a contact for segmentation or automation triggers.
Parámetros de entrada
namestringObligatorioEvent name (max 255 characters)
paramsobjectA hash of string keys and scalar JSON values (string, number, boolean, or null)
account_idintegerObligatorioUnique account ID. You can obtain this from your Mailtrap account settings.
contact_identifierstringObligatorioContact UUID or Email
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Contact ExportMAILTRAP_CREATE_CONTACT_EXPORTAcciónTool 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).
MAILTRAP_CREATE_CONTACT_EXPORTAcciónTool 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).
Parámetros de entrada
filtersobject[]ObligatorioArray 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_idintegerObligatorioUnique account ID to create the contact export for
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Contact FieldMAILTRAP_CREATE_CONTACT_FIELDAcciónTool to create a custom contact field in Mailtrap. Use when you need to add new contact attributes for personalization and segmentation in email campaigns.
MAILTRAP_CREATE_CONTACT_FIELDAcciónTool to create a custom contact field in Mailtrap. Use when you need to add new contact attributes for personalization and segmentation in email campaigns.
Parámetros de entrada
namestringObligatorioName of the contact field (max 80 characters)
data_typestringObligatorioenumData type for the contact field. Choose from: text, integer, float, boolean, or date
textintegerfloatbooleandatemerge_tagstringObligatorioPersonalize your campaigns by adding a merge tag. This field will be replaced with unique contact details for each recipient (max 80 characters)
account_idintegerObligatorioUnique account ID
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Contact ListMAILTRAP_CREATE_CONTACT_LISTAcciónTool 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.
MAILTRAP_CREATE_CONTACT_LISTAcciónTool 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.
Parámetros de entrada
namestringObligatorioName of the contact list to create. Maximum length is 255 characters.
account_idintegerObligatorioUnique account ID
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Email TemplateMAILTRAP_CREATE_EMAIL_TEMPLATEAcciónTool 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.
MAILTRAP_CREATE_EMAIL_TEMPLATEAcciónTool 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.
Parámetros de entrada
account_idintegerObligatorioAccount ID where the email template will be created
email_templateobjectObligatorioEmail template data containing name, subject, category, and optional HTML/text body content. Name, subject, and category are required fields.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Sending DomainMAILTRAP_CREATE_SENDING_DOMAINAcciónTool 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.
MAILTRAP_CREATE_SENDING_DOMAINAcciónTool 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.
Parámetros de entrada
account_idintegerObligatorioAccount ID where the sending domain will be created
sending_domainobjectObligatorioObject containing the domain configuration
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete ContactMAILTRAP_DELETE_CONTACTAcciónTool 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.
MAILTRAP_DELETE_CONTACTAcciónTool 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.
Parámetros de entrada
account_idintegerObligatorioUnique account ID for the Mailtrap account.
contact_identifierstringObligatorioContact UUID or email address to identify the contact to delete.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Contact FieldMAILTRAP_DELETE_CONTACT_FIELDAcciónTool to delete a contact field by its ID. Use when you need to remove a custom contact field from an account.
MAILTRAP_DELETE_CONTACT_FIELDAcciónTool to delete a contact field by its ID. Use when you need to remove a custom contact field from an account.
Parámetros de entrada
field_idintegerObligatorioUnique Contact Field ID to delete
account_idintegerObligatorioUnique account ID where the contact field exists
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Contact ListMAILTRAP_DELETE_CONTACT_LISTAcciónTool to delete a contact list by its ID. Use when you need to remove a contact list from an account.
MAILTRAP_DELETE_CONTACT_LISTAcciónTool to delete a contact list by its ID. Use when you need to remove a contact list from an account.
Parámetros de entrada
list_idintegerObligatorioUnique list ID to delete
account_idintegerObligatorioUnique account ID
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Email TemplateMAILTRAP_DELETE_EMAIL_TEMPLATEAcciónTool to delete an email template from a Mailtrap account. Use when you need to remove an existing email template.
MAILTRAP_DELETE_EMAIL_TEMPLATEAcciónTool to delete an email template from a Mailtrap account. Use when you need to remove an existing email template.
Parámetros de entrada
account_idintegerObligatorioAccount ID where the email template is located
email_template_idintegerObligatorioEmail template ID to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete ProjectMAILTRAP_DELETE_PROJECTAcciónTool 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.
MAILTRAP_DELETE_PROJECTAcciónTool 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.
Parámetros de entrada
account_idintegerObligatorioUnique account ID to identify the Mailtrap account.
project_idintegerObligatorioUnique project ID to identify the specific project to delete.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Sending DomainMAILTRAP_DELETE_SENDING_DOMAINAcciónTool to delete a sending domain from a Mailtrap account. Use when you need to remove a domain permanently.
MAILTRAP_DELETE_SENDING_DOMAINAcciónTool to delete a sending domain from a Mailtrap account. Use when you need to remove a domain permanently.
Parámetros de entrada
account_idintegerObligatorioAccount ID where the sending domain belongs
sending_domain_idintegerObligatorioSending domain ID to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Billing UsageMAILTRAP_GET_BILLING_USAGEAcciónTool 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.
MAILTRAP_GET_BILLING_USAGEAcciónTool 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.
Parámetros de entrada
account_idintegerObligatorioUnique account ID
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ContactMAILTRAP_GET_CONTACTAcciónTool 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.
MAILTRAP_GET_CONTACTAcciónTool 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.
Parámetros de entrada
account_idintegerObligatorioUnique account ID for the Mailtrap account
contact_identifierstringObligatorioContact UUID or Email address to identify the contact
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Contact ExportMAILTRAP_GET_CONTACT_EXPORTAcciónTool 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.
MAILTRAP_GET_CONTACT_EXPORTAcciónTool 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.
Parámetros de entrada
export_idintegerObligatorioUnique Contact Export ID to retrieve.
account_idintegerObligatorioUnique account ID for the Mailtrap account.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Contact FieldMAILTRAP_GET_CONTACT_FIELDAcciónTool to retrieve contact field details by field ID. Use when you need to get information about a specific custom field in your contacts.
MAILTRAP_GET_CONTACT_FIELDAcciónTool to retrieve contact field details by field ID. Use when you need to get information about a specific custom field in your contacts.
Parámetros de entrada
field_idintegerObligatorioUnique Contact Field ID
account_idintegerObligatorioUnique account ID
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Contact Import StatusMAILTRAP_GET_CONTACT_IMPORTAcciónTool 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.
MAILTRAP_GET_CONTACT_IMPORTAcciónTool 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.
Parámetros de entrada
import_idintegerObligatorioUnique Contact Import ID for the import operation to retrieve.
account_idintegerObligatorioUnique account ID for the Mailtrap account.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Contact ListMAILTRAP_GET_CONTACT_LISTAcciónTool to retrieve a specific contact list by its ID. Use when you need to fetch details about a contact list in a Mailtrap account.
MAILTRAP_GET_CONTACT_LISTAcciónTool to retrieve a specific contact list by its ID. Use when you need to fetch details about a contact list in a Mailtrap account.
Parámetros de entrada
list_idintegerObligatorioUnique list ID
account_idintegerObligatorioUnique account ID
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Email TemplateMAILTRAP_GET_EMAIL_TEMPLATEAcciónTool 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.
MAILTRAP_GET_EMAIL_TEMPLATEAcciónTool 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.
Parámetros de entrada
account_idintegerObligatorioAccount ID
email_template_idintegerObligatorioEmail template ID
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Inbox AttributesMAILTRAP_GET_INBOXAcciónTool to retrieve inbox attributes from Mailtrap. Use when you need to get details about a specific inbox including its configuration, statistics, and permissions.
MAILTRAP_GET_INBOXAcciónTool to retrieve inbox attributes from Mailtrap. Use when you need to get details about a specific inbox including its configuration, statistics, and permissions.
Parámetros de entrada
inbox_idintegerObligatorioUnique inbox ID to identify the specific inbox.
account_idintegerObligatorioUnique account ID to identify the Mailtrap account.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Message HTML BodyMAILTRAP_GET_MESSAGE_HTMLAcciónTool 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.
MAILTRAP_GET_MESSAGE_HTMLAcciónTool 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.
Parámetros de entrada
inbox_idintegerObligatorioUnique inbox ID to identify the specific inbox
account_idintegerObligatorioUnique account ID to identify the Mailtrap account
message_idintegerObligatorioUnique message ID to identify the specific message
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Permission ResourcesMAILTRAP_GET_PERMISSION_RESOURCESAcciónTool 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.
MAILTRAP_GET_PERMISSION_RESOURCESAcciónTool 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.
Parámetros de entrada
account_idintegerObligatorioUnique account ID for which to retrieve permission resources.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Project by IDMAILTRAP_GET_PROJECTAcciónTool 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.
MAILTRAP_GET_PROJECTAcciónTool 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.
Parámetros de entrada
account_idintegerObligatorioUnique account ID to identify the Mailtrap account.
project_idintegerObligatorioUnique project ID to identify the specific project.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Sending DomainMAILTRAP_GET_SENDING_DOMAINAcciónTool to retrieve sending domain details from Mailtrap. Use when you need to check domain configuration, DNS verification status, or tracking settings.
MAILTRAP_GET_SENDING_DOMAINAcciónTool to retrieve sending domain details from Mailtrap. Use when you need to check domain configuration, DNS verification status, or tracking settings.
Parámetros de entrada
account_idintegerObligatorioAccount ID
sending_domain_idintegerObligatorioSending domain ID
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Sending StatsMAILTRAP_GET_SENDING_STATSAcciónTool 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.
MAILTRAP_GET_SENDING_STATSAcciónTool 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.
Parámetros de entrada
end_datestringObligatorioEnd date for which to include the results, in YYYY-MM-DD format.
account_idintegerObligatorioAccount ID for which to retrieve sending statistics.
categoriesstring[]Categories for which to include the results. If not provided, results for all categories will be included.
start_datestringObligatorioStart date for which to include the results, in YYYY-MM-DD format.
sending_streamsstring[]Sending streams for which to include the results. If not provided, results for all sending streams will be included.
sending_domain_idsinteger[]IDs of the sending domains for which to include the results. If not provided, results for all sending domains will be included.
email_service_providersstring[]Email service providers for which to include the results. If not provided, results for all ESPs will be included.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Sending Stats by CategoriesMAILTRAP_GET_SENDING_STATS_BY_CATEGORIESAcciónTool 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.
MAILTRAP_GET_SENDING_STATS_BY_CATEGORIESAcciónTool 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.
Parámetros de entrada
end_datestringObligatorioEnd date for the statistics period in YYYY-MM-DD format
account_idintegerObligatorioAccount ID for which to retrieve statistics
categoriesstring[]Email categories to filter results. If not provided, results for all categories will be included.
start_datestringObligatorioStart date for the statistics period in YYYY-MM-DD format
sending_streamsstring[]Sending streams to filter results (e.g., transactional, bulk). If not provided, results for all sending streams will be included.
sending_domain_idsinteger[]IDs of the sending domains to filter results. If not provided, results for all sending domains will be included.
email_service_providersstring[]Email service providers to filter results (e.g., Google, Yahoo). If not provided, results for all ESPs will be included.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Sending Stats by DateMAILTRAP_GET_SENDING_STATS_BY_DATEAcciónTool 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.
MAILTRAP_GET_SENDING_STATS_BY_DATEAcciónTool 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.
Parámetros de entrada
end_datestringObligatorioEnd date for which to include the results in YYYY-MM-DD format
account_idintegerObligatorioAccount ID for which to retrieve sending statistics
categoriesstring[]Categories for which to include the results. If not provided, results for all categories will be included.
start_datestringObligatorioStart date for which to include the results in YYYY-MM-DD format
sending_streamsstring[]Sending streams for which to include the results. If not provided, results for all sending streams will be included.
sending_domain_idsinteger[]IDs of the sending domains for which to include the results. If not provided, results for all sending domains will be included.
email_service_providersstring[]Email service providers for which to include the results. If not provided, results for all ESPs will be included.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Sending Stats by DomainsMAILTRAP_GET_SENDING_STATS_BY_DOMAINSAcciónTool 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.
MAILTRAP_GET_SENDING_STATS_BY_DOMAINSAcciónTool 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.
Parámetros de entrada
end_datestringObligatorioEnd date for which to include the results in YYYY-MM-DD format.
account_idintegerObligatorioAccount ID for which to retrieve sending stats.
categoriesstring[]Categories for which to include the results. If not provided, results for all categories will be included.
start_datestringObligatorioStart date for which to include the results in YYYY-MM-DD format.
sending_streamsstring[]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_idsinteger[]IDs of the sending domains for which to include the results. If not provided, results for all sending domains will be included.
email_service_providersstring[]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.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Sending Stats by ESPMAILTRAP_GET_SENDING_STATS_BY_ESPAcciónTool 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.
MAILTRAP_GET_SENDING_STATS_BY_ESPAcciónTool 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.
Parámetros de entrada
end_datestringObligatorioEnd date for which to include the results in YYYY-MM-DD format
account_idintegerObligatorioAccount ID for which to retrieve statistics
categoriesstring[]Categories for which to include the results. If not provided, results for all categories will be included.
start_datestringObligatorioStart date for which to include the results in YYYY-MM-DD format
sending_streamsstring[]Sending streams for which to include the results. If not provided, results for all sending streams will be included.
sending_domain_idsinteger[]IDs of the sending domains for which to include the results. If not provided, results for all sending domains will be included.
email_service_providersstring[]Email service providers for which to include the results. If not provided, results for all ESPs will be included.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Import ContactsMAILTRAP_IMPORT_CONTACTSAcciónTool 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.
MAILTRAP_IMPORT_CONTACTSAcciónTool 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.
Parámetros de entrada
contactsobject[]ObligatorioList of contacts to import. Each contact must have an email address and can have optional custom fields and list associations.
account_idintegerObligatorioUnique account ID for the Mailtrap account.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List AccountsMAILTRAP_LIST_ACCOUNTSAcciónTool 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).
MAILTRAP_LIST_ACCOUNTSAcciónTool 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).
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Contact FieldsMAILTRAP_LIST_CONTACT_FIELDSAcciónTool to get all contact fields for a Mailtrap account. Use when you need to retrieve custom field definitions for contacts.
MAILTRAP_LIST_CONTACT_FIELDSAcciónTool to get all contact fields for a Mailtrap account. Use when you need to retrieve custom field definitions for contacts.
Parámetros de entrada
account_idintegerObligatorioUnique account ID for the Mailtrap account.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Contact ListsMAILTRAP_LIST_CONTACT_LISTSAcciónTool 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.
MAILTRAP_LIST_CONTACT_LISTSAcciónTool 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.
Parámetros de entrada
account_idintegerObligatorioUnique account ID. You can obtain this from your Mailtrap account settings.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Email TemplatesMAILTRAP_LIST_EMAIL_TEMPLATESAcciónTool 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.
MAILTRAP_LIST_EMAIL_TEMPLATESAcciónTool 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.
Parámetros de entrada
account_idintegerObligatorioAccount ID
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List InboxesMAILTRAP_LIST_INBOXESAcciónTool 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.
MAILTRAP_LIST_INBOXESAcciónTool 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.
Parámetros de entrada
account_idintegerObligatorioUnique account ID to list inboxes for
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Messages in InboxMAILTRAP_LIST_MESSAGESAcciónTool 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.
MAILTRAP_LIST_MESSAGESAcciónTool 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.
Parámetros de entrada
pageintegerPage number for pagination (30 messages per page). Use this for offset-based pagination.
searchstringFilter emails by subject, to_email, or to_name (case insensitive). Use this to search for specific messages.
last_idintegerGet messages with ID less than this value for cursor-based pagination. Alternative to page parameter.
inbox_idintegerObligatorioUnique inbox ID to identify the specific inbox
account_idintegerObligatorioUnique account ID to identify the Mailtrap account
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List ProjectsMAILTRAP_LIST_PROJECTSAcciónTool 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.
MAILTRAP_LIST_PROJECTSAcciónTool 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.
Parámetros de entrada
account_idintegerObligatorioUnique account ID to list projects for
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Sending DomainsMAILTRAP_LIST_SENDING_DOMAINSAcciónTool to list all sending domains for a Mailtrap account. Use when you need to retrieve configured domains for email sending.
MAILTRAP_LIST_SENDING_DOMAINSAcciónTool to list all sending domains for a Mailtrap account. Use when you need to retrieve configured domains for email sending.
Parámetros de entrada
account_idintegerObligatorioAccount ID to list sending domains for
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Email SuppressionsMAILTRAP_LIST_SUPPRESSIONSAcciónTool 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.
MAILTRAP_LIST_SUPPRESSIONSAcciónTool 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.
Parámetros de entrada
emailstringSearch for a specific email address. Use this to check if a particular email is suppressed.
end_timestringSearch emails suppressed before this timestamp in ISO 8601 format (e.g., 2025-12-31T23:59:59Z).
account_idintegerObligatorioAccount ID to list suppressions for. This is your Mailtrap account identifier.
start_timestringSearch emails suppressed after this timestamp in ISO 8601 format (e.g., 2025-01-01T00:00:00Z).
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Mark Inbox as ReadMAILTRAP_MARK_INBOX_AS_READAcciónTool 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.
MAILTRAP_MARK_INBOX_AS_READAcciónTool 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.
Parámetros de entrada
inbox_idintegerObligatorioUnique inbox ID to identify the specific inbox
account_idintegerObligatorioUnique account ID to identify the Mailtrap account
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Reset Inbox CredentialsMAILTRAP_RESET_INBOX_CREDENTIALSAcciónTool to reset SMTP credentials for a Mailtrap inbox. Use when you need to regenerate the username and password for inbox access.
MAILTRAP_RESET_INBOX_CREDENTIALSAcciónTool to reset SMTP credentials for a Mailtrap inbox. Use when you need to regenerate the username and password for inbox access.
Parámetros de entrada
inbox_idintegerObligatorioUnique inbox ID to identify the specific inbox.
account_idintegerObligatorioUnique account ID to identify the Mailtrap account.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update contactMAILTRAP_UPDATE_CONTACTAcciónTool 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.
MAILTRAP_UPDATE_CONTACTAcciónTool 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.
Parámetros de entrada
contactobjectObligatorioContact data to update. At least one field must be provided
account_idintegerObligatorioUnique account ID
contact_identifierstringObligatorioContact UUID or Email address
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Contact FieldMAILTRAP_UPDATE_CONTACT_FIELDAcciónTool to update a contact field in Mailtrap. Use when you need to modify the name or merge tag of an existing contact field.
MAILTRAP_UPDATE_CONTACT_FIELDAcciónTool to update a contact field in Mailtrap. Use when you need to modify the name or merge tag of an existing contact field.
Parámetros de entrada
namestringName of the contact field
field_idintegerObligatorioUnique Contact Field ID
merge_tagstringPersonalize your campaigns by adding a merge tag. This field will be replaced with unique contact details for each recipient.
account_idintegerObligatorioUnique account ID
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Contact ListMAILTRAP_UPDATE_CONTACT_LISTAcciónTool to update a contact list's name in Mailtrap. Use when you need to rename an existing contact list.
MAILTRAP_UPDATE_CONTACT_LISTAcciónTool to update a contact list's name in Mailtrap. Use when you need to rename an existing contact list.
Parámetros de entrada
namestringObligatorioNew name for the contact list. Maximum length is 255 characters.
list_idintegerObligatorioUnique list ID
account_idintegerObligatorioUnique account ID
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Email TemplateMAILTRAP_UPDATE_EMAIL_TEMPLATEAcciónTool 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.
MAILTRAP_UPDATE_EMAIL_TEMPLATEAcciónTool 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.
Parámetros de entrada
account_idintegerObligatorioAccount ID to which the email template belongs
email_templateobjectObligatorioEmail template data containing fields to update. At least name, subject, and category are required.
email_template_idintegerObligatorioEmail template ID to update
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update inboxMAILTRAP_UPDATE_INBOXAcciónTool to update an inbox's settings in Mailtrap. Use when you need to change the inbox name or email username.
MAILTRAP_UPDATE_INBOXAcciónTool to update an inbox's settings in Mailtrap. Use when you need to change the inbox name or email username.
Parámetros de entrada
inboxobjectObligatorioInbox data to update. Provide at least one field (name or email_username) to update.
inbox_idintegerObligatorioUnique inbox ID
account_idintegerObligatorioUnique account ID
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update projectMAILTRAP_UPDATE_PROJECTAcciónTool to update a project's name in Mailtrap. Use when you need to rename an existing project.
MAILTRAP_UPDATE_PROJECTAcciónTool to update a project's name in Mailtrap. Use when you need to rename an existing project.
Parámetros de entrada
projectobjectObligatorioProject data to update. Must provide the new project name.
account_idintegerObligatorioUnique account ID
project_idintegerObligatorioUnique project ID
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not