Unsend

npm install --save @rokmohar/medusa-plugin-unsend

yarn add @rokmohar/medusa-plugin-unsend

1import { loadEnv, defineConfig } from '@medusajs/framework/utils'
2import { UNSEND_PROVIDER_PATH } from '@rokmohar/medusa-plugin-unsend'
3
4loadEnv(process.env.NODE_ENV || 'development', process.cwd())
5
6module.exports = defineConfig({
7  // ... other config
8  plugins: [
9    // ... other plugins
10    {
11      resolve: '@rokmohar/medusa-plugin-unsend',
12      options: {
13        // Required options
14        url: process.env.UNSEND_URL ?? '',
15        api_key: process.env.UNSEND_API_KEY ?? '',
16        from: process.env.UNSEND_FROM ?? '',
17
18        // Optional configuration
19        templateDir: 'custom/templates/path', // Custom template directory
20        retry: {
21          maxAttempts: 5, // Number of retry attempts for failed sends
22          delay: 2000, // Delay between retries in milliseconds
23        },
24        rateLimit: {
25          maxPerMinute: 30, // Maximum emails per minute
26        },
27        // Environment configurations based on NODE_ENV
28        environment: {
29          development: {
30            // Development-specific overrides
31            from: 'dev@example.com',
32            rateLimit: {
33              maxPerMinute: 25,
34            },
35          },
36          staging: {
37            // Staging-specific overrides
38            from: 'stage@example.com',
39            rateLimit: {
40              maxPerMinute: 50,
41            },
42          },
43          production: {
44            // Production-specific overrides
45            from: 'prod@example.com',
46            rateLimit: {
47              maxPerMinute: 100,
48            },
49          },
50        },
51      },
52    },
53  ],
54  modules: [
55    // ... other modules
56    {
57      resolve: '@medusajs/medusa/notification',
58      dependencies: ['unsend'],
59      options: {
60        providers: [
61          // ... other providers
62          {
63            resolve: UNSEND_PROVIDER_PATH,
64            id: 'unsend',
65            options: {
66              channels: ['email'],
67            },
68          },
69        ],
70      },
71    },
72  ],
73})

1# ... others vars
2UNSEND_URL=
3UNSEND_API_KEY=
4UNSEND_FROM=

1# ... others vars
2UNSEND_URL=http://localhost:3000
3UNSEND_API_KEY=test_123456789
4UNSEND_FROM=no-reply@example.org

1// src/templates/emails/ProductUpsert.tsx
2import React from 'react'
3
4const ProductUpsertEmail = (props: any) => {
5  return (
6    <div>
7      <h1>Product Updated</h1>
8      <p>Product ID: {props.productId}</p>
9    </div>
10  )
11}
12
13// Set email subject
14ProductUpsertEmail.Subject = 'Products upserted'
15
16export default ProductUpsertEmail

1// src/templates/emails/ProductUpsert.json
2{
3  "version": "1.0.0",
4  "subject": "Product upsert",
5  "description": "Email template for product updates",
6  "tags": ["product", "update"],
7  "category": "product-notifications"
8}

1import { SubscriberArgs, SubscriberConfig } from '@medusajs/framework'
2import { IProductModuleService } from '@medusajs/framework/types'
3import { Modules } from '@medusajs/framework/utils'
4import { ProductEvents, SearchUtils } from '@medusajs/utils'
5import { UnsendService } from '@rokmohar/medusa-plugin-unsend/core'
6
7export default async function productCreatedHandler({ event: { data }, container }: SubscriberArgs<{ id: string }>) {
8  const productId = data.id
9
10  // Make sure template is registered, before creating email notifications
11  const unsendService: UnsendService = container.resolve('unsend')
12
13  const notificationModuleService = container.resolve(Modules.NOTIFICATION)
14  await notificationModuleService.createNotifications({
15    to: 'first.last@example.org',
16    channel: 'email',
17    // Use name of the registered template
18    template: 'product-upsert',
19    // Set email subject
20    content: {
21      subject: 'Product upserted',
22    },
23  })
24}
25
26export const config: SubscriberConfig = {
27  event: [ProductEvents.PRODUCT_CREATED, ProductEvents.PRODUCT_UPDATED],
28}

1services:
2  # ... other services
3
4  unsend:
5    image: 'unsend/unsend:latest'
6    port:
7      - '3000:3000'