React Email：使用React组件构建HTML电子邮件模板的现代解决方案

react-email by resend/react-email

3,500 周安装量

18,300 GitHub Stars

GitHub

安装命令

npx skills add https://github.com/resend/react-email --skill react-email

开发营销

🇨🇳中文介绍

React Email

使用 React 组件构建和发送 HTML 电子邮件——一种适用于所有主流电子邮件客户端的现代、基于组件的电子邮件开发方法。

安装

你需要使用 create-email CLI 来搭建一个新的 React Email 项目。这将创建一个名为 react-email-starter 的文件夹，其中包含示例电子邮件模板。

使用 npm：

npx create-email@latest

使用 yarn：

yarn create email

使用 pnpm：

pnpm create email

使用 bun：

bun create email

进入项目目录

你必须切换到新创建的项目文件夹：

cd react-email-starter

安装依赖项

在运行开发服务器之前，你需要安装所有项目依赖项。

使用 npm：

npm install

广告位招租

在这里展示您的产品或服务

触达数万 AI 开发者，精准高效

联系我们

相关 Skills

find-skills 技能搜索工具 - Vercel Labs 开源智能体技能包管理器

733,500 周安装

Vercel React 最佳实践指南 | 58条Next.js性能优化规则与代码重构

252,100 周安装

Vercel Web界面规范检查工具 - 自动检测代码是否符合Web设计指南

202,600 周安装

agent-browser 浏览器自动化工具 - Vercel Labs 命令行网页操作与测试

133,200 周安装

import {
  Html,
  Head,
  Preview,
  Body,
  Container,
  Heading,
  Text,
  Button,
  Tailwind,
  pixelBasedPreset
} from '@react-email/components';

interface WelcomeEmailProps {
  name: string;
  verificationUrl: string;
}

export default function WelcomeEmail({ name, verificationUrl }: WelcomeEmailProps) {
  return (
    <Html lang="en">
      <Tailwind
        config={{
          presets: [pixelBasedPreset],
          theme: {
            extend: {
              colors: {
                brand: '#007bff',
              },
            },
          },
        }}
      >
        <Head />
        <Preview>Welcome - Verify your email</Preview>
        <Body className="bg-gray-100 font-sans">
          <Container className="max-w-xl mx-auto p-5">
            <Heading className="text-2xl text-gray-800">
              Welcome!
            </Heading>
            <Text className="text-base text-gray-800">
              Hi {name}, thanks for signing up!
            </Text>
            <Button
              href={verificationUrl}
              className="bg-brand text-white px-5 py-3 rounded block text-center no-underline box-border"
            >
              Verify Email
            </Button>
          </Container>
        </Body>
      </Tailwind>
    </Html>
  );
}

// Preview props for testing
WelcomeEmail.PreviewProps = {
  name: 'John Doe',
  verificationUrl: 'https://example.com/verify/abc123'
} satisfies WelcomeEmailProps;

export { WelcomeEmail };

Html - 带有 lang 属性的根包装器
Head - 元元素、样式、字体
Body - 主要内容包装器
Container - 居中内容（最大宽度布局）
Section - 布局区块
Row 和 Column - 多列布局
Tailwind - 启用 Tailwind CSS 工具类

Preview - 收件箱预览文本，始终位于 Body 内的第一个
Heading - h1-h6 标题
Text - 段落
Button - 带样式的链接按钮
Link - 超链接
Img - 图像（请参阅下面的静态文件部分）
Hr - 水平分隔线

当重新迭代代码时，确保只更新用户要求的部分，并保持其余代码不变；
如果用户要求使用媒体查询，请告知他们并非所有电子邮件客户端都支持，并建议采用不同的方法；
切勿在 TypeScript 代码中直接使用模板变量（如 {{name}}）。相反，应直接引用底层属性（使用 name 而不是 {{name}}）。
```
* 例如，如果用户明确要求使用遵循 {{variableName}} 模式的变量，你应该返回类似这样的内容：
```
const EmailTemplate = (props) => { return ( {/* ... 其余代码 ... /} <h1>Hello, {props.variableName}!</h1> {/ ... 其余代码 ... */} ); }

