Add support for template-based emails in sendEmail function #48

sethconve · 2025-11-26T00:23:03Z

Introduced sendWithTemplate action to handle sending emails with templates.
Updated sendEmail function to accept both traditional and template-based email formats.
Enhanced validation to ensure either content or template is provided, but not both.
Added tests for template email functionality, including acceptance and rejection scenarios.
Updated schema and shared types to include template-related fields.

Fixes issue #44

pkg-pr-new · 2025-11-26T00:23:43Z

npm i https://pkg.pr.new/get-convex/resend/@convex-dev/resend@48

commit: f6e46f0

coderabbitai · 2025-11-26T18:53:32Z

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch seth/templates

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

Provide your own instructions using the high_level_summary_instructions setting.
Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

📝 Description — Summarize the main change in 50–60 words, explaining what was done.

📓 References — List relevant issues, discussions, documentation, or related PRs.

📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.

📊 Contributor Summary — Include a Markdown table showing contributions:
| Contributor | Lines Added | Lines Removed | Files Changed |

✔️ Additional Notes — Add any extra reviewer context.
Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

ianmacartney · 2025-11-27T01:38:21Z

src/component/schema.ts

+    templateId: v.optional(v.string()),
+    templateVariables: v.optional(v.string()),


Suggested change

templateId: v.optional(v.string()),

templateVariables: v.optional(v.string()),

template: v.optional(vTemplate),

ianmacartney

other than the vTemplate change, lgtm

ianmacartney · 2025-11-27T01:41:26Z

src/component/lib.ts

