> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Mailgun

> How to set up the Mailgun connector, plus the actions and events that are available.

![Mailgun](https://stackone-logos.com/api/mailgun/filled/svg)

v1.3.0[See changelog](https://docs.stackone.com/connectors/mailgun/changelog.md)

[96 actions](#actions) · [9 events](#events) · 1 auth method

Messaging
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/mailgun/guides/connector-profile/api-key.md)
>
> Use your Mailgun private API key for authentication. Access API Security from your account dropdown menu in the top-righ...

Optionally, configure receiving Events for Mailgun into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/mailgun/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/mailgun/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

96 actions

ActionDescription

List Sending Metrics`mailgun_list_sending_metrics`

Query detailed email sending and engagement analytics metrics.

List Usage Metrics`mailgun_list_usage_metrics`

Query usage metrics for Mailgun services such as email validation and previews.

List Email Logs`mailgun_list_logs`

Query detailed email event logs for a time range with filtering support.

Get Tag`mailgun_get_tag`

Retrieve an analytics tag by name and optionally update its description.

Update Tag`mailgun_update_tag`

Update the description of an existing analytics tag.

Delete Tag`mailgun_delete_tag`

Delete an analytics tag from the account.

List Email Events`mailgun_list_events`

Retrieve a log of email events for a domain within a time period.

List SMTP Credentials`mailgun_list_smtp_credentials`

List all SMTP credentials configured for a domain.

Create SMTP Credential`mailgun_create_smtp_credential`

Create a new SMTP login credential for a domain.

Update SMTP Credential`mailgun_update_smtp_credential`

Update the password for an existing SMTP credential.

Delete SMTP Credential`mailgun_delete_smtp_credential`

Permanently delete an SMTP credential from a domain.

List Domains`mailgun_list_domains`

List all domains associated with the Mailgun account.

Create Domain`mailgun_create_domain`

Add a new sending domain to the Mailgun account.

Get Domain`mailgun_get_domain`

Retrieve details and DNS verification status for a specific domain.

Update Domain`mailgun_update_domain`

Update configuration settings for an existing domain.

Verify Domain`mailgun_verify_domain`

Trigger DNS verification for a domain to confirm DNS records are correctly configured.

Delete Domain`mailgun_delete_domain`

Permanently delete a domain from the Mailgun account.

Get Domain Tracking Settings`mailgun_get_domain_tracking`

Retrieve the click, open, and unsubscribe tracking settings for a domain.

Update Click Tracking`mailgun_update_click_tracking`

Enable or disable click tracking for links in emails sent from a domain.

Update Open Tracking`mailgun_update_open_tracking`

Enable or disable open tracking for emails sent from a domain.

Update Unsubscribe Tracking`mailgun_update_unsubscribe_tracking`

Enable or disable unsubscribe tracking and footer injection for a domain.

Get Unified Credentials`mailgun_unified_get_me`

Get the current Mailgun connection's unified credentials and identity.

List Unified Groups`mailgun_unified_list_groups`

List unified groups in Mailgun.

Get Unified Group`mailgun_unified_get_group`

Get a unified Mailgun group by ID.

List Unified Roles`mailgun_unified_list_roles`

List unified roles in Mailgun.

Get Unified Role`mailgun_unified_get_role`

Get a unified Mailgun role by ID.

List Unified Users`mailgun_unified_list_users`

List unified users in Mailgun.

Get Unified User`mailgun_unified_get_user`

Get a unified Mailgun user by ID.

List IPs`mailgun_list_ips`

List all IP addresses allocated to the Mailgun account.

Get IP`mailgun_get_ip`

Retrieve details for a specific IP address allocated to the account.

List IP Pools`mailgun_list_ip_pools`

List all IP pools configured on the Mailgun account.

Create IP Pool`mailgun_create_ip_pool`

Create a new IP pool to group dedicated IPs for a sending stream.

Get IP Pool`mailgun_get_ip_pool`

Retrieve details of a specific IP pool.

List Mailing Lists`mailgun_list_mailing_lists`

List all mailing lists associated with the Mailgun account.

Create Mailing List`mailgun_create_mailing_list`

Create a new mailing list for bulk email distribution.

Get Mailing List`mailgun_get_mailing_list`

Retrieve details of a specific mailing list by its email address.

Update Mailing List`mailgun_update_mailing_list`

Update the settings of an existing mailing list.

Delete Mailing List`mailgun_delete_mailing_list`

Permanently delete a mailing list and all its members.

List Mailing List Members`mailgun_list_mailing_list_members`

List all members of a specific mailing list.

Create Mailing List Member`mailgun_create_mailing_list_member`

Add a new member to a mailing list.

Get Mailing List Member`mailgun_get_mailing_list_member`

Retrieve the details of a specific mailing list member.

Update Mailing List Member`mailgun_update_mailing_list_member`

Update the details or subscription status of an existing mailing list member.

Delete Mailing List Member`mailgun_delete_mailing_list_member`

Remove a member from a mailing list.

Send Email`mailgun_send_email`

Send an email message via Mailgun for the specified domain.

Send Email (MIME)`mailgun_send_email_mime`

Send an email in raw MIME format via Mailgun for the specified domain.

List Sending Queues`mailgun_list_sending_queues`

Retrieve the current state of the sending queues for a domain.

List Routes`mailgun_list_routes`

List all inbound email routing rules configured on the account.

Create Route`mailgun_create_route`

Create a new inbound email routing rule.

Get Route`mailgun_get_route`

Retrieve the details of a specific inbound routing rule.

Update Route`mailgun_update_route`

Update an existing inbound email routing rule.

Delete Route`mailgun_delete_route`

Permanently delete an inbound email routing rule.

Match Route`mailgun_match_route`

Test which routes match a given recipient email address without sending an email.

List Subaccounts`mailgun_list_subaccounts`

List all subaccounts under the parent Mailgun account.

Create Subaccount`mailgun_create_subaccount`

Create a new subaccount under the parent Mailgun account.

Get Subaccount`mailgun_get_subaccount`

Retrieve details of a specific subaccount.

Enable Subaccount`mailgun_enable_subaccount`

Re-enable a previously disabled subaccount.

Delete Subaccount`mailgun_delete_subaccount`

Permanently delete a subaccount from the parent Mailgun account.

Disable Subaccount`mailgun_disable_subaccount`

Disable a subaccount to suspend its ability to send email.

List Bounces`mailgun_list_bounces`

List all bounce records for a domain's suppression list.

Create Bounce`mailgun_create_bounce`

Manually add an email address to the bounce suppression list for a domain.

Get Bounce`mailgun_get_bounce`

Retrieve the bounce record for a specific email address.

Delete Bounce`mailgun_delete_bounce`

Remove a specific email address from the bounce suppression list.

Delete Bounces`mailgun_delete_bounces`

Clear all bounce records from a domain's suppression list.

List Complaints`mailgun_list_complaints`

List all spam complaint records for a domain's suppression list.

Create Complaint`mailgun_create_complaint`

Manually add an email address to the spam complaint suppression list.

Get Complaint`mailgun_get_complaint`

Retrieve the spam complaint record for a specific email address.

Delete Complaint`mailgun_delete_complaint`

Remove a specific email address from the spam complaint suppression list.

Delete Complaints`mailgun_delete_complaints`

Clear all spam complaint records from a domain's suppression list.

List Unsubscribes`mailgun_list_unsubscribes`

List all unsubscribe records for a domain's suppression list.

Create Unsubscribe`mailgun_create_unsubscribe`

Manually add an email address to the unsubscribe suppression list.

Get Unsubscribe`mailgun_get_unsubscribe`

Retrieve the unsubscribe record for a specific email address.

Delete Unsubscribe`mailgun_delete_unsubscribe`

Remove a specific email address from the unsubscribe suppression list.

Delete Unsubscribes`mailgun_delete_unsubscribes`

Clear all unsubscribe records from a domain's suppression list.

List Allowlist`mailgun_list_allowlist`

List all entries in the bounce allowlist for a domain.

Create Allowlist Entry`mailgun_create_allowlist_entry`

Add an email address or domain to the bounce allowlist.

Get Allowlist Entry`mailgun_get_allowlist_entry`

Retrieve a specific entry from the bounce allowlist.

Delete Allowlist Entry`mailgun_delete_allowlist_entry`

Remove a specific entry from the bounce allowlist.

List Account Templates`mailgun_list_account_templates`

List all email templates stored at the account level.

Create Account Template`mailgun_create_account_template`

Create a new email template at the account level.

Get Account Template`mailgun_get_account_template`

Retrieve details of a specific account-level template.

Update Account Template`mailgun_update_account_template`

Update the metadata of an existing account-level template.

Delete Account Template`mailgun_delete_account_template`

Permanently delete an account-level template and all its versions.

List Account Template Versions`mailgun_list_account_template_versions`

List all versions of a specific account-level template.

Create Account Template Version`mailgun_create_account_template_version`

Add a new version to an existing account-level template.

Get Account Template Version`mailgun_get_account_template_version`

Retrieve a specific version of an account-level template.

Update Account Template Version`mailgun_update_account_template_version`

Update the content or status of a specific account template version.

Delete Account Template Version`mailgun_delete_account_template_version`

Delete a specific version of an account-level template.

Copy Account Template`mailgun_copy_account_template`

Copy one or more account-level templates to a destination domain.

Rename Account Template`mailgun_rename_account_template`

Rename an existing account-level template.

List Domain Templates`mailgun_list_domain_templates`

List all email templates stored at the domain level (v3 API).

List Users`mailgun_list_users`

List all users associated with the Mailgun account.

Get Current User`mailgun_get_current_user`

Retrieve the profile of the currently authenticated user.

Get User`mailgun_get_user`

Retrieve the profile of a specific user by their user ID.

List Webhooks`mailgun_list_webhooks`

List all webhooks configured on the Mailgun account.

Create Webhook`mailgun_create_webhook`

Register a new webhook endpoint to receive Mailgun event notifications.

Delete Webhook`mailgun_delete_webhook`

Remove a webhook endpoint from the Mailgun account.

## Events

Tags

Select all
|
Clear

Engagement

Failures

Messages

Webhooks

No tags found

9 events

EventDescriptionTags

Test Webhook Ping`mailgun_webhook_ping`

Acknowledges Mailgun test webhook deliveries without emitting an event.

Webhooks

Accepted Webhook`mailgun_webhook_accepted`

Processes Mailgun accepted webhook events.

MessagesWebhooks

Delivered Webhook`mailgun_webhook_delivered`

Processes Mailgun delivered webhook events.

MessagesWebhooks

Opened Webhook`mailgun_webhook_opened`

Processes Mailgun opened webhook events.

EngagementWebhooks

Clicked Webhook`mailgun_webhook_clicked`

Processes Mailgun clicked webhook events.

EngagementWebhooks

Unsubscribed Webhook`mailgun_webhook_unsubscribed`

Processes Mailgun unsubscribed webhook events.

EngagementWebhooks

Complained Webhook`mailgun_webhook_complained`

Processes Mailgun complained webhook events.

EngagementWebhooks

Permanent Failure Webhook`mailgun_webhook_permanent_fail`

Processes Mailgun permanent\_fail webhook events.

FailuresWebhooks

Temporary Failure Webhook`mailgun_webhook_temporary_fail`

Processes Mailgun temporary\_fail webhook events.

FailuresWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.