EmailProvidersMailjet

Mailjet

Send emails using the Mailjet API with @visulima/email

Mailjet Provider

The Mailjet provider allows you to send emails through the Mailjet Send API v3.1.

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

Setup

import { createMail } from "@visulima/email";
import { mailjetProvider } from "@visulima/email/providers/mailjet";

const mail = createMail(
    mailjetProvider({
        apiKey: process.env.MAILJET_API_KEY!,
        apiSecret: process.env.MAILJET_API_SECRET!,
    }),
);

Configuration

The MailjetConfig interface extends BaseConfig with the following options:

OptionTypeRequiredDefaultDescription
apiKeystringYes-Your Mailjet API key
apiSecretstringYes-Your Mailjet API secret
endpointstringNohttps://api.mailjet.comCustom 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 Mailjet")
    .html("<h1>Hello World</h1>");

const result = await mail.send(message);

Provider-Specific Email Options

The Mailjet provider supports additional options through MailjetEmailOptions:

import type { MailjetEmailOptions } from "@visulima/email/providers/mailjet";

const options: MailjetEmailOptions = {
    from: { email: "sender@example.com" },
    to: { email: "user@example.com" },
    subject: "Hello",
    html: "<h1>Hello</h1>",
    templateId: 12345,
    templateLanguage: true,
    templateVariables: { name: "John" },
    customId: "campaign-123",
    priority: 2,
};
OptionTypeDescription
templateIdnumberMailjet template ID
templateLanguagebooleanEnable template language processing
templateVariablesRecord<string, unknown>Template variables
customIdstringCustom ID for tracking
campaignstringCustom campaign name
deduplicateCampaignbooleanPrevent duplicate emails in campaign
prioritynumberPriority (1-5, where 1 is highest)
deliveryTimenumberDelivery time (Unix timestamp)
eventPayloadstringEvent payload for webhooks
urlTagsRecord<string, string>URL tags for tracking

Supported Features

FeatureSupported
AttachmentsYes
Batch SendingYes
Custom HeadersYes
HTMLYes
Reply-ToYes
SchedulingYes
TaggingYes
TemplatesYes
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