+    if (email.templateId) {
+      payload.template = {
+        id: email.templateId,
+        variables: email.templateVariables
+          ? JSON.parse(email.templateVariables)
+          : {},
+      };


Suggested change

if (email.templateId) {

payload.template = {

id: email.templateId,

variables: email.templateVariables

? JSON.parse(email.templateVariables)

: {},

};

if (email.template) {

payload.template = email.template;

ianmacartney · 2025-11-27T01:42:40Z

src/component/lib.ts

+      if (email.subject) {
+        payload.subject = email.subject;
+      }


btw one way to set fields only if they exist is to use the pick helper from convex-helpers like payload = { ...pick(email, ["from", "bcc", "cc", "subject", "template"]

ianmacartney · 2025-11-27T01:43:33Z

src/component/lib.ts

-      throw new Error("Either html or text must be provided");
+    // We require either html/text or a template to be provided.
+    const hasContent = args.html !== undefined || args.text !== undefined;
+    const hasTemplate = args.templateId !== undefined;


Suggested change

const hasTemplate = args.templateId !== undefined;

const hasTemplate = args.template?.id !== undefined;

ianmacartney · 2025-11-27T01:43:48Z

src/component/lib.ts

+    templateId: v.optional(v.string()),
+    templateVariables: v.optional(v.string()),


Suggested change

templateId: v.optional(v.string()),

templateVariables: v.optional(v.string()),

template: v.optional(vTemplate),

ianmacartney · 2025-11-27T01:44:31Z

src/client/index.ts

+    templateId?: string;
+    templateVariables?: string;


Suggested change

templateId?: string;

templateVariables?: string;

template?: Template;

ianmacartney · 2025-11-27T01:46:30Z

src/client/index.ts

+    if ("template" in sendEmailArgs) {
+      // Template-based email
+      const id = await ctx.runMutation(this.component.lib.sendEmail, {
+        options: await configToRuntimeConfig(this.config, this.onEmailEvent),
+        from: sendEmailArgs.from,
+        to:
+          typeof sendEmailArgs.to === "string"
+            ? [sendEmailArgs.to]
+            : sendEmailArgs.to,
+        cc: toArray(sendEmailArgs.cc),
+        bcc: toArray(sendEmailArgs.bcc),
+        subject: sendEmailArgs.subject,
+        replyTo: sendEmailArgs.replyTo,
+        headers: sendEmailArgs.headers,
+        templateId: sendEmailArgs.template.id,
+        templateVariables: JSON.stringify(sendEmailArgs.template.variables),
+      });
+      return id as EmailId;
+    } else {
+      // Traditional email
+      const id = await ctx.runMutation(this.component.lib.sendEmail, {
+        options: await configToRuntimeConfig(this.config, this.onEmailEvent),
+        from: sendEmailArgs.from,
+        to:
+          typeof sendEmailArgs.to === "string"
+            ? [sendEmailArgs.to]
+            : sendEmailArgs.to,
+        cc: toArray(sendEmailArgs.cc),
+        bcc: toArray(sendEmailArgs.bcc),
+        replyTo: sendEmailArgs.replyTo,
+        headers: sendEmailArgs.headers,
+        subject: sendEmailArgs.subject,
+        html: sendEmailArgs.html,
+        text: sendEmailArgs.text,
+      });
+      return id as EmailId;
+    }


I'm biased towards keeping both and adding template, since we'll be validating having the right fields anyways, and if they're specifying html and template it's probably better to fail than silently omit the html here, wdyt?

ianmacartney · 2025-11-27T01:54:53Z

src/client/index.ts

+    if ("template" in sendEmailArgs) {
+      // Template-based email
+      const id = await ctx.runMutation(this.component.lib.sendEmail, {
+        options: await configToRuntimeConfig(this.config, this.onEmailEvent),
+        from: sendEmailArgs.from,
+        to:
+          typeof sendEmailArgs.to === "string"
+            ? [sendEmailArgs.to]
+            : sendEmailArgs.to,
+        cc: toArray(sendEmailArgs.cc),
+        bcc: toArray(sendEmailArgs.bcc),
+        subject: sendEmailArgs.subject,
+        replyTo: sendEmailArgs.replyTo,
+        headers: sendEmailArgs.headers,
+        templateId: sendEmailArgs.template.id,
+        templateVariables: JSON.stringify(sendEmailArgs.template.variables),
+      });
+      return id as EmailId;
+    } else {
+      // Traditional email
+      const id = await ctx.runMutation(this.component.lib.sendEmail, {
+        options: await configToRuntimeConfig(this.config, this.onEmailEvent),
+        from: sendEmailArgs.from,
+        to:
+          typeof sendEmailArgs.to === "string"
+            ? [sendEmailArgs.to]
+            : sendEmailArgs.to,
+        cc: toArray(sendEmailArgs.cc),
+        bcc: toArray(sendEmailArgs.bcc),
+        replyTo: sendEmailArgs.replyTo,
+        headers: sendEmailArgs.headers,
+        subject: sendEmailArgs.subject,
+        html: sendEmailArgs.html,
+        text: sendEmailArgs.text,
+      });
+      return id as EmailId;
+    }


Suggested change

if ("template" in sendEmailArgs) {

// Template-based email

const id = await ctx.runMutation(this.component.lib.sendEmail, {

options: await configToRuntimeConfig(this.config, this.onEmailEvent),

from: sendEmailArgs.from,

to:

typeof sendEmailArgs.to === "string"

? [sendEmailArgs.to]

: sendEmailArgs.to,

cc: toArray(sendEmailArgs.cc),

bcc: toArray(sendEmailArgs.bcc),

subject: sendEmailArgs.subject,

replyTo: sendEmailArgs.replyTo,

headers: sendEmailArgs.headers,

templateId: sendEmailArgs.template.id,

templateVariables: JSON.stringify(sendEmailArgs.template.variables),

});

return id as EmailId;

} else {

// Traditional email

const id = await ctx.runMutation(this.component.lib.sendEmail, {

options: await configToRuntimeConfig(this.config, this.onEmailEvent),

from: sendEmailArgs.from,

to:

typeof sendEmailArgs.to === "string"

? [sendEmailArgs.to]

: sendEmailArgs.to,

cc: toArray(sendEmailArgs.cc),

bcc: toArray(sendEmailArgs.bcc),

replyTo: sendEmailArgs.replyTo,

headers: sendEmailArgs.headers,

subject: sendEmailArgs.subject,

html: sendEmailArgs.html,

text: sendEmailArgs.text,

});

return id as EmailId;

}

options: await configToRuntimeConfig(this.config, this.onEmailEvent),

...sendEmailArgs,

to:

typeof sendEmailArgs.to === "string"

? [sendEmailArgs.to]

: sendEmailArgs.to,

cc: toArray(sendEmailArgs.cc),

bcc: toArray(sendEmailArgs.bcc),

});

return id as EmailId;

the only risk here is that passing extra args will fail -but in some ways that's a good thing

- Introduced `sendWithTemplate` action to handle sending emails with templates. - Updated `sendEmail` function to accept both traditional and template-based email formats. - Enhanced validation to ensure either content or template is provided, but not both. - Added tests for template email functionality, including acceptance and rejection scenarios. - Updated schema and shared types to include template-related fields.

…atevariables

sethconve force-pushed the seth/templates branch from f55f45c to a37df33 Compare November 26, 2025 22:02

ianmacartney reviewed Nov 27, 2025

View reviewed changes

ianmacartney approved these changes Nov 27, 2025

View reviewed changes

sethconve added 3 commits November 28, 2025 11:01

simplify get query as there is no transformation needed for the templ…

95b1efa

…atevariables

address template feedback

f6e46f0

sethconve force-pushed the seth/templates branch from a37df33 to f6e46f0 Compare November 28, 2025 19:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add support for template-based emails in sendEmail function #48

Add support for template-based emails in sendEmail function #48

Uh oh!

sethconve commented Nov 26, 2025

Uh oh!

pkg-pr-new bot commented Nov 26, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Nov 26, 2025 •

edited

Loading

Review skipped

Uh oh!

ianmacartney Nov 27, 2025

Uh oh!

ianmacartney left a comment

Uh oh!

ianmacartney Nov 27, 2025

Uh oh!

ianmacartney Nov 27, 2025

Uh oh!

ianmacartney Nov 27, 2025

Uh oh!

ianmacartney Nov 27, 2025

Uh oh!

ianmacartney Nov 27, 2025

Uh oh!

ianmacartney Nov 27, 2025

Uh oh!

ianmacartney Nov 27, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		templateId: v.optional(v.string()),
		templateVariables: v.optional(v.string()),

	templateId: v.optional(v.string()),
	templateVariables: v.optional(v.string()),
	template: v.optional(vTemplate),

	const hasTemplate = args.templateId !== undefined;
	const hasTemplate = args.template?.id !== undefined;

	templateId?: string;
	templateVariables?: string;
	template?: Template;

Add support for template-based emails in sendEmail function #48

Are you sure you want to change the base?

Add support for template-based emails in sendEmail function #48

Uh oh!

Conversation

sethconve commented Nov 26, 2025

Uh oh!

pkg-pr-new bot commented Nov 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Nov 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ianmacartney left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

pkg-pr-new bot commented Nov 26, 2025 •

edited

Loading

coderabbitai bot commented Nov 26, 2025 •

edited

Loading