Class EmailSendCore

constructor

• new EmailSendCore(
      args: {
          emailClient: Pick<SesEmailClient, "sendEmail">;
          emailTemplateService: EmailTemplateService;
          renderTemplate: (
              input: {
                  template: StoredEmailTemplate;
                  variables: Readonly<Record<string, string | undefined>>;
              },
          ) => Promise<RenderedEmailTemplate>;
      },
  ): EmailSendCore

  Parameters

  • args: {
        emailClient: Pick<SesEmailClient, "sendEmail">;
        emailTemplateService: EmailTemplateService;
        renderTemplate: (
            input: {
                template: StoredEmailTemplate;
                variables: Readonly<Record<string, string | undefined>>;
            },
        ) => Promise<RenderedEmailTemplate>;
    }

    • emailClient: Pick<SesEmailClient, "sendEmail">

    • emailTemplateService: EmailTemplateService

      Resolves the active (live) email template for a given template key. The lambda and admin sendTest paths both need this.

    • renderTemplate: (
          input: {
              template: StoredEmailTemplate;
              variables: Readonly<Record<string, string | undefined>>;
          },
      ) => Promise<RenderedEmailTemplate>

      Injected by the composition root, as a type-only dependency here. Importing the renderer's value would pull React Email into every graph that imports this barrel; only a root that explicitly imports @cfxlabsinc/notification-services/email-render pays that cost.

  Returns EmailSendCore

Staticinstance

send

• send(
      __namedParameters: {
          notification: EmailNotification;
          recipientGate?: EmailRecipientGate;
          recipients: { email: string; name?: string }[];
          templateKey:
              | "IDENTITY"
              | "ORGANIZATION"
              | "LEDGER_ACCOUNT"
              | "PAYMENT_INSTRUMENT"
              | "DEPOSIT"
              | "WITHDRAW"
              | "TRANSFER"
              | "CARD_TRANSACTION"
              | "INVOICE"
              | "RECEIPT"
              | "AUTH"
              | "APPLICATION";
      },
  ): Promise<EmailSendOutcome>

  Send an email notification via the active template.

  Orchestrates:

  1. Recipient deduplication (lowercased email)
  2. Active template resolution
  3. Rendering, once per recipient
  4. One SES send per recipient, sequentially

  Throws on SES errors; caller must handle retries/DLQ.

  Parameters

  • __namedParameters: {
        notification: EmailNotification;
        recipientGate?: EmailRecipientGate;
        recipients: { email: string; name?: string }[];
        templateKey:
            | "IDENTITY"
            | "ORGANIZATION"
            | "LEDGER_ACCOUNT"
            | "PAYMENT_INSTRUMENT"
            | "DEPOSIT"
            | "WITHDRAW"
            | "TRANSFER"
            | "CARD_TRANSACTION"
            | "INVOICE"
            | "RECEIPT"
            | "AUTH"
            | "APPLICATION";
    }

    • notification: EmailNotification

      Notification payload

    • OptionalrecipientGate?: EmailRecipientGate

      Skips recipients an earlier attempt already mailed.

    • recipients: { email: string; name?: string }[]

    • templateKey:
          | "IDENTITY"
          | "ORGANIZATION"
          | "LEDGER_ACCOUNT"
          | "PAYMENT_INSTRUMENT"
          | "DEPOSIT"
          | "WITHDRAW"
          | "TRANSFER"
          | "CARD_TRANSACTION"
          | "INVOICE"
          | "RECEIPT"
          | "AUTH"
          | "APPLICATION"

      Template key for active template lookup

  Returns Promise<EmailSendOutcome>