Overview
Get started with emails in TurboStarter.
For the complete documentation index, see llms.txt. Prefer markdown by appending.mdto documentation URLs or sendingAccept: text/markdown.
For mailing functionality, TurboStarter integrates React Email which enables you to build your emails from composable React components.
Why React Email?
It's a simple, yet powerful library that allows you to write your emails in React.
It also allows you to use Tailwind CSS for styling, which is a huge advantage, as we can share almost everything from the main app with the emails package, keeping them consistent with rest of the app.
You can read more about react-email package in the official documentation.
Providers
TurboStarter implements multiple providers for managing and sending emails. To learn more about each provider and how to configure them, see the respective section:
All configuration and setup is built-in with a unified API, so you can switch between providers by simply changing the exports and even introduce your own provider without breaking any sending-related logic.
Development
When you setup your development environment and run pnpm dev command a new app will start at http://localhost:3005.
There you'll be able to check your email templates and send test emails from your app. It includes hot-reloading, so when you make change in the code - it will be reflected in the browser.
Local SMTP server
For local email development and testing, TurboStarter supports Mailpit, an all-in-one SMTP server and web UI for capturing and viewing emails sent from your app.
Mailpit lets you see, inspect, and debug outgoing emails directly in your browser, making it easy to ensure your templates and workflows are working as intended.
Learn more about configuration and setup of the emails in TurboStarter in the following sections.
How is this guide?
Last updated on