Medusa Marketing

Note: This plugin will be migrated to Medusa v2, when v2 will reach production readiness.

What is it?

How to install?

1. Install the package with Copy to clipboardyarn add @rsc-labs/medusa-marketing or Copy to clipboardnpm i @rsc-labs/medusa-marketing.
2. In Copy to clipboardmedusa-config.js, add the plugin to the Copy to clipboardplugins array and set Copy to clipboardenableUI

123456789
const plugins = [
  // ... other plugins
  {
    resolve: `@rsc-labs/medusa-marketing`,
    options: {
      enableUI: true
    }
  }
]

3. Run migrations, e.g. Copy to clipboardnpx medusa migrations run (see: https://docs.medusajs.com/development/entities/migrations/overview) as plugin uses new tables.

Getting started

Before running a Medusa

1234567891011121314151617181920
  {
    resolve: "@rsc-labs/medusa-marketing",
    options: {
      enableUI: true,
    },
    email_transports: [
        {
          name: 'smtp',
          configuration: {
            host: "smtp.gmail.com",
            port: 465,
            secure: true,
            auth: {
              user: "user@gmail.com",
              pass: "app-password"
            }
          }
        }
      ]
  }

Templates

1
  templateDir: `../my-email-templates`

123456789
.
└── my-email-templates
    └── html
        └── <template-name>
            └──html.html
    └── pug
        └── <template-name>
          ├── html.pug
          └── subject.pug

After configuration

• Copy to clipboardWelcome and Copy to clipboardBack in stock cards indicates two actions which can be configured. There can be more in the future. You can notice there following information:
  • status of action - first time you see Copy to clipboardUndefined, but when you will configure it, then you will see Copy to clipboardEnabled or Copy to clipboardDisabled
  • emails processed - this stat describes how many emails have been processed under this action
  • subscriptions - this stat describes how many subscribtions this action has
• Copy to clipboardRecent activity card shows the processed or failed emails.

Processed and failed emails

Settings

• Copy to clipboardSee trigger and parameters
  • click on the icon and you will see what is a exact trigger and what parameters you can use in your templates.
• Copy to clipboardEnable....
  • simply - enable or disable sending messages
• Copy to clipboardEmail subject
  • subject of an email, which will be send
• Copy to clipboardChoose template for email
  • if you properly configured a plugin (see Before running a Medusa), you shall be able to choose a predefined template.

Subscriptions

Q&A

Why it is so complicated?

Proposals, bugs, improvements

License