Skip to content

README.md

Latest commit

 

History

History
168 lines (127 loc) · 5.07 KB

README.md

File metadata and controls

168 lines (127 loc) · 5.07 KB

Email templates

This directory contains all the email templates used in the application using react-email.

Run the following command to start the development server:

pnpm email:dev

This will start a react-email server at http://localhost:3002 where you can preview the email templates.

Base Template

All email templates use a shared base template (base.tsx) that provides consistent styling across all emails. The base template includes:

  • Consistent font family and sizing
  • Email body container
  • Background color

This ensures a unified look and feel across all email communications while allowing individual templates to focus on their specific content.

Usage

Trigger an email notification

To send a notification using an email template, specify the template key and required data when calling createNotifications:

await notificationModuleService.createNotifications({
  to: invite.email,
  channel: 'email',
  template: EmailTemplates.INVITE_USER, // Use the enum for the template key
  data: {
    emailOptions: {
      replyTo: 'info@example.com',
      subject: "You've been invited!",
    },
    inviteLink: `${BACKEND_URL}/app/invite?token=${invite.token}`,
    preview: 'Get started with your invitation...',
  },
})

Adding a new template

To add a new email template:

1. Create the template component

Add a new file in the templates directory, following the react-email component style and using the base template. For example, new-template.tsx:

import { Text } from '@react-email/components'
import * as React from 'react'
import { Base } from './base'

export const NEW_TEMPLATE_KEY = 'new-template'

export interface NewTemplateProps {
  greeting: string
  actionUrl: string
  preview?: string
}

export const isNewTemplateData = (data: any): data is NewTemplateProps =>
  typeof data.greeting === 'string' && typeof data.actionUrl === 'string'

export const NewTemplate = ({ greeting, actionUrl, preview = 'You have a new message' }: NewTemplateProps) => (
  <Base preview={preview}>
    <Text>{greeting}</Text>
    <Text>Click <a href={actionUrl}>here</a> to take action.</Text>
  </Base>
)

// Add preview props for the email dev server
NewTemplate.PreviewProps = {
  greeting: 'Hello there!',
  actionUrl: 'https://example.com/action',
  preview: 'Preview of the new template'
} as NewTemplateProps

2. Add the new template key to the EmailTemplates enum:

import { NEW_TEMPLATE_KEY } from './new-template'

export enum EmailTemplates {
  // ...
  NEW_TEMPLATE = NEW_TEMPLATE_KEY, // Add new key here
}

3. Add template handling to generateEmailTemplate

Update the generateEmailTemplate function to handle the new template:

import NewTemplate, { NEW_TEMPLATE_KEY, isNewTemplateData } from './new-template'

export enum EmailTemplates {
  // ...
  NEW_TEMPLATE = NEW_TEMPLATE_KEY,
}

export function generateEmailTemplate(templateKey: string, data: unknown): ReactNode {
  switch (templateKey) {
    // ...
    case EmailTemplates.NEW_TEMPLATE:
      if (!isNewTemplateData(data)) {
        throw new MedusaError(
          MedusaError.Types.INVALID_DATA,
          `Invalid data for template "${EmailTemplates.NEW_TEMPLATE}"`
        )
      }
      return (<NewTemplate {...data} />)
    default:
      throw new MedusaError(
        MedusaError.Types.INVALID_DATA,
        `Unknown template key: "${templateKey}"`,
      )
  }
}

4. Trigger the new template in a subscriber

Finally, call createNotifications with the new template key and data

await notificationModuleService.createNotifications({
  to: user.email,
  channel: 'email',
  template: EmailTemplates.NEW_TEMPLATE, // or 'new-template'
  data: {
    emailOptions: {
      subject: 'Action Required',
      replyTo: 'support@example.com',
    },
    greeting: 'Hello there!',
    actionUrl: `${BACKEND_URL}/take-action?token=${user.token}`,
    preview: 'An important action is awaiting you...',
  },
})

Additional Info & Documentation

I based this module off of @typed-dev/medusa-notification-resend but added the ability to use react-email templates and extended the functionality to include more Resend options.

In the original module, you're limited to just subject, from, to, the body, and the attachments. You also could only send HTML, which means you have to render the email body using @react-email/render instead of using the react email option which renders it for you.

Medusa

React Email

For more information on how to use react-email, refer to the official documentation

You can also use these example templates as a reference.

Resend
⚡