History

Omar López 7c749299bb Enforces explicit type imports (#7158 ) * Enforces explicit type imports * Upgrades typescript-eslint * Upgrades eslint related dependencies * Update config * Sync packages mismatches * Syncs prettier version * Linting * Relocks node version * Fixes * Locks @vitejs/plugin-react to 1.3.2 * Linting		2023-02-16 15:39:57 -07:00
..
src	Enforces explicit type imports (#7158 )	2023-02-16 15:39:57 -07:00
templates	fix: booking confirmation email missing variables (#7109 )	2023-02-15 10:49:44 -07:00
email-manager.ts	Admin apps UI (#5494 )	2022-12-07 14:47:02 -07:00
index.ts	Refactor emails to use JSX as templating engine (#2915 )	2022-06-06 17:49:56 +00:00
package.json	Update all Yarn dependencies (2022-08-17) (#3887 )	2022-08-29 17:55:27 -06: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
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";

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.