History

DmytroHryshyn db625157d1 chore: [app-router-migration-2] migrate trpc, ssgInit, ssrInit (#12593 ) * chore: migrate trpc, ssgInit, ssrInit * manual: fix emails * manual: fix ts issues * Update packages/emails/README.md * remove unneeded use client statements * fix flaky locale tests, fix flaky login test --------- Co-authored-by: Omar López <zomars@me.com>		2023-12-07 13:43:41 -07:00
..
src	chore: [app-router-migration-1] migrate the pages in `settings/admin` to the app directory (#12561 )	2023-12-01 13:07:26 -07:00
templates	chore: [app-router-migration-1] migrate the pages in `settings/admin` to the app directory (#12561 )	2023-12-01 13:07:26 -07:00
docker-compose.yml	chore: prettier	2023-08-15 11:59:16 -07:00
email-manager.ts	fix: rescheduling round robin events (emails and calendar events) (#12469 )	2023-11-27 13:09:33 -05:00
index.ts	Refactor emails to use JSX as templating engine (#2915 )	2022-06-06 17:49:56 +00:00
package.json	chore: Sync packages mismatches (#9725 )	2023-06-22 15:25:37 -07:00
README.md	chore: [app-router-migration-2] migrate trpc, ssgInit, ssrInit (#12593 )	2023-12-07 13:43:41 -07:00
tailwind.config.js	Refactor emails to use JSX as templating engine (#2915 )	2022-06-06 17:49:56 +00:00
tsconfig.json	Update all Yarn dependencies (2022-08-17) (#3887 )	2022-08-29 17:55:27 -06: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";

await 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.