Smtp senpai

Name: Smtp senpai
Author: Mailsenpai

Medusa v2 notification module provider for SMTP Senpai by MailSenpai: send order and customer emails on the email channel through the EU SMTP relay API.

npm install medusa-plugin-smtp-senpai

medusa-plugin-smtp-senpai

Medusa v2 Notification Module Provider for SMTP Senpai, the EU SMTP relay and email API by MailSenpai. It handles the channel: order confirmations, password resets, invites and any notification you create with the Notification Module go out through the SMTP Senpai REST API.

Requires Medusa 2.x and Node.js 20+.

Prerequisites

An SMTP Senpai account with a verified sending domain
An API key () from the MailSenpai customer area, SMTP Senpai page

Install

Configure

Medusa allows one provider per channel: remove any other provider registered for .

option	required	description
	yes
	yes	API key (default: )
	yes	default sender, or
	no	sender name when has none
	no	default Reply-To
	no	templates by name, used when a notification has no
, ,	no	client settings (retries only on 5xx and network errors)

Send a notification

With ready-made content (for example rendered with React Email in your subscriber):

Templates in the provider options

When a notification has no , the provider looks up . A template is either strings with placeholders filled from (values are HTML-escaped in ), or a function:

Result and errors

On success the notification gets the SMTP Senpai Message-ID as .
API errors (for example an unverified sender domain) are thrown as with the API message, so the notification is marked as failed.
A recipient on the SMTP Senpai suppression list is not emailed and the notification fails with the reason.

License

MIT © MailSenpai

First received message and troubleshooting

Use a demo order on staging and trigger its notification subscriber. Confirm that the email channel selects this provider and that its external_id is recorded. Installing the provider does not create an order subscriber or a template for your store.

A relay/API acceptance result is distinct from inbox placement. Check the actual received message and its authentication headers. Keep API keys and customer data out of public screenshots and logs.

If authentication fails, check the key and account state. For a sender-domain rejection, verify the sender domain. For quota/rate errors, respect the response and the plan limit rather than retrying blindly. For a timeout, check outbound HTTPS access. Use a stable idempotency key for retries where the integration exposes it.

Package catalogue · API errors and delivery events · Integration guides

Service logs are retained for 7 days on the free plan and 90 days on paid plans. Local application logs may have different retention.

Smtp senpai

Medusa v2 notification module provider for SMTP Senpai by MailSenpai: send order and customer emails on the email channel through the EU SMTP relay API.

npm install medusa-plugin-smtp-senpai

medusa-plugin-smtp-senpai

Requires Medusa 2.x and Node.js 20+.

Prerequisites

An SMTP Senpai account with a verified sending domain
An API key () from the MailSenpai customer area, SMTP Senpai page

Install

1npm install medusa-plugin-smtp-senpai
2# or
3yarn add medusa-plugin-smtp-senpai

Configure

1import { defineConfig, Modules } from '@medusajs/framework/utils'
2
3module.exports = defineConfig({
// ...
modules: [
  {
    resolve: '@medusajs/medusa/notification',
    options: {
      providers: [
        {
          resolve: 'medusa-plugin-smtp-senpai',
          id: 'smtp-senpai',
          options: {
            channels: ['email'],
            api_key: process.env.SMTP_SENPAI_API_KEY,
            from: 'Your shop <orders@yourdomain.com>', // verified domain
            reply_to: 'support@yourdomain.com',        // optional
            // templates: { ... }                      // optional, see below
          },
        },
      ],
    },
  },
],
25})

Medusa allows one provider per channel: remove any other provider registered for .

option	required	description
	yes
	yes	API key (default: )
	yes	default sender, or
	no	sender name when has none
	no	default Reply-To
	no	templates by name, used when a notification has no
, ,	no	client settings (retries only on 5xx and network errors)

Send a notification

With ready-made content (for example rendered with React Email in your subscriber):

1import { Modules } from '@medusajs/framework/utils'
2
3const notificationModuleService = container.resolve(Modules.NOTIFICATION)
4
5await notificationModuleService.createNotifications({
to: order.email,
channel: 'email',
template: 'order-placed',
content: {
  subject: `Order #${order.display_id} confirmed`,
  html: '<p>Thanks for your order.</p>',
  text: 'Thanks for your order.',
},
attachments: [
  { filename: 'invoice.pdf', content: pdfBase64, content_type: 'application/pdf' },
],
provider_data: {
  idempotency_key: `order-placed-${order.id}`, // optional: never sent twice within 24 h
  headers: { 'X-Order': String(order.display_id) }, // optional, X- headers only
  reply_to: 'orders@yourdomain.com',            // optional
},
22})

Templates in the provider options

When a notification has no , the provider looks up . A template is either strings with placeholders filled from (values are HTML-escaped in ), or a function:

1options: {
channels: ['email'],
api_key: process.env.SMTP_SENPAI_API_KEY,
from: 'orders@yourdomain.com',
templates: {
  'order-placed': {
    subject: 'Order #{{ order.display_id }} confirmed',
    html: '<p>Hi {{ customer.first_name }}, thanks for your order.</p>',
    text: 'Hi {{ customer.first_name }}, thanks for your order.',
  },
  'password-reset': (data) => ({
    subject: 'Reset your password',
    html: `<a href="${data.url}">Reset password</a>`,
  }),
},
16}

1await notificationModuleService.createNotifications({
2  to: customer.email,
3  channel: 'email',
4  template: 'order-placed',
5  data: { order: { display_id: order.display_id }, customer: { first_name: customer.first_name } },
6})

Result and errors

On success the notification gets the SMTP Senpai Message-ID as .
API errors (for example an unverified sender domain) are thrown as with the API message, so the notification is marked as failed.
A recipient on the SMTP Senpai suppression list is not emailed and the notification fails with the reason.

License

First received message and troubleshooting

A relay/API acceptance result is distinct from inbox placement. Check the actual received message and its authentication headers. Keep API keys and customer data out of public screenshots and logs.

Package catalogue · API errors and delivery events · Integration guides

Service logs are retained for 7 days on the free plan and 90 days on paid plans. Local application logs may have different retention.

Smtp senpai

medusa-plugin-smtp-senpai

Prerequisites

Install

Configure

Send a notification

Templates in the provider options

Result and errors

Links

License

First received message and troubleshooting

More in this category

Nodemailer

Mailgun

Postmark

Smtp senpai

medusa-plugin-smtp-senpai

Prerequisites

Install

Configure

Send a notification

Templates in the provider options

Result and errors

Links

License

First received message and troubleshooting

More in this category

Nodemailer

Mailgun

Postmark