Appearance

@json-express/email-console ​

The default development email provider for JSONExpress.

The @json-express/email-console package implements IEmailProvider and intercepts all outgoing emails, printing them to the terminal in a beautifully formatted box instead of actually sending them over the network.

This is essential for local development and automated testing, where you need to verify that emails are being triggered correctly without configuring an SMTP server or consuming API credits.

Installation ​

bash
npm install @json-express/email-console

Configuration ​

The provider is auto-discovered by the json-express runtime — you do not instantiate it manually. Configure the default sender address through the config provider:

bash
# .env
jex.email.from=noreply@myapp.com

What It Looks Like ​

When the @json-express/plugin-identity triggers a password reset email, you will see this in your terminal:

┌── Email (console) ──────────────────────────────────────
│ From:    noreply@myapp.com
│ To:      user@example.com
│ Subject: Password Reset Request
├─────────────────────────────────────────────────────────
│ Click the link below to reset your password:
│ https://myapp.com/reset?token=abc123def456
└─────────────────────────────────────────────────────────

Core Features ​

1. Structured Logging Integration ​

The email is printed using the system ILogger, not raw console.log. This means:

  • If you are using @json-express/logger-pino, the email content will appear as structured JSON with proper traceId correlation.
  • If you are using @json-express/logger-console, it will be printed as a human-readable box.

2. Playwright Test Compatibility ​

The email body is also injected into the logger's text metadata field. This allows Playwright E2E tests to programmatically scrape the server output, extract password reset tokens, and complete the full authentication flow in an automated test without needing a real email inbox.

3. Health Check ​

The provider exposes an isHealthy() method that always returns true, satisfying the readiness probe contract.