Skip to main content

Getting Started

Installation

  1. Install the plugin in your EmDash CMS project:
npm install @jetemail/emdash-plugin
  1. Add the plugin to your Astro config:
// astro.config.mjs
import { jetEmailPlugin } from "@jetemail/emdash-plugin/config";

export default defineConfig({
  integrations: [
    emdash({
      plugins: [jetEmailPlugin()],
    }),
  ],
});
Optionally, you can pass your API key at config time:
jetEmailPlugin({
  apiKey: process.env.JETEMAIL_API_KEY,
})
  1. Navigate to Plugins > JetEmail in the EmDash CMS admin panel.
  2. Enter your JetEmail Transactional API key. You can find your API key in the JetEmail dashboard under Outbound > Keys (https://dash.jetemail.com).
  3. Configure your From Name and From Email address.
  4. Save settings and send a test email.

Configuration

SettingDescription
API KeyTransactional API key (starts with transactional_)
From AddressSender email on a verified domain
From NameDisplay name (optional)

Requirements

  • An EmDash CMS site
  • A JetEmail account with a verified domain
  • A transactional API key

Features

  • Easy Setup — Install the plugin, enter your API key, and you’re ready to go
  • Full Email Coverage — Handles authentication emails (magic links, password resets), form notifications, and all other transactional emails
  • Admin Panel — Configure credentials and sender details directly from the EmDash CMS admin
  • Test Connection — Send a test email to verify your configuration

How It Works

The plugin registers as an EmDash CMS email provider using the email:deliver hook. Once activated, all email sent by EmDash CMS — including magic links, password resets, and form submissions — is routed through the JetEmail API.

Support

For support, please visit our Discord community or contact your JetEmail account representative.