craftcms/mailgun

Mailgun integration for Craft CMS

3.1.0 2024-03-19 21:34 UTC

Requires

• php: ^8.0.2
• craftcms/cms: ^4.0.0-alpha.1|^5.0.0-beta.1
• symfony/mailgun-mailer: ^6.0.3|7.0.4

Requires (Dev)

• craftcms/ecs: dev-main
• craftcms/phpstan: dev-main
• craftcms/rector: dev-main

MIT

• Pixel & Tonic

• mailer
• cms
• mailgun
• yii2
• craftcms

README

Mailgun for Craft CMS

This plugin provides a Mailgun integration for Craft CMS.

Requirements

This plugin requires Craft CMS 4.0.0+ or 5.0.0+.

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 “Mailgun”. 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 craftcms/mailgun

# tell Craft to install the plugin
./craft install/plugin mailgun

Setup

Once Mailgun is installed, go to Settings → Email, and change the “Transport Type” setting to “Mailgun”. Enter your domain name and Mailgun API Key (which you can get from your domain overview page) and click Save.

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