Medusa email plugin

Send emails on certain actions in medusa store

Email templates

All email templates are stored under data/emails directory. This directory can be copy-pasted inside your medusa backend root directory.

Installation

Run the following command

1
npm install --save @rootxpdev/medusa-email-plugin

1
yarn add @rootxpdev/medusa-email-plugin

Add the following values to your medusa-config.js file

1234567891011121314
const plugins = [
  // ...other plugin configuration
  {
    resolve: "@rootxpdev/medusa-email-plugin",
    options: {
        templateDir: "node_modules/@rootxpdev/medusa-email-plugin/data/emails",
        fromAddress: "noreply@mymedusastore.com",
        smtpHost: "sandbox.smtp.mailtrap.io",
        smtpPort: 2525,
        smtpUser: "xxx",
        smtpPassword: "xxx",
    }
  },
];

Testing locally

Run the following command to register this module locally

1
yarn link

Run this command inside your medusa backend folder to use it

1
yarn link "@rootxpdev/medusa-email-plugin"

Test emails

Launch your medusajs backend and call the following endpoint

123456789
curl --request POST \
  --url http://localhost:9000/admin/email_test \
  --header 'Content-Type: application/json' \
  --data '{
    "event": "testing",
    "payload": {
        "foo": "bar"
    }
}'

Build your own plugins

Develop your own plugins with our API to speed up your processes.

Make your plugin available via npm for it to be shared in our Plugin Library with the broader Medusa community.

Built by

Category