README

Mailchimp Transactional for Craft CMS

This plugin provides a Mailchimp Transactional integration for Craft CMS.

Requirements

This plugin requires Craft CMS 4.0.0+ or 5.0.0+.

Installation

You can install this plugin from the Plugin Store or with Composer.

From the Plugin Store

Go to the Plugin Store in your project’s Control Panel and search for “Mailchimp Transactional”. Then click on the “Install” button in its modal window.

With Composer

Open your terminal and run the following commands:

# go to the project directory
cd /path/to/my-project.test

# tell Composer to load the plugin
composer require perfectwebteam/craft-mailchimp-transactional

# tell Craft to install the plugin
./craft install/plugin craft-mailchimp-transactional

Setup

Once Mailchimp Transactional is installed:

1. Go to Settings → Email.
2. Make sure that the System Email Address is set to an email for which the domain is a verified Sending Domain.
3. Change the Transport Type setting to Mailchimp Transactional.
4. Enter your API Key from the Mailchimp Transactional Settings page.
5. Optionally set the Subaccount from the Mailchimp Transactional Subaccounts page.
6. Optionally set the Template Slug from the Mailchimp Transactional Templates page.
7. Click Save.

Tip: The API Key, Subaccount and Template Slug settings can be set using environment variables. See Environmental Configuration in the Craft docs to learn more about that.

Custom Return-Path

Register Return-Path domains in Mandrill: https://mandrillapp.com/settings/tracking-domains to allow for a custom Return-Path as described here: https://mailchimp.com/developer/transactional/docs/authentication-delivery/#custom-return-path-domains

Configure the Return-Path via your config/mailchimp-transactional.php config file by adding:

<?php

return [
	'returnPaths' => [
		'domain.com' => 'mandrill.domain.com'
	]
];

Brought to you by Perfect Web Team