Layers and environment variables

Every provider subpath exports layer, layerClient and layerConfig. Each returns a Layer that provides Email.

layerConfig has a default Config that reads the environment variables below. Mailtrap has no default, so its config argument is required.

Example (Reading Environment Variables With the Default Config)

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

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

const program = Effect.gen(function* () {
  const email = yield* Email;
  return email.provider;
}).pipe(Effect.provide(EmailLive));

Layer errors are typed: layerConfig can fail with Config.ConfigError for a missing or malformed variable, and every constructor can fail with the provider's configuration error. See Errors.

Redacted secrets must be printable ASCII with no whitespace. Every provider accepts a timeout option of a finite, positive Duration. The default is 30 seconds, and 60 seconds for azure.

Environment variablesCopy Anchor Link

These are the variables the default layerConfig reads.

The default nodemailer config requires SMTP_USER and SMTP_PASSWORD. For an SMTP server without authentication, use Nodemailer.layer with a transport that has no auth.

Options the default config does not read, such as baseUrl, messageStream, sandbox or SES credentials, need a custom Config or layer.

Options by providerCopy Anchor Link

timeout is accepted everywhere and is omitted below.

layerClient optionsCopy Anchor Link

The second argument is optional for every provider except these three, where it holds required fields.