History

Piyush Garg 8bc8a045b6 feat: email undefined value (#9240 ) * Fix: #9210 * Fix: #9215 Added Password Validation to App Signup * FIX #9216 Fixed the Update Button Allignment * Fix #9238: Don't render descripiton in email template if undefined * Remove Prev Changes * Remove unwanted space * Revert yarn.lock --------- Co-authored-by: Peer Richelsen <peeroke@gmail.com>		2023-06-06 10:03:40 +00:00
..
src	feat: email undefined value (#9240 )	2023-06-06 10:03:40 +00:00
templates	fix: translate (#9108 )	2023-05-25 15:50:56 +00:00
docker-compose.yml	feat: catch emails sent locally using Mailhog (#8470 )	2023-05-06 19:08:04 -03:00
email-manager.ts	disable standard confirmation emails if workflow exists (#8747 )	2023-05-09 17:08:14 +00:00
index.ts	Refactor emails to use JSX as templating engine (#2915 )	2022-06-06 17:49:56 +00:00
package.json	Add the or operator to the emails package.json as well (#9013 )	2023-05-29 20:11:45 +01: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.