https://github.com/perfectwebteam/craft-mailchimp-transactional
Mailchimp Transactional mailer adapter for Craft CMS.
https://github.com/perfectwebteam/craft-mailchimp-transactional
craft-plugin craft3 craftcms mailchimp mailchimp-api-v3 mailchimp-php
Last synced: 5 months ago
JSON representation
Mailchimp Transactional mailer adapter for Craft CMS.
- Host: GitHub
- URL: https://github.com/perfectwebteam/craft-mailchimp-transactional
- Owner: perfectwebteam
- License: mit
- Created: 2022-01-14T15:55:35.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2025-02-14T09:00:32.000Z (over 1 year ago)
- Last Synced: 2025-11-20T03:22:35.268Z (6 months ago)
- Topics: craft-plugin, craft3, craftcms, mailchimp, mailchimp-api-v3, mailchimp-php
- Language: PHP
- Homepage:
- Size: 62.5 KB
- Stars: 0
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
Mailchimp Transactional for Craft CMS
This plugin provides a [Mailchimp Transactional](https://mailchimp.com/features/transactional-email/) integration for [Craft CMS](https://craftcms.com/).
## 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:
```bash
# 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](https://mandrillapp.com/settings/sending-domains).
3. Change the **Transport Type** setting to **Mailchimp Transactional**.
4. Enter your **API Key** from the Mailchimp Transactional [Settings](https://mandrillapp.com/settings) page.
5. Optionally set the **Subaccount** from the Mailchimp Transactional [Subaccounts](https://mandrillapp.com/subaccounts) page.
6. Optionally set the **Template Slug** from the Mailchimp Transactional [Templates](https://mandrillapp.com/templates) page.
7. Click **Save**.
> **Tip:** The API Key, Subaccount and Template Slug settings can be set using environment variables. See [Environmental Configuration](https://craftcms.com/docs/3.x/config/#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
[
'domain.com' => 'mandrill.domain.com'
]
];
```
Brought to you by [Perfect Web Team](https://perfectwebteam.com)