This is a detailed reference for email-related types in Hexclave. If you’re looking for a more high-level overview, please refer to our guide on the email system.
SendEmailOptions
Options for sending emails via the sendEmail method on HexclaveServerApp.
Table of Contents
Recipients
You must provide exactly one of userIds or allUsers.
Content
You must provide exactly one of html, templateId, or draftId.
Options
Usage
Choose a content method (html, templateId, or draftId) and a recipient method (userIds or allUsers):
Custom HTML
Template
Draft
Scheduled
Provide custom HTML directly:await hexclaveServerApp.sendEmail({
userIds: ["user-id-1"],
subject: "Hello!",
html: "<h1>Welcome</h1><p>Thanks for signing up!</p>",
});
Use a template with variable substitution:await hexclaveServerApp.sendEmail({
userIds: ["user-id-1"],
templateId: "welcome-template",
variables: {
userName: "John Doe",
activationUrl: "https://app.com/activate/token123",
},
});
Send from a saved email draft:await hexclaveServerApp.sendEmail({
allUsers: true,
draftId: "my-draft-id",
});
Schedule an email for later delivery:await hexclaveServerApp.sendEmail({
userIds: ["user-id-1"],
templateId: "weekly-digest",
scheduledAt: new Date("2025-01-15T09:00:00Z"),
});
The notificationCategoryName, themeId, scheduledAt, and variables properties work independently
with any content method.
