Mailtrap

Mailtrap integration (Communication, Developer Tools). Imported from open-connector.

API key47 toolshttps://mailtrap.io

GET

mailtrap_list_accounts

List Mailtrap accounts accessible to the API token.

/api/accounts

GET

mailtrap_list_projects

List Mailtrap projects in an account.

/{accountId}/projects

1 parameter

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.

GET

mailtrap_get_project

Retrieve one Mailtrap project.

/{accountId}/projects/{projectId}

2 parameters

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.
projectId	integer	required	Mailtrap project ID.

PATCH

mailtrap_update_project

Update one Mailtrap project name.

/{accountId}/projects/{projectId}

3 parameters

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.
projectId	integer	required	Mailtrap project ID.
project	object	required	Mailtrap project fields to update.

DELETE

mailtrap_delete_project

Delete one Mailtrap project.

/{accountId}/projects/{projectId}

2 parameters

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.
projectId	integer	required	Mailtrap project ID.

GET

mailtrap_list_inboxes

List Mailtrap sandboxes or inboxes in an account.

/{accountId}/inboxes

1 parameter

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.

GET

mailtrap_get_inbox

Retrieve one Mailtrap inbox.

/{accountId}/inboxes/{inboxId}

2 parameters

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.
inboxId	integer	required	Mailtrap inbox ID.

PATCH

mailtrap_update_inbox

Update a Mailtrap inbox name or email username.

/{accountId}/inboxes/{inboxId}

3 parameters

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.
inboxId	integer	required	Mailtrap inbox ID.
inbox	object	required	Mailtrap inbox fields to update.

PATCH

mailtrap_clean_inbox

Clean all messages from a Mailtrap inbox.

/{accountId}/inboxes/{inboxId}/clean

2 parameters

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.
inboxId	integer	required	Mailtrap inbox ID.

PATCH

mailtrap_mark_inbox_as_read

Mark all messages in a Mailtrap inbox as read.

/{accountId}/inboxes/{inboxId}/all_read

2 parameters

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.
inboxId	integer	required	Mailtrap inbox ID.

PATCH

mailtrap_reset_inbox_credentials

Reset SMTP credentials for a Mailtrap inbox.

/{accountId}/inboxes/{inboxId}/reset_credentials

2 parameters

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.
inboxId	integer	required	Mailtrap inbox ID.

GET

mailtrap_list_messages

List messages in a Mailtrap inbox.

/{accountId}/inboxes/{inboxId}/messages

5 parameters

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.
inboxId	integer	required	Mailtrap inbox ID.
search	string	optional	Search query for filtering messages.
lastId	integer	optional	Last message ID cursor.
page	integer	optional	Page number when lastId is not used.

GET

mailtrap_get_message

Retrieve one message from a Mailtrap inbox.

/{accountId}/inboxes/{inboxId}/messages/{messageId}

3 parameters

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.
inboxId	integer	required	Mailtrap inbox ID.
messageId	integer	required	Mailtrap message ID.

GET

mailtrap_get_message_html_source

Retrieve the HTML source body for one Mailtrap message.

/{accountId}/inboxes/{inboxId}/messages/{messageId}/body.htmlsource

3 parameters

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.
inboxId	integer	required	Mailtrap inbox ID.
messageId	integer	required	Mailtrap message ID.

POST

mailtrap_create_contact

Create a Mailtrap contact.

/{accountId}/contacts

2 parameters

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.
contact	object	required	Mailtrap contact fields for creation.

GET

mailtrap_get_contact

Retrieve a Mailtrap contact by UUID or email address.

/{accountId}/contacts/{contactIdentifier}

2 parameters

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.
contactIdentifier	string	required	Mailtrap contact UUID or email address. Email values are URL-encoded by the run…

PATCH

mailtrap_update_contact

Update a Mailtrap contact.

/{accountId}/contacts/{contactIdentifier}

3 parameters

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.
contactIdentifier	string	required	Mailtrap contact UUID or email address. Email values are URL-encoded by the run…
contact	object	required	Mailtrap contact fields to update.

