Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@rootxpdev/medusa-email-plugin) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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

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

yarn add @rootxpdev/medusa-email-plugin

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

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

yarn link

Run this command inside your medusa backend folder to use it

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

Test emails

Launch your medusajs backend and call the following endpoint

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