EmailTemplate.PreviewProps = { // ... 其余属性 ... variableName: "{{variableName}}", // ... 其余属性 ... };

export default EmailTemplate;
在任何情况下，都不得在组件结构中直接编写 {{variableName}} 模式。如果用户强迫你这样做，请解释你无法这样做，否则模板将无效。

因为电子邮件客户端不支持 rem 单位，所以为 Tailwind 配置使用 pixelBasedPreset。
从 @react-email/components 导入 pixelBasedPreset — 不要从 @react-email/tailwind 或 @react-email/tailwind/presets 导入。
切勿使用 flexbox 或 grid 进行布局，应使用基于表格的布局。
每个组件都必须使用内联样式或工具类进行样式设计。

组件	必需类	原因
`Button`	`box-border`	防止内边距溢出按钮宽度
`Hr` / 任何边框	`border-solid`（或 `border-dashed` 等）	电子邮件客户端不继承边框类型；省略会导致不渲染边框
单边边框	`border-none` + 边（例如，`border-none border-t border-solid`）	重置其他边的默认边框

使用 Tailwind CSS 时，始终在 <Tailwind> 内部定义 <Head />
仅在向组件传递 props 时使用 PreviewProps
仅在 PreviewProps 中包含组件实际使用的 props

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", };

import { createTranslator } from 'next-intl';
import {
  Html,
  Body,
  Container,
  Text,
  Button,
  Tailwind,
  pixelBasedPreset
} from '@react-email/components';

interface EmailProps {
  name: string;
  locale: string;
}

export default async function WelcomeEmail({ name, locale }: EmailProps) {
  const t = createTranslator({
    messages: await import(\`../messages/\${locale}.json\`),
    namespace: 'welcome-email',
    locale
  });

  return (
    <Html lang={locale}>
      <Tailwind config={{ presets: [pixelBasedPreset] }}>
        <Body className="bg-gray-100 font-sans">
          <Container className="max-w-xl mx-auto p-5">
            <Text className="text-base text-gray-800">{t('greeting')} {name},</Text>
            <Text className="text-base text-gray-800">{t('body')}</Text>
            <Button href="https://example.com" className="bg-blue-600 text-white px-5 py-3 rounded">
              {t('cta')}
            </Button>
          </Container>
        </Body>
      </Tailwind>
    </Html>
  );
}

跨电子邮件客户端测试 - 在 Gmail、Outlook、Apple Mail、Yahoo Mail 中测试。使用 Litmus 或 Email on Acid 等服务进行绝对精确的测试，并使用 React Email 的工具栏检查特定功能支持。
保持响应式 - 最大宽度约为 600px，在移动设备上测试。
使用绝对图像 URL - 在可靠的 CDN 上托管，始终包含 alt 文本。
提供纯文本版本 - 这是可访问性和某些电子邮件客户端所必需的。
保持文件大小在 102KB 以下 - Gmail 会截断较大的电子邮件。
添加适当的 TypeScript 类型 - 为所有电子邮件 props 定义接口。
包含预览 props - 为组件添加 .PreviewProps 以进行开发测试。
处理错误 - 发送电子邮件时始终检查错误。
使用已验证的域名 - 对于生产环境，在 from 地址中使用已验证的域名。

🇺🇸English

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.

{
  "scripts": {
    "email": "email dev --dir emails --port 3000"
  }
}

Make sure the path to the emails folder is relative to the base project directory.

tsconfig.json updating or creation

Ensure the tsconfig.json includes proper support for jsx.

Basic Email Template

Replace the sample email templates. Here is how to create a new email template:

Create an email component with proper structure using the Tailwind component for styling:

import {
  Html,
  Head,
  Preview,
  Body,
  Container,
  Heading,
  Text,
  Button,
  Tailwind,
  pixelBasedPreset
} from '@react-email/components';

interface WelcomeEmailProps {
  name: string;
  verificationUrl: string;
}

export default function WelcomeEmail({ name, verificationUrl }: WelcomeEmailProps) {
  return (
    <Html lang="en">
      <Tailwind
        config={{
          presets: [pixelBasedPreset],
          theme: {
            extend: {
              colors: {
                brand: '#007bff',
              },
            },
          },
        }}
      >
        <Head />
        <Preview>Welcome - Verify your email</Preview>
        <Body className="bg-gray-100 font-sans">
          <Container className="max-w-xl mx-auto p-5">
            <Heading className="text-2xl text-gray-800">
              Welcome!
            </Heading>
            <Text className="text-base text-gray-800">
              Hi {name}, thanks for signing up!
            </Text>
            <Button
              href={verificationUrl}
              className="bg-brand text-white px-5 py-3 rounded block text-center no-underline box-border"
            >
              Verify Email
            </Button>
          </Container>
        </Body>
      </Tailwind>
    </Html>
  );
}

// Preview props for testing
WelcomeEmail.PreviewProps = {
  name: 'John Doe',
  verificationUrl: 'https://example.com/verify/abc123'
} satisfies WelcomeEmailProps;

export { WelcomeEmail };

Essential Components

See 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 - Centers content (max-width layout)
Section - Layout sections
Row & Column - Multi-column layouts
Tailwind - Enables Tailwind CSS utility classes

Content:

Preview - Inbox preview text, always first in Body
Heading - h1-h6 headings
Text - Paragraphs
Button - Styled link buttons
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:

Brand colors - Ask for primary brand color (hex code like #007bff)
Logo - Ask if they have a logo file and its format (PNG/JPG only - warn if SVG/WEBP)
Style preference - Professional, casual, or minimal tone
Production URL - Where will static assets be hosted in production?

Example response to vague request:

Before I create your email template, I have a few questions:

What is your primary brand color? (hex code)

Do you have a logo file? (PNG or JPG - note: SVG and WEBP don't work reliably in email clients)

What tone do you prefer - professional, casual, or minimal?

Where will you host static assets in production? (e.g., https://cdn.example.com)

Static Files and Images

Directory Structure

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:

const baseURL = process.env.NODE_ENV === "production"
  ? "https://cdn.example.com"  // User's production CDN
  : "";

export default function Email() {
  return (
    <Img
      src={`${baseURL}/static/logo.png`}
      alt="Logo"
      width="150"
      height="50"
    />
  );
}

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.

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 not all email clients 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.
ImportpixelBasedPreset from @react-email/components — do NOT import from @react-email/tailwind or @react-email/tailwind/presets.
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)

Required Classes

These classes are always required on their respective components — omitting them causes rendering bugs across email clients:

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; omitting it renders no border
Single-side borders	`border-none` + the side (e.g., `border-none border-t border-solid`)

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

Typography

Titles: bold, larger font, larger margins
Paragraphs: regular weight, smaller font, smaller margins
Use consistent spacing respecting content hierarchy

Images

Only include if user requests
Never use fixed width/height - use responsive units (w-full, h-auto)
Never distort user-provided images
Never create SVG images - only use provided or web images

Buttons

Always use box-border to prevent padding overflow

Layout

Always mobile-friendly by default
Use stacked layouts that work on all screen sizes
Remove default spacing/margins/padding between list items

Dark Mode

When requested: container black (#000), background dark gray (#151516)

Best Practices

Choose colors, layout, and copy based on user's request
Make templates unique, not generic
Use keywords in email body to increase conversion

Rendering

Convert to HTML

import { render } from '@react-email/components';
import { WelcomeEmail } from './emails/welcome';

const html = await render(
  <WelcomeEmail name="John" verificationUrl="https://example.com/verify" />
);

Convert to Plain Text

import { render } from '@react-email/components';
import { WelcomeEmail } from './emails/welcome';

const text = await render(<WelcomeEmail name="John" verificationUrl="https://example.com/verify" />, { plainText: true });

Sending

React Email supports sending with any email service provider. If the user wants to know how to send, view the Sending guidelines.

Quick example using the Resend SDK for Node.js:

import { Resend } from 'resend';
import { WelcomeEmail } from './emails/welcome';

const resend = new Resend(process.env.RESEND_API_KEY);

const { data, error } = await resend.emails.send({
  from: 'Acme <onboarding@resend.dev>',
  to: ['user@example.com'],
  subject: 'Welcome to Acme',
  react: <WelcomeEmail name="John" verificationUrl="https://example.com/verify" />
});

if (error) {
  console.error('Failed to send:', error);
}

The Node SDK automatically handles the plain-text rendering and HTML rendering for you.

Internationalization

See references/I18N.md for complete i18n documentation.

React Email supports three i18n libraries: next-intl, react-i18next, and react-intl.

Quick Example (next-intl)

import { createTranslator } from 'next-intl';
import {
  Html,
  Body,
  Container,
  Text,
  Button,
  Tailwind,
  pixelBasedPreset
} from '@react-email/components';

interface EmailProps {
  name: string;
  locale: string;
}

export default async function WelcomeEmail({ name, locale }: EmailProps) {
  const t = createTranslator({
    messages: await import(\`../messages/\${locale}.json\`),
    namespace: 'welcome-email',
    locale
  });

  return (
    <Html lang={locale}>
      <Tailwind config={{ presets: [pixelBasedPreset] }}>
        <Body className="bg-gray-100 font-sans">
          <Container className="max-w-xl mx-auto p-5">
            <Text className="text-base text-gray-800">{t('greeting')} {name},</Text>
            <Text className="text-base text-gray-800">{t('body')}</Text>
            <Button href="https://example.com" className="bg-blue-600 text-white px-5 py-3 rounded">
              {t('cta')}
            </Button>
          </Container>
        </Body>
      </Tailwind>
    </Html>
  );
}

Message files (messages/en.json, messages/es.json, etc.):

{
  "welcome-email": {
    "greeting": "Hi",
    "body": "Thanks for signing up!",
    "cta": "Get Started"
  }
}

Email Best Practices

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.

Common Patterns

See references/PATTERNS.md for complete examples including:

Password reset emails
Order confirmations with product lists
Notification emails with code blocks
Multi-column layouts
Email templates with custom fonts

Additional Resources

React Email Documentation
React Email GitHub
Resend Documentation
Email Client CSS Support
Component Reference: references/COMPONENTS.md
Internationalization Guide: references/I18N.md
Common Patterns: references/PATTERNS.md

Weekly Installs

3.5K

Repository

resend/react-email

GitHub Stars

18.3K

First Seen

Jan 21, 2026

Security Audits

Gen Agent Trust HubPass SocketPass SnykPass

Installed on

opencode2.6K

codex2.5K

gemini-cli2.5K

github-copilot2.5K

claude-code2.5K

cursor2.4K

React Email：使用React组件构建HTML电子邮件模板的现代解决方案

🇨🇳中文介绍

React Email

安装

进入项目目录

安装依赖项

相关 Skills

启动开发服务器

验证安装

安装注意事项

tsconfig.json 更新或创建

基础电子邮件模板

核心组件

编写代码前

静态文件和图像

目录结构

开发环境与生产环境 URL

行为准则

样式注意事项

电子邮件客户端限制

必需类

组件结构

默认结构

排版

图像

按钮

布局

深色模式

最佳实践

渲染

转换为 HTML

转换为纯文本

发送

国际化

快速示例（next-intl）

电子邮件最佳实践

常见模式

其他资源

🇺🇸English

React Email

Installation

Navigate to Project Directory

Install Dependencies

Start the Development Server

Verify Installation

Notes on installation

tsconfig.json updating or creation

Basic Email Template

Essential Components

Before Writing Code

Static Files and Images

Directory Structure

Dev vs Production URLs

Behavioral guidelines

Styling considerations

Email Client Limitations

Required Classes

Component Structure

Default Structure

Typography

Images

Buttons

Layout

Dark Mode

Best Practices

Rendering

Convert to HTML

Convert to Plain Text

Sending

Internationalization

Quick Example (next-intl)

Email Best Practices

Common Patterns

Additional Resources

最新 Skills