Lettermint

Copy codenpm install convex-lettermint

Copy codeimport { defineApp } from "convex/server";
import lettermint from "convex-lettermint/convex.config.js";

const app = defineApp();
app.use(lettermint);

export default app;

Copy codeimport { components } from "./_generated/api";
import { Lettermint } from "convex-lettermint";
import { internalMutation } from "./_generated/server";

export const lettermint = new Lettermint(components.lettermint, {});

export const sendTestEmail = internalMutation({
  handler: async (ctx) => {
    await lettermint.sendEmail(ctx, {
      from: "Me <test@mydomain.com>",
      to: "ok@testing.lettermint.co",
      subject: "Hi there",
      html: "This is a test email",
    });
  },
});

Copy codeimport { httpRouter } from "convex/server";
import { httpAction } from "./_generated/server";
import { lettermint } from "./sendEmails";

const http = httpRouter();

http.route({
  path: "/lettermint-webhook",
  method: "POST",
  handler: httpAction(async (ctx, req) => {
    return await lettermint.handleLettermintEventWebhook(ctx, req);
  }),
});

export default http;

Copy codeimport { components, internal } from "./_generated/api";
import { internalMutation } from "./_generated/server";
import { Lettermint, vOnEmailEventArgs } from "convex-lettermint";

export const lettermint = new Lettermint(components.lettermint, {
  onEmailEvent: internal.example.handleEmailEvent,
});

export const handleEmailEvent = internalMutation({
  args: vOnEmailEventArgs,
  handler: async (ctx, args) => {
    // args provides { id: EmailId; event: EmailEvent; }
    if (args.event.event === "message.delivered") {
      // Handle delivery.
    }
  },
});

Copy codeawait lettermint.sendEmail(ctx, {
  from: "Notifications <notifications@mydomain.com>",
  to: "ok@testing.lettermint.co",
  subject: "Welcome!",
  html: "<p>Welcome to our app.</p>",
  route: "transactional",
  tag: "welcome-email",
  metadata: {
    user_id: "user_123",
  },
  settings: {
    trackOpens: false,
    trackClicks: true,
  },
});

Copy codeconst emailId = await lettermint.sendEmail(ctx, {
  from: "Me <test@mydomain.com>",
  to: "ok@testing.lettermint.co",
  subject: "Hi",
  text: "Hello",
});

const emailStatus = await lettermint.status(ctx, emailId);
if (emailStatus) {
  console.log(emailStatus.status);
  console.log(emailStatus.bounced);
  console.log(emailStatus.failed);
  console.log(emailStatus.complained);
  console.log(emailStatus.opened);
  console.log(emailStatus.clicked);
  console.log(emailStatus.errorMessage);
}

await lettermint.cancelEmail(ctx, emailId);

Copy codeimport { cronJobs } from "convex/server";
import { components, internal } from "./_generated/api.js";
import { internalMutation } from "./_generated/server.js";

const crons = cronJobs();
crons.interval(
  "Remove old emails from the Lettermint component",
  { hours: 1 },
  internal.crons.cleanupLettermint,
);

const ONE_WEEK_MS = 7 * 24 * 60 * 60 * 1000;
export const cleanupLettermint = internalMutation({
  args: {},
  handler: async (ctx) => {
    await ctx.scheduler.runAfter(0, components.lettermint.lib.cleanupOldEmails, {
      olderThan: ONE_WEEK_MS,
    });
    await ctx.scheduler.runAfter(
      0,
      components.lettermint.lib.cleanupAbandonedEmails,
      { olderThan: 4 * ONE_WEEK_MS },
    );
  },
});

export default crons;

Copy code"use node";
import { action } from "./_generated/server";
import { render, pretty } from "@react-email/render";
import { Button, Html } from "@react-email/components";
import { components } from "./_generated/api";
import { Lettermint } from "convex-lettermint";

export const lettermint = new Lettermint(components.lettermint, {
  testMode: false,
});

export const sendEmail = action({
  args: {},
  handler: async (ctx) => {
    const html = await pretty(
      await render(
        <Html>
          <Button href="https://example.com">Click me</Button>
        </Html>,
      ),
    );

    await lettermint.sendEmail(ctx, {
      from: "Me <test@mydomain.com>",
      to: "recipient@example.com",
      subject: "Hi there",
      html,
    });
  },
});

Copy codeimport { components } from "./_generated/api";
import { internalAction } from "./_generated/server";
import { Lettermint } from "convex-lettermint";

export const lettermint = new Lettermint(components.lettermint, {});

export const sendManualEmail = internalAction({
  args: {},
  handler: async (ctx) => {
    const from = "Acme <onboarding@example.com>";
    const to = ["ok@testing.lettermint.co"];
    const subject = "hello world";
    const html = "<p>it works!</p>";

    await lettermint.sendEmailManually(
      ctx,
      { from, to, subject },
      async (emailId) => {
        const response = await fetch("https://api.lettermint.co/v1/send", {
          method: "POST",
          headers: {
            "x-lettermint-token": process.env.LETTERMINT_PROJECT_TOKEN!,
            "Content-Type": "application/json",
            "Idempotency-Key": emailId,
          },
          body: JSON.stringify({
            from,
            to,
            subject,
            html,
            attachments: [
              {
                filename: "invoice.pdf",
                content: "base64-encoded-content",
              },
            ],
          }),
        });
        if (!response.ok) {
          throw new Error(`[Email] Failed to send: ${await response.text()}`);
        }
        const data = (await response.json()) as { message_id: string };
        return data.message_id;
      },
    );
  },
});