Skip to main content
Server path: /mailtrap-sending | Type: Application | PCID required: Yes

Tools


mailtrap_sending_create_email_template

Create Email Template Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID
email_templateobjectYesEmail Template

mailtrap_sending_create_sending_domain

Create sending domain Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID
sending_domainobjectYesSending Domain

mailtrap_sending_create_sending_domain_company_info

Create company info Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID
sending_domain_idintegerYesSending domain ID
company_infoobjectYesCompany Info

mailtrap_sending_delete_domain

Delete sending domain Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID
sending_domain_idintegerYesSending domain ID

mailtrap_sending_delete_email_template

Delete Email Template Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID
email_template_idintegerYesEmail template ID

mailtrap_sending_delete_suppression

Delete suppression Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID
suppression_idintegerYesSuppression ID

mailtrap_sending_email_templates

Get all Email Templates Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID

mailtrap_sending_get_account_sending_stats

Get Sending Stats Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID
start_datestringYesStart date for which to include the results.
end_datestringYesEnd date for which to include the results.
sending_domain_ids[]integer[]NoIDs of the sending domains for which to include the results. If not provided, results for all sending domains will be included.
sending_streams[]string[]NoSending streams for which to include the results. If not provided, results for all sending streams will be included.
categories[]string[]NoCategories for which to include the results. If not provided, results for all categories will be included.
email_service_providers[]string[]NoEmail service providers for which to include the results. If not provided, results for all ESPs will be included.

mailtrap_sending_get_account_sending_stats_by_categories

Get Sending Stats by Categories Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID
start_datestringYesStart date for which to include the results.
end_datestringYesEnd date for which to include the results.
sending_domain_ids[]integer[]NoIDs of the sending domains for which to include the results. If not provided, results for all sending domains will be included.
sending_streams[]string[]NoSending streams for which to include the results. If not provided, results for all sending streams will be included.
categories[]string[]NoCategories for which to include the results. If not provided, results for all categories will be included.
email_service_providers[]string[]NoEmail service providers for which to include the results. If not provided, results for all ESPs will be included.

mailtrap_sending_get_account_sending_stats_by_date

Get Sending Stats by Date Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID
start_datestringYesStart date for which to include the results.
end_datestringYesEnd date for which to include the results.
sending_domain_ids[]integer[]NoIDs of the sending domains for which to include the results. If not provided, results for all sending domains will be included.
sending_streams[]string[]NoSending streams for which to include the results. If not provided, results for all sending streams will be included.
categories[]string[]NoCategories for which to include the results. If not provided, results for all categories will be included.
email_service_providers[]string[]NoEmail service providers for which to include the results. If not provided, results for all ESPs will be included.

mailtrap_sending_get_account_sending_stats_by_domains

Get Sending Stats by Domains Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID
start_datestringYesStart date for which to include the results.
end_datestringYesEnd date for which to include the results.
sending_domain_ids[]integer[]NoIDs of the sending domains for which to include the results. If not provided, results for all sending domains will be included.
sending_streams[]string[]NoSending streams for which to include the results. If not provided, results for all sending streams will be included.
categories[]string[]NoCategories for which to include the results. If not provided, results for all categories will be included.
email_service_providers[]string[]NoEmail service providers for which to include the results. If not provided, results for all ESPs will be included.

mailtrap_sending_get_account_sending_stats_by_email_service_providers

Get Sending Stats by Email Service Providers Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID
start_datestringYesStart date for which to include the results.
end_datestringYesEnd date for which to include the results.
sending_domain_ids[]integer[]NoIDs of the sending domains for which to include the results. If not provided, results for all sending domains will be included.
sending_streams[]string[]NoSending streams for which to include the results. If not provided, results for all sending streams will be included.
categories[]string[]NoCategories for which to include the results. If not provided, results for all categories will be included.
email_service_providers[]string[]NoEmail service providers for which to include the results. If not provided, results for all ESPs will be included.

mailtrap_sending_get_domain

Get sending domain Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID
sending_domain_idintegerYesSending domain ID

mailtrap_sending_get_domain_company_info

Get company info Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID
sending_domain_idintegerYesSending domain ID

mailtrap_sending_get_domains

List sending domains Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID

mailtrap_sending_get_email_log_message

Get an email log message by ID Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID
sending_message_idstringYesMessage UUID

mailtrap_sending_get_email_template

Get Email Template Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID
email_template_idintegerYesEmail template ID

mailtrap_sending_get_suppressions

List suppressions Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID
emailstringNoSearch for specific email address
start_timestringNoSearch emails suppressed after this timestamp
end_timestringNoSearch emails suppressed after this timestamp

mailtrap_sending_list_email_logs

List email logs Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID
search_afterstringNoCursor for the next page (message_id UUID from previous response next_page_cursor).
filtersobjectNoFilter 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.

mailtrap_sending_send_sending_domain_setup_instructions

Send setup instructions Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID
sending_domain_idintegerYesSending domain ID
emailstringYesEmail address to receive setup instructions

mailtrap_sending_update_email_template

Update Email Template Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID
email_template_idintegerYesEmail template ID
email_templateobjectYesEmail Template

mailtrap_sending_update_sending_domain

Update sending domain Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID
sending_domain_idintegerYesSending domain ID
sending_domainobjectYesSending Domain

mailtrap_sending_update_sending_domain_company_info

Update company info Parameters:
ParameterTypeRequiredDefaultDescription
account_idintegerYesUnique account ID
sending_domain_idintegerYesSending domain ID
company_infoobjectYesAll fields are optional. Only the fields provided in the request will be updated.