EmailProvidersZeptomail

Zeptomail

Send emails using the Zeptomail API with @visulima/email

Zeptomail Provider

The Zeptomail provider allows you to send emails through the Zeptomail API.

Runtime Support: Universal (Node.js, Deno, Bun, Cloudflare Workers)

Setup

import { createMail } from "@visulima/email";
import { zeptomailProvider } from "@visulima/email/providers/zeptomail";

const mail = createMail(
    zeptomailProvider({
        token: process.env.ZEPTOMAIL_TOKEN!,
    }),
);

Configuration

The ZeptomailConfig interface extends BaseConfig with the following options:

OptionTypeRequiredDefaultDescription
tokenstringYes-Your Zeptomail send mail token
endpointstringNoAutoCustom API endpoint
debugbooleanNofalseEnable debug logging
loggerConsoleNo-Custom logger instance
retriesnumberNo3Number of retry attempts
timeoutnumberNo30000Request timeout in milliseconds

Basic Usage

import { MailMessage } from "@visulima/email";

const message = new MailMessage()
    .to("user@example.com")
    .from("sender@example.com")
    .subject("Hello from Zeptomail")
    .html("<h1>Hello World</h1>");

const result = await mail.send(message);

Provider-Specific Email Options

The Zeptomail provider supports additional options through ZeptomailEmailOptions:

OptionTypeDescription
clientReferencestringIdentifier to track a particular transaction
mimeHeadersRecord<string, string>Additional MIME headers
trackClicksbooleanEnable tracking for click events
trackOpensbooleanEnable tracking for open events

Supported Features

FeatureSupported
AttachmentsYes
Batch SendingNo
Custom HeadersYes
HTMLYes
Reply-ToYes
SchedulingNo
TaggingYes
TemplatesNo
TrackingYes
Support

Contribute to our work and keep us going

Community is the heart of open source. The success of our packages wouldn't be possible without the incredible contributions of users, testers, and developers who collaborate with us every day.Want to get involved? Here are some tips on how you can make a meaningful impact on our open source projects.

Ready to help us out?

Be sure to check out the package's contribution guidelines first. They'll walk you through the process on how to properly submit an issue or pull request to our repositories.

Submit a pull request

Found something to improve? Fork the repo, make your changes, and open a PR. We review every contribution and provide feedback to help you get merged.

Good first issues

Simple issues suited for people new to open source development, and often a good place to start working on a package.
View good first issues