Skip to Content
Clerk logo

Clerk Docs

Ctrl + K
Go to clerkstage.dev

createEmail()

Sends an email message to an email address ID belonging to another user:

const fromEmailName = 'sales'; // i.e. the "sales" in sales@example.com const emailAddressId = 'recipient-email-address-id'; const subject = 'Free tacos'; const body = 'Join us via Zoom for remote Taco Tuesday!'; const email = await clerkClient.emails.createEmail({ fromEmailName, subject, body, emailAddressId });

Required parameters

NameTypeDescription
fromEmailNamestringThe name of the email address to send the email from.
emailAddressIdstringThe ID of the email address to send the email to.
subjectstringThe subject of the email.
bodystringThe body of the email.

What did you think of this content?

Clerk © 2024