cal.pub0.org/packages/emails
Carina Wollendorfer 453ae71dae
Merge branch 'main' into fix/sendgrid-bypass-cleanup
2023-10-19 16:55:39 +02:00
..
src fix: `videoCallUrl` not updating when rescheduling with a broken Calendar integration (#11923) 2023-10-17 16:46:24 +05:30
templates remove sendgrid specific header if other host is used 2023-10-16 15:36:59 +02:00
README.md Refactor emails to use JSX as templating engine (#2915) 2022-06-06 17:49:56 +00:00
docker-compose.yml chore: prettier 2023-08-15 11:59:16 -07:00
email-manager.ts fix: Function sendScheduledSeatsEmails ignore rule 'Disable default confirmation emails for attendees' (#11722) 2023-10-12 16:57:35 +02: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
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.