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)
string | string[]
required
Recipient email or array of recipients (max 10).
string
required
The sender’s email address. Can include a display name:
"Your App <no-reply@yourapp.com>"string
required
The email subject line.
string
HTML version of the email content. Use
html, text, and/or react (one or more required).string
Plain text version of the email content.
ReactNode
A React Email component; the SDK renders it to HTML and plain text. Requires
@react-email/render, react, and react-dom.object
Deprecated. Use top-level
html, text, and react instead. Still supported: body: { text?, html?, react? }.string
Email address for replies. If not specified, replies will go to the
from address.string | string[]
Carbon copy recipients. Can be a single email address or an array of addresses.
string | string[]
Blind carbon copy recipients. Can be a single email address or an array of addresses.
object[]
Custom email headers as an array of objects with
name and value properties.Response
string
Unique identifier for the sent email, used for tracking delivery status and analytics.
object
Request metadata including ID, timestamp, and API version.
