simple-smtp-server

SMTP-based email sender for Constructive services. This package exposes a send helper with the same call shape used by @launchql/postmaster (e.g. { to, subject, html, text }).

Configuration is managed through the centralized @pgpmjs/env system, which merges defaults, config files, environment variables, and runtime overrides.

Install

pnpm add simple-smtp-server

Usage

import { send } from 'simple-smtp-server';

await send({
  to: 'user@example.com',
  subject: 'Welcome',
  html: '<p>Hello from SMTP</p>'
});

Programmatic overrides

You can pass SMTP configuration overrides as a second argument to send():

import { send } from 'simple-smtp-server';

await send(
  {
    to: 'user@example.com',
    subject: 'Welcome',
    html: '<p>Hello from SMTP</p>'
  },
  {
    host: 'smtp.example.com',
    port: 587,
    secure: false,
    user: 'myuser',
    pass: 'mypassword',
    from: 'no-reply@example.com'
  }
);

Resetting the transport

If you need to reset the cached SMTP transport (e.g., in tests), use resetTransport():

import { resetTransport } from 'simple-smtp-server';

resetTransport();

Environment variables

Required (unless noted):

• SMTP_HOST (required)
• SMTP_PORT (optional, default: 587)
• SMTP_SECURE (true/false; default: false, set true for port 465)
• SMTP_USER (optional if the server allows anonymous auth)
• SMTP_PASS (required when SMTP_USER is set and auth is required)
• SMTP_FROM (default sender address if from is not passed to send)

Optional:

• SMTP_REPLY_TO (default reply-to address when not provided per message)
• SMTP_REQUIRE_TLS (true/false)
• SMTP_TLS_REJECT_UNAUTHORIZED (true/false, default: true)
• SMTP_POOL (true/false)
• SMTP_MAX_CONNECTIONS (number)
• SMTP_MAX_MESSAGES (number)
• SMTP_NAME (client hostname)
• SMTP_LOGGER (true/false, nodemailer transport logging)
• SMTP_DEBUG (true/false, nodemailer debug output)

Test / debug

This package ships a small test runner you can use to validate your SMTP settings.

SMTP_HOST=smtp.example.com \
SMTP_PORT=587 \
SMTP_USER=example \
SMTP_PASS=secret \
SMTP_FROM="no-reply@example.com" \
SMTP_TEST_TO="you@example.com" \
pnpm --filter "simple-smtp-server" test:send

To use the built-in local SMTP catcher instead of a real SMTP server:

SMTP_TEST_USE_CATCHER=true \
pnpm --filter "simple-smtp-server" test:send

Optional test overrides:

• SMTP_TEST_FROM
• SMTP_TEST_SUBJECT
• SMTP_TEST_TEXT
• SMTP_TEST_HTML
• SMTP_TEST_USE_CATCHER

Education and Tutorials

1. 🚀 Quickstart: Getting Up and Running Get started with modular databases in minutes. Install prerequisites and deploy your first module.

2. 📦 Modular PostgreSQL Development with Database Packages Learn to organize PostgreSQL projects with pgpm workspaces and reusable database modules.

3. ✏️ Authoring Database Changes Master the workflow for adding, organizing, and managing database changes with pgpm.

4. 🧪 End-to-End PostgreSQL Testing with TypeScript Master end-to-end PostgreSQL testing with ephemeral databases, RLS testing, and CI/CD automation.

5. ⚡ Supabase Testing Use TypeScript-first tools to test Supabase projects with realistic RLS, policies, and auth contexts.

6. 💧 Drizzle ORM Testing Run full-stack tests with Drizzle ORM, including database setup, teardown, and RLS enforcement.

7. 🔧 Troubleshooting Common issues and solutions for pgpm, PostgreSQL, and testing.

Related Constructive Tooling

📦 Package Management

• pgpm: 🖥️ PostgreSQL Package Manager for modular Postgres development. Works with database workspaces, scaffolding, migrations, seeding, and installing database packages.

🧪 Testing

• pgsql-test: 📊 Isolated testing environments with per-test transaction rollbacks—ideal for integration tests, complex migrations, and RLS simulation.
• pgsql-seed: 🌱 PostgreSQL seeding utilities for CSV, JSON, SQL data loading, and pgpm deployment.
• supabase-test: 🧪 Supabase-native test harness preconfigured for the local Supabase stack—per-test rollbacks, JWT/role context helpers, and CI/GitHub Actions ready.
• graphile-test: 🔐 Authentication mocking for Graphile-focused test helpers and emulating row-level security contexts.
• pg-query-context: 🔒 Session context injection to add session-local context (e.g., SET LOCAL) into queries—ideal for setting role, jwt.claims, and other session settings.

🧠 Parsing & AST

• pgsql-parser: 🔄 SQL conversion engine that interprets and converts PostgreSQL syntax.
• libpg-query-node: 🌉 Node.js bindings for libpg_query, converting SQL into parse trees.
• pg-proto-parser: 📦 Protobuf parser for parsing PostgreSQL Protocol Buffers definitions to generate TypeScript interfaces, utility functions, and JSON mappings for enums.
• @pgsql/enums: 🏷️ TypeScript enums for PostgreSQL AST for safe and ergonomic parsing logic.
• @pgsql/types: 📝 Type definitions for PostgreSQL AST nodes in TypeScript.
• @pgsql/utils: 🛠️ AST utilities for constructing and transforming PostgreSQL syntax trees.

Credits

🛠 Built by the Constructive team — creators of modular Postgres tooling for secure, composable backends. If you like our work, contribute on GitHub.

Disclaimer

AS DESCRIBED IN THE LICENSES, THE SOFTWARE IS PROVIDED "AS IS", AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND.

No developer or entity involved in creating this software will be liable for any claims or damages whatsoever associated with your use, inability to use, or your interaction with other users of the code, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.