Docs
/
Contact supportLog inGet started
Platform
Integrations
Building in-app UI
API reference
CLI reference
Management API
Developer tools
Tutorials
Email
Mailgun

How to send email with Mailgun

How to send transactional email notifications to Mailgun with Knock.

Knock integrates with Mailgun to send email notifications to your users.

In this guide you'll learn how to get started sending transactional email notifications with Mailgun through Knock. We also cover provider configuration and additional data you can pass through to Mailgun.

Features

  • Attachments support
  • Delivery tracking
  • Bounce Support
  • Knock link and open tracking
  • Mailgun link and open tracking
  • Per environment configuration
  • Sandbox mode

Getting started

You can create a new Mailgun channel in the dashboard under the Integrations > Channels section. From there, you'll need to configure the channel for each environment you have.

Channel configuration

The following channel settings should be configured per environment. Navigate to Integrations > Channels in your dashboard, select your Mailgun channel, then click "Manage configuration" under the environment that you'd like to configure.

Fields marked with an * are required.

Knock settings

Sandbox modeboolean
Whether to enable sandbox mode for your Mailgun channel.
Knock open trackingboolean
Whether to enable Knock email-open tracking.
Knock link trackingboolean
Whether to enable Knock link-click tracking.

Provider settings for Mailgun

API keystring*
The private API key for your Mailgun account.
Domainstring*
The domain verified with Mailgun for sending emails.
Mailgun regionenum*
The sending region (US or EU) for your Mailgun account.
Open trackingboolean
Whether to enable Mailgun email-open tracking.
Link trackingboolean
Whether to enable Mailgun link-click tracking.
From email addressstring | liquid*
The default sender email address (can use Liquid tags).
From namestring | liquid
The default sender name (can use Liquid tags).

When configured, these optional overrides will apply to all emails sent from this channel in the configured environment. Learn more about email channel overrides here.

Tostring | liquid
The To email address that email notifications will be sent to (can use Liquid tags). This value will override the designated recipient's email address.
Ccstring | liquid
The CC email address that email notifications will be sent to (can use Liquid tags).
Bccstring | liquid
The BCC email address that email notifications will be sent to (can use Liquid tags).
Reply-tostring | liquid
The reply-to email address that will be included on email notifications (can use Liquid tags).
Payload overridesJSON (string) | liquid
Provide a JSON object to merge into the API payload that is sent to the downstream provider.

Set optional per-environment conditions for this channel. These conditions are evaluated each time a workflow run encounters a step that uses this channel in the configured environment. If the conditions are not met, the step will be skipped.

Additional data sent

Knock sends the following attributes to Mailgun along with your emails:

  • v:sender: always set to knock.app
  • v:knock_message_id: the ID of the message this email is associated with
  • v:knock_recipient_id: the Knock ID of the recipient this email is being sent to
  • o:tag: the workflow key for the workflow being invoked

You can learn about the role of these Mailgun attributes in the Mailgun API documentation.

Recipient data requirements

In order to send an email notification you'll need a valid email property set on your recipient.

Delivery tracking

Delivery tracking for Mailgun can result in the following status updates to your message:

  • The message delivery is confirmed and Knock updates the message to delivered
  • The message was not delivered and Knock updates the message to undelivered
  • The message was not delivered due to bad recipient(s) and Knock updates the message to bounced

Passing additional tags to Mailgun

It's possible to pass additional tags to Mailgun by setting the "JSON overrides" attribute in the channel configuration or at the message template level.

To pass one or more tags, you can set the o:tag attribute to an array of tag names: