html, text, or both at the top level:
Providing content via
body: { text, html, react } is deprecated but still supported. Prefer top-level html, text, and react.React Email
Pass a React Email component asreact; the SDK renders it to HTML and plain text before sending. Install @react-email/render and its peer deps when using this:
- Bun
- pnpm
- npm
- Yarn
Email.tsx):
react:
Parameters
email.send(params)
Recipient email or array of recipients (max 10).
The sender’s email address. Can include a display name:
"Your App <no-reply@yourapp.com>"The email subject line.
HTML version of the email content. Use
html, text, and/or react (one or more required).Plain text version of the email content.
A React Email component; the SDK renders it to HTML and plain text. Requires
@react-email/render, react, and react-dom.Deprecated. Use top-level
html, text, and react instead. Still supported: body: { text?, html?, react? }.Email address for replies. If not specified, replies will go to the
from address.Carbon copy recipients. Can be a single email address or an array of addresses.
Blind carbon copy recipients. Can be a single email address or an array of addresses.
Custom email headers as an array of objects with
name and value properties.Response
Unique identifier for the sent email, used for tracking delivery status and analytics.
Request metadata including ID, timestamp, and API version.
