History

Shivam Kalra afe180a0ec feat: mailhog fixture (#10606 ) * feat: mailhog fixture * fix: nodemailer to dispatch emails with e2e env * fix: remove space from email subject * feat: fixture getFirstEventAsOwner * feat: assert email subjects		2023-08-11 18:56:27 +00:00
..
src	fix: Stop sending Reminders when a 'Seat' cancels the Event (#10405 )	2023-08-01 10:13:28 -04:00
templates	feat: mailhog fixture (#10606 )	2023-08-11 18:56:27 +00:00
docker-compose.yml	feat: catch emails sent locally using Mailhog (#8470 )	2023-05-06 19:08:04 -03:00
email-manager.ts	fix: Stop sending Reminders when a 'Seat' cancels the Event (#10405 )	2023-08-01 10:13:28 -04: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	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.