Mailgun

Mailgun integration (Communication, Marketing). Imported from open-connector.

API key15 toolshttps://api.mailgun.net

GET

mailgun_list_domains

List Mailgun domains available to the current API key.

/v4/domains

7 parameters

Param	Type	Required	Description
limit	integer	optional	Maximum number of domains to return. Mailgun allows up to 1000.
skip	integer	optional	Number of domains to skip before returning results.
state	string	optional	Domain state filter.
sort	string	optional	Sort option such as name, name:asc, or name:desc.
authority	string	optional	Authority filter for domains.
search	string	optional	Partial or complete domain name to search for.
includeSubaccounts	boolean	optional	Whether to include domains from subaccounts.

GET

mailgun_get_domain

Get Mailgun domain details including DNS records and sending state.

/v4/domains/{domain}

1 parameter

Param	Type	Required	Description
domain	string	required	Mailgun sending domain name.

PUT

mailgun_verify_domain

Ask Mailgun to verify DNS records for a sending domain.

/v4/domains/{domain}/verify

1 parameter

Param	Type	Required	Description
domain	string	required	Mailgun sending domain name.

GET

mailgun_get_domain_tracking_settings

Get open, click, unsubscribe, and web scheme tracking settings for a domain.

/v3/domains/{domain}/tracking

1 parameter

Param	Type	Required	Description
domain	string	required	Mailgun sending domain name.

GET

mailgun_list_events

List delivery, engagement, and failure events for a Mailgun domain.

/v3/{domain}/events

13 parameters

Param	Type	Required	Description
domain	string	required	Mailgun sending domain name.
begin	string	optional	Beginning of the event search range in epoch seconds.
end	string	optional	End of the event search range in epoch seconds.
ascending	string	optional	Mailgun yes/no option value.
limit	integer	optional	Maximum number of events to return. Mailgun allows up to 300.
event	string	optional	Mailgun event type filter.
severity	string	optional	Failure severity filter for failed events.
recipient	string	optional	Filter by recipient email address.
from	string	optional	Filter by From header email address.
to	string	optional	Filter by To header email address.
subject	string	optional	Filter by subject line.
messageId	string	optional	Filter by Mailgun message id.
tags	string	optional	Filter by user-defined tags.

GET

mailgun_list_suppressions

List records from a Mailgun suppression or allowlist table.

/v3/{domain}/{suppressionPathByKind}

7 parameters

Param	Type	Required	Description
domain	string	required	Mailgun sending domain name.
kind	string	required	Suppression table to operate on.
limit	integer	optional	Maximum number of suppression records to return.
page	string	optional	Suppression page direction.
address	string	optional	Address divider for paginated suppression responses.
term	string	optional	Prefix used to filter suppression records.
suppressionPathByKind	string	required	Path parameter: suppressionPathByKind

GET

mailgun_get_suppression

Get one Mailgun suppression or allowlist record.

/v3/{domain}/{suppressionPathByKind}/{value}

4 parameters

Param	Type	Required	Description
domain	string	required	Mailgun sending domain name.
kind	string	optional	Suppression table to operate on.
value	string	required	Suppressed email address or allowlist entry value.
suppressionPathByKind	string	required	Path parameter: suppressionPathByKind

POST

mailgun_add_suppression

Add one Mailgun suppression or allowlist record.

/v3/{domain}/{suppressionPathByKind}

9 parameters

Param	Type	Required	Description
domain	string	required	Mailgun sending domain name.
kind	string	required	Suppression table to operate on.
address	string	optional	Suppressed email address.
allowlistDomain	string	optional	Domain value to add to the Mailgun allowlist.
code	string	optional	Bounce error code. Defaults to Mailgun's value when omitted.
error	string	optional	Bounce error description.
tags	string	optional	Unsubscribe tag, or * for all domain correspondence.
createdAt	string	optional	Event timestamp in RFC 2822 format.
suppressionPathByKind	string	required	Path parameter: suppressionPathByKind

DELETE

mailgun_delete_suppression

Remove one Mailgun suppression or allowlist record.

/v3/{domain}/{suppressionPathByKind}/{value}

4 parameters

Param	Type	Required	Description
domain	string	required	Mailgun sending domain name.
kind	string	optional	Suppression table to operate on.
value	string	required	Suppressed email address or allowlist entry value.
suppressionPathByKind	string	required	Path parameter: suppressionPathByKind

GET

mailgun_list_templates

List templates stored for a Mailgun domain.

/v3/{domain}/templates

4 parameters

Param	Type	Required	Description
domain	string	required	Mailgun sending domain name.
page	string	optional	Mailgun page direction.
limit	integer	optional	Number of templates or versions to retrieve. Mailgun allows up to 100.
pivot	string	optional	Pivot value used by Mailgun for next or previous pages.

GET

mailgun_get_template

Get metadata for one Mailgun template and optionally its active version.

/v3/{domain}/templates/{templateName}

3 parameters

Param	Type	Required	Description
domain	string	required	Mailgun sending domain name.
templateName	string	required	Mailgun template name.
active	boolean	optional	Whether to include the active template version content.

POST

mailgun_create_template

Create a Mailgun template and optionally its initial active version.

/v3/{domain}/templates

8 parameters

Param	Type	Required	Description
domain	string	required	Mailgun sending domain name.
name	string	required	Mailgun template name.
description	string	optional	Template description.
createdBy	string	optional	Optional creator metadata stored by Mailgun.
template	string	optional	Initial template content.
tag	string	optional	Initial version tag. Mailgun defaults to initial when omitted.
comment	string	optional	Initial version comment.
headers	object	optional	String map forwarded to Mailgun.

GET

mailgun_list_template_versions

List versions for a Mailgun template.

/v3/{domain}/templates/{templateName}/versions

5 parameters

Param	Type	Required	Description
domain	string	required	Mailgun sending domain name.
templateName	string	required	Mailgun template name.
page	string	optional	Mailgun page direction.
limit	integer	optional	Number of template versions to retrieve. Mailgun allows up to 100.
pivot	string	optional	Pivot value used by Mailgun for next or previous pages.

GET

mailgun_get_template_version

Get content and metadata for one Mailgun template version.

/v3/{domain}/templates/{templateName}/versions/{versionName}

3 parameters

Param	Type	Required	Description
domain	string	required	Mailgun sending domain name.
templateName	string	required	Mailgun template name.
versionName	string	required	Mailgun template version tag.

POST

mailgun_create_template_version

Create a new version for a Mailgun template.

/v3/{domain}/templates/{templateName}/versions

7 parameters

Param	Type	Required	Description
domain	string	required	Mailgun sending domain name.
templateName	string	required	Mailgun template name.
template	string	required	Template version content.
tag	string	required	Unique tag for the new template version.
comment	string	optional	Comment for the new template version.
active	boolean	optional	Whether the new version should become active.
headers	object	optional	String map forwarded to Mailgun.