notification-nodemailer
Getting Started
Learn how to install and configure the Nodemailer notification provider plugin for Medusa.
View on GitHub
Installation
Install the @perseidesjs/notification-nodemailer plugin in your Medusa project:
yarn add @perseidesjs/notification-nodemailernpm install @perseidesjs/notification-nodemailerYou'll also need to install the nodemailer package:
yarn add nodemailernpm install nodemailerConfiguration
Add the plugin to your medusa-config.ts:
module.exports = defineConfig({
// ... other config
modules: [
{
resolve: "@medusajs/medusa/notification",
options: {
providers: [
// Default provider
{
resolve: "@medusajs/medusa/notification-local",
id: "local",
options: {
name: "Local Notification Provider",
channels: ["feed"],
},
},
// Nodemailer provider
{
resolve: "@perseidesjs/notification-nodemailer/providers/nodemailer",
id: "nodemailer",
options: {
from: process.env.NOTIFICATION_PROVIDER_FROM,
channels: ["email"],
host: process.env.SMTP_HOST,
port: process.env.SMTP_PORT,
secure: false,
auth: {
user: process.env.SMTP_USER,
pass: process.env.SMTP_PASS
}
},
},
],
},
},
]
})Environment Variables
Create a .env file with your SMTP configuration:
NOTIFICATION_PROVIDER_FROM=noreply@example.com
SMTP_HOST=smtp.gmail.com
SMTP_PORT=587
SMTP_USER=your-email@gmail.com
SMTP_PASS=your-app-passwordRequired Options
from: Default sender email addresshost: SMTP server hostnameport: SMTP server port (e.g., 587 for TLS, 465 for SSL)
Optional Options
secure: Use TLS/SSL (default: false)auth: Authentication credentials (user and pass)- Any other Nodemailer SMTP options