Skip to main content

Documentation Index

Fetch the complete documentation index at: https://react.email/docs/llms.txt

Use this file to discover all available pages before exploring further.

​
1. Install dependencies

Get the react-email and nodemailer packages. 
npm install nodemailer react-email

​
2. Create an email using React

Start by building your email template in a .jsx or .tsx file.
email.tsx
import * as React from 'react';
import { Html, Button } from "react-email";

export function Email(props) {
  const { url } = props;

  return (
    <Html lang="en">
      <Button href={url}>Click me</Button>
    </Html>
  );
}

​
3. Convert to HTML and send email

Import the email template you just built, convert into a HTML string, and use the Nodemailer SDK to send it. 
import { render } from 'react-email';
import nodemailer from 'nodemailer';
import { Email } from './email';

const transporter = nodemailer.createTransport({
  host: 'smtp.forwardemail.net',
  port: 465,
  secure: true,
  auth: {
    user: 'my_user',
    pass: 'my_password',
  },
});

const emailHtml = await render(<Email url="https://example.com" />);

const options = {
  from: 'you@example.com',
  to: 'user@gmail.com',
  subject: 'hello world',
  html: emailHtml,
};

await transporter.sendMail(options);

​
Try it yourself

Nodemailer example

See the full source code.