Skip to content

INSTALLATION.md

Latest commit

 

History

History
69 lines (52 loc) · 2.32 KB

INSTALLATION.md

File metadata and controls

69 lines (52 loc) · 2.32 KB

Installation Guide

Legacy package names under @masonjames/* are deprecated. Install the unscoped packages below.

Trusted installation from npm

Use this path when you control the codebase and want full provider parity.

pnpm add emdash-smtp
import { defineConfig } from "astro/config";
import emdash from "emdash/astro";
import { emdashSmtp } from "emdash-smtp";

export default defineConfig({
  integrations: [
    emdash({
      plugins: [emdashSmtp()],
    }),
  ],
});

Sandboxed installation from code

Use this path when you are developing against a sandbox-compatible environment and want the marketplace-safe descriptor from code.

pnpm add emdash-smtp-marketplace
import { defineConfig } from "astro/config";
import emdash from "emdash/astro";
import { emdashSmtpMarketplace } from "emdash-smtp-marketplace";

export default defineConfig({
  integrations: [
    emdash({
      sandboxRunner: "@emdash-cms/cloudflare/sandbox",
      sandboxed: [emdashSmtpMarketplace()],
    }),
  ],
});

Installation from the EmDash Marketplace

  1. Configure marketplace access and sandbox support for your EmDash deployment.
  2. From this repo, publish the marketplace package for the emdash-smtp plugin with pnpm publish:marketplace.
  3. Install EmDash SMTP from Plugins → Marketplace in EmDash.
  4. Open the plugin’s Providers page and configure the active provider.

Recommended initial providers

  • Resend: configure an API key and a verified sender domain, then set Resend as the primary provider.
  • Google / Gmail: configure either a direct access token or a clientId + clientSecret + refreshToken credential set. The plugin refreshes Google access tokens during delivery when refresh credentials are present.
  • Microsoft / Outlook and Zoho Mail follow the same credential model as Google for long-lived OAuth-backed operation.

Variant selection

  • Choose emdash-smtp if you need Generic SMTP or local sendmail.
  • Choose emdash-smtp-marketplace if you need an EmDash marketplace install path or sandbox-safe code install.
  • Do not install emdash-smtp-core or emdash-smtp-node-transports directly; they are implementation packages.
  • Both variants use the same EmDash plugin ID: emdash-smtp.
  • Do not install both variants at the same time on the same site.