Skip to content
Corven Email SDK
Esc
↑↓navigate↵open⌘Jpreview
On this page

Helo

Send through a Helo channel with explicit live or sandbox mode.

Import heloEmailLayer from @corven/email-sdk/helo to provide the common Email service for this account.

Configure the account

import { Layer } from "effect";
import type { Redacted } from "effect";
import { heloEmailLayer } from "@corven/email-sdk/helo";
import { emailHttpLayer } from "./sending.js";

export const configuredHeloAccount = (apiKey: Redacted.Redacted) =>
  heloEmailLayer({ apiKey, channelMode: "Live" }).pipe(Layer.provide(emailHttpLayer));

The example reuses the explicit HTTP Layer. Acquire credentials in trusted host code, then provide this account Layer to your sending program.

Message behavior

  • Choose channelMode Live or Sandbox, and optionally supply a UUID channelId. The setting describes the selected channel; it does not create one.
  • Custom headers cannot override Helo controls. Recipient addresses must be distinct so suppression evidence can be assigned correctly.
  • Sandbox responses become Simulated. Live suppression evidence can produce partial or fully suppressed receipts.
  • Scheduling is unsupported; metadata, inline attachments and bounded tags are supported.

Idempotency

Native idempotency applies to the configured account and channel for one hour. Keys can contain up to 36 characters.

Read field support before switching accounts, and receipts and retries before adding recovery behavior. Configuration and local validation do not authenticate the account or prove delivery.