ZeptoMail

The @effect-kit/emails/zeptomail subpath sends messages through ZeptoMail and provides the Email service.

InstallationCopy Anchor Link

npm install @effect-kit/emails effect zeptomail@8.0.1

The SDK is a pinned optional peer. It is needed only when you import this subpath.

SetupCopy Anchor Link

ZeptoMail.layerConfig() reads these variables:

Example (Sending a Message With ZeptoMail)

import { ConfigProvider, Effect, Layer } from "effect";
import { Email } from "@effect-kit/emails";
import * as ZeptoMail from "@effect-kit/emails/zeptomail";

const EmailLive = ZeptoMail.layerConfig().pipe(
  Layer.provide(ConfigProvider.layer(ConfigProvider.fromEnv())),
);

const program = Effect.gen(function* () {
  const email = yield* Email;
  return yield* email.send({
    from: "hello@example.com",
    to: "ada@example.com",
    subject: "Welcome",
    text: "Your account is ready.",
  });
});

Effect.runPromise(program.pipe(Effect.provide(EmailLive)));

Use a from address your ZeptoMail account is allowed to send from.

OptionsCopy Anchor Link

ZeptoMail.layer takes these options. layerConfig builds the same object from a Config.

CapabilitiesCopy Anchor Link

ZeptoMail reports this in email.capabilities:

These fail with UnsupportedFeatureError and acceptance: "notSubmitted" before any request:

• An idempotencyKey (feature idempotency).

IdempotencyCopy Anchor Link

Not supported. A key fails with UnsupportedFeatureError before sending.

Provider notesCopy Anchor Link

• url has no default because the host depends on the Zoho data centre of your account. Both layerConfig and layer need it.
• The package adds the Zoho-enczapikey prefix to the token, so pass only the token.
• ZeptoMail returns a request id and no message id. The receipt's references is empty and requestId holds the request id.

Using your own clientCopy Anchor Link

layerClient takes any object with sendMail(message), which a SendMailClient has. options is optional.

Example (Borrowing a ZeptoMail Client)

import { SendMailClient } from "zeptomail";
import * as ZeptoMail from "@effect-kit/emails/zeptomail";

const client = new SendMailClient({
  url: "https://api.zeptomail.com/v1.1/email",
  token: "Zoho-enczapikey fake-token",
});

const EmailLive = ZeptoMail.layerClient(client);

You own a borrowed client. The Layer never closes it, and the client keeps its own retry, timeout and logging policy. A borrowed client carries its own token, so include the prefix there if the SDK needs it.

ErrorsCopy Anchor Link

ProviderConfigurationError carries provider: "zeptomail" and a field naming the bad option. Layer construction fails with it, and layerClient fails with it for the client options.

An API error from the SDK uses its HTTP status with the shared mapping. A response that is not valid JSON fails with UnexpectedResponseError. Kept providerCode values are TM_3004 and AUTHENTICATION_ERROR.