History

depfu[bot] d75a8910f6 Update all Yarn dependencies (2022-08-17) (#3887 ) * Update all Yarn dependencies (2022-08-17) * Fix package mismatches * Submodule sync * Type fixes Co-authored-by: depfu[bot] <23717796+depfu[bot]@users.noreply.github.com> Co-authored-by: Peer Richelsen <peeroke@gmail.com> Co-authored-by: zomars <zomars@me.com>		2022-08-29 17:55:27 -06:00
..
src	Update all Yarn dependencies (2022-08-17) (#3887 )	2022-08-29 17:55:27 -06:00
templates	REPLY_TO in hello@cal.com emails (#3959 )	2022-08-26 12:51:32 -06:00
email-manager.ts	Fixes bug that new line is not working in workflow reminder emails (#3452 )	2022-07-21 18:56:20 +00: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.