Use when building HTML email templates with React components, adding a visual email editor to an application using the React Email visual editor, rendering emails to HTML, or sending emails with Resend. Covers welcome emails, password resets, notifications, order confirmations, newsletters, transact

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 Or scaffold a new project: This works with any package manager (npm, yarn, pnpm, bun) — substitute accordingly. The dev server runs at localhost:3000 with a preview interface for templates in the emails folder. Adding to an Existing Project Install the packages and add a script to your package.json : Make sure the path to the emails folder is relative to the base project directory. Ensure tsconfig.json includes proper support for JSX. Basic Email Template Create an email component with proper structure using the Tailwind component for styling: Behavioral Guidelines When iterating over the code, only update what the user asked for. Keep the rest intact. If the user asks to use media queries, inform them that most email clients don't support them and suggest a different approach. Never use template variables (like {{name}} ) directly in TypeScript code. Instead, reference the underlying properties directly. If the user explicitly asks for {{variableName}} , place the mustache string only in PreviewProps, never in the component JSX: Never write the {{variableName}} pattern directly in the component structure. If the user insists, explain that this would make the template invalid. Essential Components See [references/COMPONENTS.md](references/COMPONENTS.md) for complete component documentation. Core Structure: Html Root wrapper with lang attribute Head Meta elements, styles, fonts Body Main content wrapper Container Outermost centering wrapper (has built in max width: 37.5em ). Use only once per email. Section Interior content blocks (no built in max width). Use for grouping content inside Container . Row & Column Multi column layouts Tailwind Enables Tailwind CSS utility classes Content: Preview Inbox preview text, always first inside <Body Heading h1 h6 headings Text Paragraphs Button Styled link buttons (always include box border ) Link Hyperlinks Img Images (see Static Files section below) Hr Horizontal dividers Specialized: CodeBlock Syntax highlighted code CodeInline Inline code Markdown Render markdown Font Custom web fonts Before Writing Code When a user requests an email template, ask clarifying questions FIRST if they haven't provided: 1. Brand colors Ask for primary brand color (hex code like 007bff) 2. Logo Ask if they have a logo file and its format (PNG/JPG only warn if SVG/WEBP) 3. Style preference Professional, casual, or minimal tone 4. Production URL Where will static assets be hosted in production? Static Files and Images Directory Structure Local images must be placed in the static folder inside your emails directory: Dev vs Production URLs Use this pattern for images that work in both dev preview and production: How it works: 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 . Styling See [references/STYLING.md](references/STYLING.md) for comprehensive styling documentation including typography, layout patterns, dark mode, and brand consistency. Key Rules Use Tailwind with pixelBasedPreset (email clients don't support rem ). Import pixelBasedPreset from react email . Never use flexbox or grid — use Row / Column components or tables for layouts. Avoid CSS/Tailwind media queries ( sm: , md: , lg: , xl: ) — limited email client support. Never use theme selectors ( dark: , light: ) — not supported. Never use SVG or WEBP images — warn users about rendering issues. Always specify border type ( border solid , border dashed , etc.) — email clients don't inherit it. For single side borders, reset others first ( border none border l border solid ). Required Classes Component Required Class Why Button box border Prevents padding from overflowing the button width Hr / any border border solid (or border dashed , etc.) Email clients don't inherit border type Single side borders border none + the side Resets default borders on other sides Structure Notes Always define <Head / inside <Tailwind when using Tailwind CSS <Preview should always be the first element inside <Body Only include props in PreviewProps that the component actually uses Use fixed width/height for known size elements (logos, icons); responsive sizing ( w full , h auto ) for content images Rendering Convert to HTML Convert to Plain Text Sending React Email supports sending with any email service provider. See [references/SENDING.md](references/SENDING.md) for complete sending documentation including Resend, Nodemailer, and SendGrid examples. Quick example using the Resend SDK: The Resend Node SDK automatically handles both HTML and plain text rendering. CLI Commands The react email package provides a CLI accessible via the email command: Command Description email dev dir <path port <port Start the preview development server (default: ./emails , port 3000) email build dir <path Build the preview app for production deployment email start Run the built preview app email export outDir <path pretty plainText dir <path Export templates to static HTML files email resend setup Connect the CLI to your Resend account via API key email resend reset Remove the stored Resend API key Internationalization See [references/I18N.md](references/I18N.md) for complete i18n documentation. React Email supports three libraries: next intl, react i18next, and react intl. Email Editor React Email includes a visual editor ( @react email/editor ) that can be embedded in your app. It's built on TipTap/ProseMirror and produces email ready HTML. See [references/EDITOR.md](references/EDITOR.md) for complete documentation including: EmailEditor — batteries included component with bubble menus, slash commands, and theming StarterKit — 35+ email aware extensions (headings, lists, tables, columns, buttons, etc.) Inspector — contextual sidebar for editing styles EmailTheming — built in themes ( basic , minimal ) with customizable CSS properties composeReactEmail — export editor content to email ready HTML and plain text Custom extensions via EmailNode and EmailMark Quick example: Common Patterns See [references/PATTERNS.md](references/PATTERNS.md) for complete examples including: Password reset emails Order confirmations with product lists Notification emails with code blocks Multi column layouts Team invitation emails Email Best Practices 1. Test across email clients Gmail, Outlook, Apple Mail, Yahoo Mail 2. Keep it responsive Max width around 600px, test on mobile 3. Use absolute image URLs Host on reliable CDN 4. Write meaningful alt text Describe purpose and details for content images; use alt="" for decorative images (spacers, dividers, background flourishes). React Email's <Img defaults to alt="" . 5. Provide plain text version Required for accessibility 6. Keep file size under 102KB Gmail clips larger emails 7. Add proper TypeScript types Define interfaces for all email props 8. Include preview props Add .PreviewProps for development testing 9. Use verified domains For production from addresses Accessibility React Email handles the structural defaults; the rest is content. What React Email gives you for free: <Html sets lang and dir (defaults: lang="en" dir="ltr" — override per locale) <Img defaults to alt="" so decorative images are skipped by screen readers <Markdown renders layout tables with role="presentation" <Preview also emits a <title tag Upgrade with npm install react email@latest to get these defaults. What you still have to do (content choices): Open with a single <Heading as="h1" , nest subheadings in order, never skip levels (very short SMS style emails may skip the heading entirely) Set descriptive alt on meaningful images; pass an explicit alt="" on decorative images — never omit the attribute Linked images are never decorative. When an <Img is inside a <Link or <Button , the alt must describe where the link goes — alt="" on a linked image leaves the link with no accessible name Write link text that describes the destination ( <Button Read the report</Button , not click here ) Hit 4.5:1 text contrast (WCAG AA); preview in dark mode For layout tables you build by hand (outside <Markdown ), add role="presentation" For non English emails, pass the locale: <Html lang={locale} dir={isRTL ? 'rtl' : 'ltr'} (see [I18N.md](references/I18N.md)) For the full rule set, severity ranking, and authoring checklist, see the [accessibility reference](https://github.com/resend/email best practices/blob/main/references/accessibility.md) in the email best practices skill. Additional Resources [React Email Documentation](https://react.email/docs/llms.txt) [React Email GitHub](https://github.com/resend/react email) [Resend Documentation](https://resend.com/docs/llms.txt) [Email Client CSS Support](https://www.caniemail.com) Component Reference: [references/COMPONENTS.md](references/COMPONENTS.md) Styling Guide: [references/STYLING.md](references/STYLING.md) Email Editor: [references/EDITOR.md](references/EDITOR.md) Sending Guide: [references/SENDING.md](references/SENDING.md) Internationalization Guide: [references/I18N.md](references/I18N.md) Common Patterns: [references/PATTERNS.md](references/PATTERNS.md)

react-email