Beignet API reference
    Preparing search index...

    Module @beignet/provider-mail-resend

    @beignet/provider-mail-resend

    Resend-backed mail provider for Beignet.

    The provider installs the app-facing ctx.ports.mailer port and exposes ctx.ports.resend.client only as an escape hatch for Resend-specific features.

    bun add @beignet/provider-mail-resend resend
    
    import { mailResendProvider } from "@beignet/provider-mail-resend";
    import { createServer } from "@beignet/core/server";

    const server = await createServer({
    ports: basePorts,
    providers: [mailResendProvider],
    createContext: ({ ports }) => ({ ports }),
    routes,
    });

    Required environment variables:

    Variable Description
    RESEND_API_KEY Resend API key
    RESEND_FROM Default sender, e.g. My App <no-reply@example.com>
    await ctx.ports.mailer.send({
    to: "user@example.com",
    subject: "Welcome",
    html: "<h1>Hello</h1>",
    });

    The same MailerPort works with SMTP, memory fakes, and other adapters:

    await ctx.ports.mailer.send({
    from: { email: "support@example.com", name: "Support" },
    to: ["user@example.com", "admin@example.com"],
    replyTo: "support@example.com",
    subject: "Account updated",
    text: "Your account was updated.",
    html: "<p>Your account was updated.</p>",
    });

    Use the Resend client only when you need a Resend-specific feature not covered by MailerPort:

    await ctx.ports.resend.client.emails.send({
    from: "sender@example.com",
    to: "user@example.com",
    subject: "Invoice",
    html: "<p>Attached.</p>",
    attachments: [
    {
    filename: "invoice.pdf",
    content: pdfBuffer,
    },
    ],
    });

    When ctx.ports.devtools is installed, this provider records mail.send, mail.sent, and mail.failed events under the mail watcher.

    Delivery failures throw MailDeliveryError from @beignet/core/mail. Startup configuration problems throw during provider setup.

    MIT

    Interfaces

    CreateResendMailerOptions
    ResendMailEscapeHatch
    ResendMailProviderPorts

    Type Aliases

    ResendMailConfig

    Variables

    mailResendProvider

    Functions

    createResendMailer