How to send email with Mandrill

How to send transactional email notifications to Mandrill with Knock.

Knock integrates with Mandrill to send email notifications to your users. This page describes how to get started with Mandrill in Knock, including necessary provider configurations and additional data you can pass through to Mandrill.

Features

Attachments support
Delivery tracking
Knock link and open tracking
Mandrill link and open tracking
Per environment configuration
Sandbox mode

Getting started

You can create a new Mandrill channel in the dashboard under the Channels and sources page in your account settings. From there, you'll need to configure the channel for each environment you have.

Channel configuration

Configure the following settings per environment. Navigate to Channels and sources in your dashboard account settings and select your Mandrill channel. Under Environment configurations, click the environment you'd like to configure to expand its settings, then click "Save changes" when you're done. Expand Advanced for additional options, including overrides and conditions.

Fields marked with an * are required.

API keystring*

The API key for your Mandrill account.

From email addressstring | liquid*

The default sender email address (can use Liquid tags).

Sandbox modeboolean

Whether to enable sandbox mode for your Mandrill channel.

Open trackingboolean

Whether to enable Knock email-open tracking.

Link trackingboolean

Whether to enable Knock link-click tracking.

CSS inliningboolean

Whether Knock will inline CSS styles in your emails onto their associated HTML elements before sending, to improve email client compatibility. Defaults to true.

Optional Mandrill settings

Open tracking (provider)boolean

Whether to enable Mandrill email-open tracking.

Link tracking (provider)boolean

Whether to enable Mandrill link-click tracking.

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.

From namestring | liquid

The default sender name (can use Liquid tags).

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 along with your emails:

metadata.knock_message_id: the ID of the message this email is associated with
metadata.knock_recipient_id: the Knock ID of the recipient this email is being sent to

Recipient data requirements

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