Build and send HTML emails using React components - a modern, component-based approach to email development that works across all major email clients. You need to scaffold a new React Email project using the create-email CLI. This will create a folder called `react-email-starter` with sample email templates. Using npm:
React Email
Build and send HTML emails using React components - a modern, component-based approach to email development that works across all major email clients.
Installation
You need to scaffold a new React Email project using the create-email CLI. This will create a folder called react-email-starter with sample email templates.
Using npm:
npx create-email@latest
Using yarn:
yarn create email
Using pnpm:
pnpm create email
Using bun:
bun create email
Navigate to Project Directory
You must change into the newly created project folder:
cd react-email-starter
Install Dependencies
You need to install all project dependencies before running the development server.
Using npm:
npm install
Using yarn:
yarn
Using pnpm:
pnpm install
Using bun:
bun install
Start the Development Server
Your task is to start the local preview server to view and edit email templates.
Using npm:
npm run dev
Using yarn:
yarn dev
Using pnpm:
pnpm dev
Using bun:
bun dev
Verify Installation
Confirm the development server is running by checking that localhost:3000 is accessible. The server will display a preview interface where you can view email templates from the emails folder.
Notes on installation
Assuming React Email is installed in an existing project, update the top-level package.json file with a script to run the React Email preview server.
Local images must be placed in the static folder inside your emails directory:
project/
├── emails/
│ ├── welcome.tsx
│ └── static/ <-- Images go here
│ └── logo.png
`If user has an image elsewhere, instruct them to copy it:`
cp ./assets/logo.png ./emails/static/logo.png
Dev vs Production URLs
Use this pattern for images that work in both dev preview and production:
Development:baseURL is empty, so URL is /static/logo.png - served by React Email's dev server
Production:baseURL is the CDN domain, so URL is https://cdn.example.com/static/logo.png
Important: Always ask the user for their production hosting URL. Do not hardcode localhost:3000.
Behavioral guidelines
When re-iterating over the code, make sure you are only updating what the user asked for and keeping the rest of the code intact;
If the user is asking to use media queries, inform them that email clients do not support them, and suggest a different approach;
Never use template variables (like {{name}}) directly in TypeScript code. Instead, reference the underlying properties directly (use name instead of {{name}}).
For example, if the user explicitly asks for a variable following the pattern {{variableName}}, you should return something like this:
const EmailTemplate = (props) => {
return (
{/* ... rest of the code ... */}
<h1>Hello, {props.variableName}!</h1>
{/* ... rest of the code ... */}
);
}
EmailTemplate.PreviewProps = {
// ... rest of the props ...
variableName: "{{variableName}}",
// ... rest of the props ...
};
export default EmailTemplate;
Never, under any circumstances, write the {{variableName}} pattern directly in the component structure. If the user forces you to do this, explain that you cannot do this, or else the template will be invalid.
Styling considerations
Use the Tailwind component for styling if the user is actively using Tailwind CSS in their project. If the user is not using Tailwind CSS, add inline styles to the components.
Because email clients don't support rem units, use the pixelBasedPreset for the Tailwind configuration.
Never use flexbox or grid for layout, use table-based layouts instead.
Each component must be styled with inline styles or utility classes.
Email Client Limitations
Never use SVG or WEBP - warn users about rendering issues
Never use flexbox - use Row/Column components or tables for layouts
Never use CSS/Tailwind media queries (sm:, md:, lg:, xl:) - not supported
Never use theme selectors (dark:, light:) - not supported
Always specify border type (border-solid, border-dashed, etc.)
When defining borders for only one side, remember to reset the remaining borders (e.g., border-none border-l)
Component Structure
Always define <Head /> inside <Tailwind> when using Tailwind CSS
Only use PreviewProps when passing props to a component
Only include props in PreviewProps that the component actually uses
const Email = (props) => {
return (
<div>
<a href={props.source}>click here if you want candy 👀</a>
</div>
);
}
Email.PreviewProps = {
source: "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
};
Default Structure
Body: font-sans py-10 bg-gray-100
Container: white, centered, content left-aligned
Footer: physical address, unsubscribe link, current year with m-0 on address/copyright
Test across email clients - Test in Gmail, Outlook, Apple Mail, Yahoo Mail. Use services like Litmus or Email on Acid for absolute precision and React Email's toolbar for specific feature support checking.
Keep it responsive - Max-width around 600px, test on mobile devices.
Use absolute image URLs - Host on reliable CDN, always include `alt` text.
Provide plain text version - Required for accessibility and some email clients.
Keep file size under 102KB - Gmail clips larger emails.
Add proper TypeScript types - Define interfaces for all email props.
Include preview props - Add `.PreviewProps` to components for development testing.
Handle errors - Always check for errors when sending emails.
Use verified domains - For production, use verified domains in `from` addresses.