M
Mailer
Send UI-managed email notifications on Medusa store events via SMTP.
@sam-ael/medusa-plugin-mailer
Production-focused email notification plugin for Medusa v2 with event mapping, template rendering, and admin-managed delivery flows.
Highlights
- Admin-managed event -> template mappings
- Template variable mapping with safe path resolution
- SMTP-based delivery with sender profile support
- Workflow-driven event delivery for worker deployments
- Hardened API responses and stricter payload validation
- as the primary update endpoint
- Temporary deprecated compatibility with deprecation headers
Install
yarn add @sam-ael/medusa-plugin-mailer nodemailer
Medusa Configuration
plugins: [{resolve: "@sam-ael/medusa-plugin-mailer",options: {},},]
Environment Variables
MAILER_SMTP_HOST=smtp.gmail.comMAILER_SMTP_PORT=587MAILER_SMTP_USER=your-email@example.comMAILER_SMTP_PASS=your-app-passwordMAILER_SMTP_SECURE=falseMAILER_FROM_NAME_1=My StoreMAILER_FROM_ADDRESS_1=no-reply@mystore.comMAILER_TEMPLATES_DIR=src/email_templatesMAILER_SEND_CONCURRENCY=2
Admin API
| Method | Endpoint | Description |
|---|---|---|
| SMTP and sender profile hints | ||
| List templates and extracted variables | ||
| List mappings (paginated) | ||
| Create mapping | ||
| Update mapping (primary) | ||
| Deprecated compatibility endpoint | ||
| Delete mapping | ||
| Manual/test email send |
Security and Reliability Notes
- Unified error contract:
- Recipient and payload validation at route level
- Mapping updates use direct update flow (no delete/recreate pattern)
- Event-send workflow uses bounded concurrency and per-item failure isolation
- Indexes added for high-frequency lookup fields
Quality Gates
yarn typecheckyarn lintyarn testyarn build
Smoke tests are available under .
License
MIT