History

zomars 13f20dd7cf additionInformation => additionalInformation		2022-06-06 13:49:10 -06:00
..
src	additionInformation => additionalInformation	2022-06-06 13:49:10 -06:00
templates	Email cleanup	2022-06-06 13:39:54 -06:00
email-manager.ts	Refactor emails to use JSX as templating engine (#2915 )	2022-06-06 17:49:56 +00:00
index.ts	Refactor emails to use JSX as templating engine (#2915 )	2022-06-06 17:49:56 +00:00
package.json	Refactor emails to use JSX as templating engine (#2915 )	2022-06-06 17:49:56 +00:00
README.md	Refactor emails to use JSX as templating engine (#2915 )	2022-06-06 17:49:56 +00:00
tailwind.config.js	Refactor emails to use JSX as templating engine (#2915 )	2022-06-06 17:49:56 +00:00

README.md

JSX email templates

components Holds reusable patterns
templates A template equals a type of email sent

Usage

import { renderEmail } from "@calcom/emails";

renderEmail("TeamInviteEmail", */{
  language: t,
  from: "teampro@example.com",
  to: "pro@example.com",
  teamName: "Team Pro",
  joinLink: "https://cal.com",
});

The first argument is the template name as defined inside templates/index.ts. The second argument are the template props.

Development

You can use an API endpoint to preview the email HTML, there's already one on /apps/web/pages/api/email.ts feel free to change the template to the one you're currently working on.