All skills
✉️

Email Templates

Features

Design emails that look good on every device and send them through Hercules Email. No third-party email service to set up.

Skill prompt

Email Templates for Hercules Apps

Build and send HTML emails using React Email components and the built-in Hercules Email service. React Email gives you a component-based way to design templates that render correctly across Gmail, Outlook, Apple Mail, and other major clients. Hercules Email handles delivery, sender verification, and quota management so you don't need a third-party provider like Resend or SendGrid.

Setup

Hercules apps already have everything you need to build email templates. You only need to install three packages:

  • @react-email/components — the component library used to build templates
  • @usehercules/sdk — used to send the rendered templates through Hercules Email
  • escape-html — used when interpolating user-provided values into HTML by hand
sh
npm install @react-email/components @usehercules/sdk escape-html

Place template components anywhere convenient in your project, for example convex/emails/welcome.tsx. There is no separate dev server to run — Hercules apps render and send templates directly from backend actions.

Verify a sender first

A sender must be verified before any email can be sent. There is no shared default sender.

  • Email address: Open the Email tab in the sidebar, choose Verify email, enter the address, and click the verification link sent to that inbox.
  • Whole domain: Open Email → Verify email, enter the domain, and add the CNAME records shown to the domain's DNS. Once verified, any address on that domain can be used in from.

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:

tsx
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:

  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?

Example response to vague request:

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

  1. What is your primary brand color? (hex code)
  2. Do you have a logo file? (PNG or JPG - note: SVG and WEBP don't work reliably in email clients)
  3. What tone do you prefer - professional, casual, or minimal?
  4. Where will you host static assets in production? (e.g., )

Static Files and Images

Directory Structure

Local images must be placed in the static folder inside your emails directory:

text
project/
├── emails/
│   ├── welcome.tsx
│   └── static/           <-- Images go here
│       └── logo.png

If user has an image elsewhere, instruct them to copy it:

sh
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:

tsx
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:
typescript
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.
  • Import pixelBasedPreset 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) Resets default borders on other sides
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
tsx
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
tsx
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
tsx
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

Render the template to HTML and pass it to hercules.email.send() from inside a backend action that uses the Node.js runtime ("use node").

tsx
// convex/emails.ts
"use node";

import { render } from "@react-email/components";
import { Hercules } from "@usehercules/sdk";
import { v } from "convex/values";
import { action } from "./_generated/server";
import { WelcomeEmail } from "./emails/welcome";

const hercules = new Hercules({
  apiKey: process.env.HERCULES_API_KEY!,
  apiVersion: "2025-12-09", // Mandatory date-based version
});

export const sendWelcomeEmail = action({
  args: { to: v.string(), name: v.string(), verificationUrl: v.string() },
  handler: async (_ctx, { to, name, verificationUrl }) => {
    const html = await render(<WelcomeEmail name={name} verificationUrl={verificationUrl} />);
    const text = await render(<WelcomeEmail name={name} verificationUrl={verificationUrl} />, {
      plainText: true,
    });

    const result = await hercules.email.send({
      from: "hello@yourapp.com", // Must be a verified email or domain
      to,
      subject: "Welcome to our app",
      html,
      text,
    });

    return { id: result.id };
  },
});

Important rules:

  • HERCULES_API_KEY is pre-configured for every Hercules app — do not ask the user to set it.
  • The apiVersion field is mandatory and uses date-based versioning.
  • Email sends must run in action or internalAction (Node runtime). They cannot run from query, mutation, or the frontend.
  • To send from a mutation, use ctx.scheduler.runAfter(0, internal.emails.sendSomething, { ... }) to dispatch an internal action.
  • The to, cc, and bcc fields each accept a single string or an array of strings.
  • Open the Email tab in the sidebar to see delivery status, bounces, and complaints for each message.

See references/SENDING.md for more end-to-end examples, including triggering an email from a mutation and sending to multiple recipients.

Internationalization

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

Quick Example (next-intl)
tsx
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.):

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

Email Best Practices

  1. 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.

  2. Keep it responsive - Max-width around 600px, test on mobile devices.

  3. Use absolute image URLs - Host on reliable CDN, always include `alt` text.

  4. Provide plain text version - Required for accessibility and some email clients.

  5. Keep file size under 102KB - Gmail clips larger emails.

  6. Add proper TypeScript types - Define interfaces for all email props.

  7. Include preview props - Add `.PreviewProps` to components for development testing.

  8. Handle errors - Always check for errors when sending emails.

  9. Use verified senders - Verify a sender email or domain in the Email tab before sending. Hercules Email rejects sends from unverified from addresses.

Common Patterns

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