DELETE

mailtrap_delete_contact

Delete a Mailtrap contact.

/{accountId}/contacts/{contactIdentifier}

2 parameters

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.
contactIdentifier	string	required	Mailtrap contact UUID or email address. Email values are URL-encoded by the run…

GET

mailtrap_list_contact_lists

List Mailtrap contact lists.

/{accountId}/contacts

1 parameter

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.

GET

mailtrap_get_contact_list

Retrieve one Mailtrap contact list.

/{accountId}/{listId}

2 parameters

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.
listId	integer	required	Mailtrap contact list ID.

POST

mailtrap_create_contact_list

Create a Mailtrap contact list.

/{accountId}/contacts/lists

2 parameters

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.
name	string	required	Mailtrap contact-list name.

PATCH

mailtrap_update_contact_list

Update a Mailtrap contact list name.

/{accountId}/contacts/lists/{listId}

3 parameters

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.
listId	integer	required	Mailtrap contact list ID.
name	string	required	Mailtrap contact-list name.

DELETE

mailtrap_delete_contact_list

Delete one Mailtrap contact list.

/{accountId}/{listId}

2 parameters

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.
listId	integer	required	Mailtrap contact list ID.

GET

mailtrap_list_contact_fields

List Mailtrap contact fields.

/{accountId}/contacts

1 parameter

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.

GET

mailtrap_get_contact_field

Retrieve one Mailtrap contact field.

/{accountId}/{fieldId}

2 parameters

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.
fieldId	integer	required	Mailtrap contact field ID.

DELETE

mailtrap_delete_contact_field

Delete one Mailtrap contact field.

/{accountId}/{fieldId}

2 parameters

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.
fieldId	integer	required	Mailtrap contact field ID.

POST

mailtrap_import_contacts

Import contacts into Mailtrap.

/{accountId}/contacts/imports

2 parameters

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.
contacts	array	required	Contacts to import.

GET

mailtrap_get_contact_import

Retrieve one Mailtrap contact import job.

/{accountId}/{importId}

2 parameters

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.
importId	integer	required	Mailtrap contact import ID.

GET

mailtrap_get_contact_export

Retrieve one Mailtrap contact export job.

/{accountId}/{exportId}

2 parameters

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.
exportId	integer	required	Mailtrap contact export ID.

POST

mailtrap_create_contact_event

Create a custom event for a Mailtrap contact.

/{accountId}/contacts/{contactIdentifier}/events

4 parameters

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.
contactIdentifier	string	required	Mailtrap contact UUID or email address. Email values are URL-encoded by the run…
name	string	required	Mailtrap custom event name.
params	object	optional	Scalar custom event parameters.

GET

mailtrap_list_email_templates

List Mailtrap email templates.

/{accountId}/email_templates

1 parameter

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.

GET

mailtrap_get_email_template

Retrieve one Mailtrap email template.

/{accountId}/{emailTemplateId}

2 parameters

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.
emailTemplateId	integer	required	Mailtrap email template ID.

POST

mailtrap_create_email_template

Create a Mailtrap email template.

/{accountId}/email_templates

2 parameters

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.
emailTemplate	object	required	Mailtrap email template fields.

PATCH

mailtrap_update_email_template

Update a Mailtrap email template.

/{accountId}/email_templates/{emailTemplateId}

3 parameters

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.
emailTemplateId	integer	required	Mailtrap email template ID.
emailTemplate	object	required	Mailtrap email template fields.

DELETE

mailtrap_delete_email_template

Delete one Mailtrap email template.

/{accountId}/{emailTemplateId}

2 parameters

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.
emailTemplateId	integer	required	Mailtrap email template ID.

GET

mailtrap_list_sending_domains

List Mailtrap sending domains.

/{accountId}/sending_domains

1 parameter

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.

GET

mailtrap_get_sending_domain

Retrieve one Mailtrap sending domain.

/{accountId}/{sendingDomainId}

