Mailgun Notification Medusa
The Mailgun notification provider plugin for Medusa V2, enabling email delivery through Mailgun's robust email service.
Features
- Email Delivery: Send emails via Mailgun API
- Locale Support: Localized email subjects based on user language
- React Email Templates: Build templates using React Email components
- Template Functions: Flexible template configuration
- EU Support: Specific configuration for EU-based Mailgun accounts
Requirements
- Node.js v20 or higher
- Medusa v2.3.0 or higher
- Active Mailgun account with credentials
Installation
Install using pnpm:
pnpm add @webbers/mailgun-notification-medusa
Configuration
Configure the plugin in your medusa-config.ts file:
Required Settings
- API credentials (API key)
- Domain name
- Sender email address
- Template functions
Optional Settings
- API URL (required for EU-based accounts)
Template Configuration
Templates require two functions per email type:
- Subject Function: Generates localized email subjects
- HTML Function: Renders the email body content using React Email
Example Template Structure
{
subject: (locale) => getLocalizedSubject(locale),
html: (data) => <EmailTemplate {...data} />
}
EU Mailgun Accounts
If your Mailgun account is based in the EU, you need to configure a specific API URL in the plugin settings.
Email Types
The plugin supports various email notifications for:
- Order confirmations
- Shipping updates
- Customer communications
- Administrative notifications