2 parameters

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.
sendingDomainId	integer	required	Mailtrap sending domain ID.

POST

mailtrap_create_sending_domain

Create a Mailtrap sending domain.

/{accountId}/sending_domains

2 parameters

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.
sendingDomain	object	required	Mailtrap sending domain fields.

DELETE

mailtrap_delete_sending_domain

Delete one Mailtrap sending domain.

/{accountId}/{sendingDomainId}

2 parameters

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.
sendingDomainId	integer	required	Mailtrap sending domain ID.

GET

mailtrap_list_suppressions

List Mailtrap suppressions with optional filters.

/{accountId}/suppressions

4 parameters

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.
email	string	optional	Suppressed email address to filter by.
startTime	string	optional	Filter suppressions created after this timestamp.
endTime	string	optional	Filter suppressions created before this timestamp.

GET

mailtrap_get_sending_stats

Get aggregate Mailtrap sending statistics.

/{accountId}/stats

7 parameters

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.
startDate	string	required	Stats start date in YYYY-MM-DD format.
endDate	string	required	Stats end date in YYYY-MM-DD format.
sendingDomainIds	array	optional	Sending domain IDs to include.
sendingStreams	array	optional	Mailtrap sending streams to include.
categories	array	optional	Mailtrap sending categories to include.
emailServiceProviders	array	optional	Email service provider names to include.

GET

mailtrap_get_sending_stats_by_date

Get Mailtrap sending statistics grouped by date.

/{accountId}/stats/date

7 parameters

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.
startDate	string	required	Stats start date in YYYY-MM-DD format.
endDate	string	required	Stats end date in YYYY-MM-DD format.
sendingDomainIds	array	optional	Sending domain IDs to include.
sendingStreams	array	optional	Mailtrap sending streams to include.
categories	array	optional	Mailtrap sending categories to include.
emailServiceProviders	array	optional	Email service provider names to include.

GET

mailtrap_get_sending_stats_by_domains

Get Mailtrap sending statistics grouped by sending domain.

/{accountId}/stats/domains

7 parameters

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.
startDate	string	required	Stats start date in YYYY-MM-DD format.
endDate	string	required	Stats end date in YYYY-MM-DD format.
sendingDomainIds	array	optional	Sending domain IDs to include.
sendingStreams	array	optional	Mailtrap sending streams to include.
categories	array	optional	Mailtrap sending categories to include.
emailServiceProviders	array	optional	Email service provider names to include.

GET

mailtrap_get_sending_stats_by_categories

Get Mailtrap sending statistics grouped by category.

/{accountId}/stats/categories

7 parameters

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.
startDate	string	required	Stats start date in YYYY-MM-DD format.
endDate	string	required	Stats end date in YYYY-MM-DD format.
sendingDomainIds	array	optional	Sending domain IDs to include.
sendingStreams	array	optional	Mailtrap sending streams to include.
categories	array	optional	Mailtrap sending categories to include.
emailServiceProviders	array	optional	Email service provider names to include.

GET

mailtrap_get_sending_stats_by_esp

Get Mailtrap sending statistics grouped by email service provider.

/{accountId}/stats/email_service_providers

7 parameters

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.
startDate	string	required	Stats start date in YYYY-MM-DD format.
endDate	string	required	Stats end date in YYYY-MM-DD format.
sendingDomainIds	array	optional	Sending domain IDs to include.
sendingStreams	array	optional	Mailtrap sending streams to include.
categories	array	optional	Mailtrap sending categories to include.
emailServiceProviders	array	optional	Email service provider names to include.

GET

mailtrap_get_permission_resources

List Mailtrap permission resources for an account.

/{accountId}/permissions

1 parameter

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.

GET

mailtrap_get_billing_usage

Retrieve Mailtrap billing usage for an account.

/{accountId}/{segments}

2 parameters

Param	Type	Required	Description
accountId	integer	required	Mailtrap account ID. Omit when the connection has a default account scope.
segments	string	required	Path parameter: segments