emailengine-app 1.14.7 → 2.60.1

package/.env.development

@@ -0,0 +1,49 @@
+# EmailEngine Development Environment Configuration
+# This file contains default settings for local development
+
+# ===========================================
+# BASIC CONFIGURATION
+# ===========================================
+
+# Encryption secret (use default for development)
+EENGINE_SECRET=default-dev-secret-change-in-production
+
+# Redis connection (no password for development)
+EENGINE_REDIS=redis://redis:6379/2
+
+# Number of worker processes (lower for development)
+EENGINE_WORKERS=2
+
+# EmailEngine settings for development
+EENGINE_SETTINGS={"smtpServerEnabled": true, "smtpServerPort": 2525, "smtpServerHost": "0.0.0.0", "smtpServerAuthEnabled": true, "smtpServerPassword": "devpassword"}
+
+# ===========================================
+# SERVICE EXPOSURE
+# ===========================================
+
+# Bind to all interfaces for development
+EMAILENGINE_API_BIND=0.0.0.0
+EMAILENGINE_SMTP_BIND=0.0.0.0
+EMAILENGINE_IMAP_BIND=0.0.0.0
+
+# ===========================================
+# REDIS CONFIGURATION
+# ===========================================
+
+# Redis is used as a database, not a cache
+# No memory limit is set for development
+# Eviction policy is set to 'noeviction' to prevent data loss
+
+# ===========================================
+# LOGGING
+# ===========================================
+
+EENGINE_LOG_LEVEL=debug
+REDIS_LOG_LEVEL=notice
+
+# ===========================================
+# HEALTH CHECKS (RELAXED FOR DEVELOPMENT)
+# ===========================================
+
+REDIS_HEALTHCHECK=service_started
+HEALTHCHECK_INTERVAL=60s

package/.env.example

@@ -0,0 +1,82 @@
+# EmailEngine Test Environment Variables
+# Copy this file to .env and fill in your actual values
+
+# =============================================================================
+# Gmail API OAuth2 Configuration (Full Access)
+# =============================================================================
+# Required for Gmail API tests with read/write/modify permissions
+# Get these credentials from: https://console.cloud.google.com/apis/credentials
+
+# Google Cloud Project ID for Gmail API
+GMAIL_API_PROJECT_ID="your-project-id"
+
+# OAuth2 Client credentials (for user authentication)
+GMAIL_API_CLIENT_ID="your-client-id.apps.googleusercontent.com"
+GMAIL_API_CLIENT_SECRET="your-client-secret"
+
+# Service Account credentials (for Gmail Pub/Sub watch notifications)
+GMAIL_API_SERVICE_EMAIL="your-service-account@your-project.iam.gserviceaccount.com"
+GMAIL_API_SERVICE_CLIENT="your-service-client-id"
+GMAIL_API_SERVICE_KEY="-----BEGIN PRIVATE KEY-----\nyour-service-account-private-key\n-----END PRIVATE KEY-----\n"
+
+# Test Gmail accounts with full access (gmail.modify scope)
+GMAIL_API_ACCOUNT_EMAIL_1="test.account.1@example.com"
+GMAIL_API_ACCOUNT_REFRESH_1="1//0c-your-refresh-token-1"
+
+GMAIL_API_ACCOUNT_EMAIL_2="test.account.2@example.com"
+GMAIL_API_ACCOUNT_REFRESH_2="1//0c-your-refresh-token-2"
+
+# =============================================================================
+# Gmail Send-Only Configuration
+# =============================================================================
+# Required for Gmail send-only account tests (gmail.send scope only)
+# This is a separate OAuth2 client configured with only gmail.send permission
+
+# Google Cloud Project ID for send-only Gmail
+GMAIL_SENDONLY_PROJECT_ID="your-sendonly-project-id"
+
+# OAuth2 Client credentials for send-only access
+GMAIL_SENDONLY_CLIENT_ID="your-sendonly-client-id.apps.googleusercontent.com"
+GMAIL_SENDONLY_CLIENT_SECRET="your-sendonly-client-secret"
+
+# Test Gmail account with send-only access
+GMAIL_SENDONLY_ACCOUNT_EMAIL="sendonly.test@example.com"
+GMAIL_SENDONLY_ACCOUNT_REFRESH="1//0c-your-sendonly-refresh-token"
+
+# =============================================================================
+# Setup Instructions
+# =============================================================================
+#
+# 1. Gmail API Full Access Setup:
+#    a. Create a Google Cloud project
+#    b. Enable Gmail API
+#    c. Create OAuth2 credentials (Web application)
+#    d. Add authorized redirect URI: http://127.0.0.1:3000/oauth
+#    e. Configure OAuth consent screen
+#    f. Add scopes: gmail.modify, gmail.labels, gmail.send
+#    g. Create a Service Account for Pub/Sub notifications
+#
+# 2. Gmail Send-Only Setup:
+#    a. Create a separate Google Cloud project (or use the same)
+#    b. Enable Gmail API
+#    c. Create separate OAuth2 credentials
+#    d. Add scopes: gmail.send, openid, email, profile (only)
+#    e. DO NOT add gmail.modify, gmail.readonly, or gmail.labels
+#
+# 3. Getting Refresh Tokens:
+#    - Use OAuth2 authorization flow to authenticate test users
+#    - Store the refresh tokens in this .env file
+#    - Refresh tokens start with "1//0c" for Google OAuth2
+#
+# 4. Getting Service Account Key:
+#    - Create a Service Account in Google Cloud Console
+#    - Generate and download JSON key file
+#    - Extract the private_key field and paste it here
+#    - Keep newlines as literal "\n" in the string
+#
+# =============================================================================
+# Security Notice
+# =============================================================================
+# WARNING: Never commit .env file with real credentials to version control!
+# Add .env to your .gitignore file
+# Only commit this .env.example file with placeholder values

package/.env.production

@@ -0,0 +1,87 @@
+# EmailEngine Production Environment Configuration
+# Copy this file to .env and configure with your actual values
+
+# ===========================================
+# REQUIRED SECURITY SETTINGS
+# ===========================================
+
+# Encryption secret for EmailEngine (generate with: openssl rand -hex 32)
+EENGINE_SECRET=CHANGE_ME_USE_STRONG_SECRET_HERE
+
+# Redis password (generate with: openssl rand -base64 32)
+REDIS_PASSWORD=CHANGE_ME_USE_STRONG_PASSWORD_HERE
+
+# Redis connection with authentication
+EENGINE_REDIS=redis://:${REDIS_PASSWORD}@redis:6379/2
+
+# ===========================================
+# EMAILENGINE CONFIGURATION
+# ===========================================
+
+# Log level (error, warn, info, debug)
+EENGINE_LOG_LEVEL=info
+
+# Number of worker processes (should match CPU cores, min 4, max 24)
+EENGINE_WORKERS=8
+
+# EmailEngine settings (configure SMTP password)
+EENGINE_SETTINGS={"smtpServerEnabled": true, "smtpServerPort": 2525, "smtpServerHost": "0.0.0.0", "smtpServerAuthEnabled": true, "smtpServerPassword": "CHANGE_ME_SMTP_PASSWORD"}
+
+# ===========================================
+# SERVICE EXPOSURE (PRODUCTION)
+# ===========================================
+
+# Bind only to localhost for production (use reverse proxy for external access)
+EMAILENGINE_API_BIND=127.0.0.1
+EMAILENGINE_SMTP_BIND=127.0.0.1
+EMAILENGINE_IMAP_BIND=127.0.0.1
+
+# Port configuration (optional, defaults shown)
+# EMAILENGINE_API_PORT=3000
+# EMAILENGINE_SMTP_PORT=2525
+# EMAILENGINE_IMAP_PORT=9993
+
+# ===========================================
+# REDIS CONFIGURATION
+# ===========================================
+
+# Redis is used as a database, not a cache
+# No memory limit is set - Redis will use available system memory
+# Monitor usage with: docker-compose exec redis redis-cli INFO memory
+# Eviction policy is set to 'noeviction' to prevent data loss
+
+# ===========================================
+# LOGGING CONFIGURATION
+# ===========================================
+
+# Log levels
+REDIS_LOG_LEVEL=notice
+
+# Log rotation
+LOG_MAX_SIZE=100m
+LOG_MAX_FILE=10
+LOG_COMPRESS=true
+
+# ===========================================
+# HEALTH CHECKS
+# ===========================================
+
+# Use strict health checks for production
+REDIS_HEALTHCHECK=service_healthy
+
+# Health check configuration
+HEALTHCHECK_INTERVAL=30s
+HEALTHCHECK_TIMEOUT=10s
+HEALTHCHECK_RETRIES=3
+HEALTHCHECK_START_PERIOD=40s
+
+# ===========================================
+# OTHER SETTINGS
+# ===========================================
+
+# Restart policy
+RESTART_POLICY=unless-stopped
+
+# Docker image versions (optional, latest by default)
+# EMAILENGINE_VERSION=latest
+# REDIS_VERSION=7-alpine

package/.eslintignore

@@ -0,0 +1 @@
+# placeholder

package/.github/workflows/deploy.yml

@@ -0,0 +1,104 @@
+on:
+    push:
+        branches:
+            - master
+
+name: Deploy test instance and Docker image
+
+concurrency:
+    group: ${{ github.workflow }}-${{ github.ref }}
+    cancel-in-progress: true
+
+jobs:
+    deploy:
+        name: Deploy Demo App
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+
+            - name: Install SSH key
+              uses: shimataro/ssh-key-action@v2
+              with:
+                  key: ${{ secrets.SSH_KEY }}
+                  known_hosts: ${{ secrets.KNOWN_HOSTS }}
+
+            - name: Deploy to server
+              env:
+                  TARGET_HOST_02: dev.emailengine.app
+                  NODE_ENV: production
+                  SERVICE_NAME: emailengine
+              id: deploy
+              run: |
+                  echo $GITHUB_SHA > commit.txt
+                  ./update-info.sh
+                  npm install --omit=dev
+                  tar czf /tmp/${SERVICE_NAME}.tar.gz --exclude .git .
+                  scp -o "UserKnownHostsFile=/dev/null" -o "StrictHostKeyChecking=no" /tmp/${SERVICE_NAME}.tar.gz deploy@${TARGET_HOST_02}:
+                  ssh -o "UserKnownHostsFile=/dev/null" -o "StrictHostKeyChecking=no" deploy@$TARGET_HOST_02 "/opt/deploy.sh ${SERVICE_NAME}"
+
+            - name: Deploy to demo server
+              env:
+                  TARGET_HOST_02: dev.emailengine.app
+                  NODE_ENV: production
+                  SERVICE_NAME: emailengine-demo
+              id: deploy-demo
+              run: |
+                  echo $GITHUB_SHA > commit.txt
+                  ./update-info.sh
+                  npm install --omit=dev
+                  tar czf /tmp/${SERVICE_NAME}.tar.gz --exclude .git .
+                  scp -o "UserKnownHostsFile=/dev/null" -o "StrictHostKeyChecking=no" /tmp/${SERVICE_NAME}.tar.gz deploy@${TARGET_HOST_02}:
+                  ssh -o "UserKnownHostsFile=/dev/null" -o "StrictHostKeyChecking=no" deploy@$TARGET_HOST_02 "/opt/deploy.sh ${SERVICE_NAME}"
+
+    docker:
+        name: Build Docker Image
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+
+            - name: Set up QEMU
+              uses: docker/setup-qemu-action@v3
+              with:
+                  platforms: 'arm64,arm'
+
+            - name: Set up Docker Buildx
+              id: buildx
+              uses: docker/setup-buildx-action@v3
+              with:
+                  platforms: linux/amd64,linux/arm64/v8
+
+            - name: Login to Docker Hub
+              uses: docker/login-action@v3
+              with:
+                  username: ${{ secrets.DOCKERHUB_USERNAME }}
+                  password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+            - name: Login to GHCR
+              uses: docker/login-action@v3
+              with:
+                  registry: ghcr.io
+                  username: ${{ github.repository_owner }}
+                  password: ${{ secrets.GITHUB_TOKEN }}
+
+            - name: Docker meta
+              id: meta
+              uses: docker/metadata-action@v5
+              with:
+                  images: |
+                      ${{ github.repository }}
+                      ghcr.io/${{ github.repository }}
+                  tags: |
+                      type=raw,value=latest,enable=true
+
+            - name: Build and push
+              uses: docker/build-push-action@v6
+              with:
+                  context: .
+                  platforms: ${{ steps.buildx.outputs.platforms }}
+                  push: true
+                  tags: ${{ steps.meta.outputs.tags }}
+                  labels: ${{ steps.meta.outputs.labels }}

package/.github/workflows/release.yaml

@@ -0,0 +1,107 @@
+on:
+    push:
+        branches:
+            - master
+
+permissions:
+    contents: write
+    pull-requests: write
+    packages: write
+    attestations: write
+    id-token: write
+
+name: Manage Release
+jobs:
+    release_please:
+        name: Create or prepare release
+        runs-on: ubuntu-latest
+        outputs:
+            major: ${{ steps.release.outputs.major }}
+            minor: ${{ steps.release.outputs.minor }}
+            patch: ${{ steps.release.outputs.patch }}
+            release_created: ${{ steps.release.outputs.release_created }}
+        steps:
+            - uses: googleapis/release-please-action@v4
+              id: release
+              with:
+                  release-type: node
+
+            # The logic below handles the npm publication:
+            - uses: actions/checkout@v4
+              # these if statements ensure that a publication only occurs when
+              # a new release is created:
+              if: ${{ steps.release.outputs.release_created }}
+
+            - uses: actions/setup-node@v4
+              with:
+                  node-version: 20
+                  registry-url: "https://registry.npmjs.org"
+              if: ${{ steps.release.outputs.release_created }}
+
+            - run: npm install
+              if: ${{ steps.release.outputs.release_created }}
+
+    publish:
+        name: Publish NPM package
+        runs-on: ubuntu-latest
+        needs: release_please
+        if: ${{needs.release_please.outputs.release_created}}
+        permissions:
+            contents: read
+            id-token: write
+        steps:
+            - uses: actions/checkout@v4
+            - uses: actions/setup-node@v4
+              with:
+                  node-version: 24
+                  registry-url: "https://registry.npmjs.org"
+            - run: npm ci
+            - run: npm publish --provenance --access public
+
+    publish_docker:
+        name: Publish Tagged Docker Image
+        runs-on: ubuntu-latest
+        needs: release_please
+        if: ${{needs.release_please.outputs.release_created}}
+        steps:
+            - run: echo version v${{needs.release_please.outputs.major}}.${{needs.release_please.outputs.minor}}.${{needs.release_please.outputs.patch}}
+
+            - uses: actions/checkout@v4
+
+            - name: Set up QEMU
+              uses: docker/setup-qemu-action@v3
+              with:
+                  platforms: "arm64,arm"
+
+            - name: Set up Docker Buildx
+              id: buildx
+              uses: docker/setup-buildx-action@v3
+              with:
+                  platforms: linux/amd64,linux/arm64/v8
+
+            - name: Login to DockerHub
+              uses: docker/login-action@v3
+              with:
+                  username: ${{ secrets.DOCKERHUB_USERNAME }}
+                  password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+            - name: Login to GHCR
+              uses: docker/login-action@v3
+              with:
+                  registry: ghcr.io
+                  username: ${{ github.repository_owner }}
+                  password: ${{ secrets.GITHUB_TOKEN }}
+
+            - name: Build and push
+              uses: docker/build-push-action@v6
+              with:
+                  context: .
+                  platforms: ${{ steps.buildx.outputs.platforms }}
+                  push: true
+                  tags: |
+                      ${{ github.repository }}:v${{needs.release_please.outputs.major}}.${{needs.release_please.outputs.minor}}.${{needs.release_please.outputs.patch}}
+                      ${{ github.repository }}:v${{needs.release_please.outputs.major}}.${{needs.release_please.outputs.minor}}
+                      ${{ github.repository }}:v${{needs.release_please.outputs.major}}
+                      ghcr.io/${{ github.repository }}:v${{needs.release_please.outputs.major}}.${{needs.release_please.outputs.minor}}.${{needs.release_please.outputs.patch}}
+                      ghcr.io/${{ github.repository }}:v${{needs.release_please.outputs.major}}.${{needs.release_please.outputs.minor}}
+                      ghcr.io/${{ github.repository }}:v${{needs.release_please.outputs.major}}

package/.github/workflows/test.yml

@@ -0,0 +1,82 @@
+name: Run Tests
+
+on:
+    push:
+    pull_request:
+
+concurrency:
+    group: ${{ github.workflow }}-${{ github.ref }}
+    cancel-in-progress: true
+
+jobs:
+    license_check:
+        name: License Compliance Check
+        runs-on: ubuntu-latest
+        # Service containers to run with `container-job`
+        steps:
+            - uses: actions/checkout@v4
+
+            - name: Use Node.js 20
+              uses: actions/setup-node@v4
+              with:
+                  node-version: 20
+            - run: npm install
+
+            - name: Run License Checks
+              run: |
+                  npm run licenses
+
+    test:
+        name: Test Suite
+        timeout-minutes: 15  # Increased timeout for Gmail API tests
+        strategy:
+            matrix:
+                node: [20.x]
+                os: [ubuntu-22.04]
+        runs-on: ${{ matrix.os }}
+        # Service containers to run with `container-job`
+        services:
+            # Label used to access the service container
+            redis:
+                # Docker Hub image
+                image: redis
+                # Set health checks to wait until redis has started
+                options: >-
+                    --health-cmd "redis-cli ping"
+                    --health-interval 10s
+                    --health-timeout 5s
+                    --health-retries 5
+                ports:
+                    - 6379:6379
+        steps:
+            - uses: actions/checkout@v4
+            - name: Use Node.js ${{ matrix.node }}
+              uses: actions/setup-node@v4
+              with:
+                  node-version: ${{ matrix.node }}
+            - name: Setup Redis CLI
+              uses: shogo82148/actions-setup-redis@v1
+              with:
+                  redis-version: '7.x'
+                  auto-start: 'false'
+            - run: npm install
+            - name: Run tests
+              run: |
+                  npm test
+              env:
+                  NODE_ENV: test
+                  GMAIL_API_PROJECT_ID: ${{ secrets.TEST_GMAIL_API_PROJECT_ID }}
+                  GMAIL_API_CLIENT_ID: ${{ secrets.TEST_GMAIL_API_CLIENT_ID }}
+                  GMAIL_API_CLIENT_SECRET: ${{ secrets.TEST_GMAIL_API_CLIENT_SECRET }}
+                  GMAIL_API_SERVICE_EMAIL: ${{ secrets.TEST_GMAIL_API_SERVICE_EMAIL }}
+                  GMAIL_API_SERVICE_CLIENT: ${{ secrets.TEST_GMAIL_API_SERVICE_CLIENT }}
+                  GMAIL_API_SERVICE_KEY: ${{ secrets.TEST_GMAIL_API_SERVICE_KEY }}
+                  GMAIL_API_ACCOUNT_EMAIL_1: ${{ secrets.TEST_GMAIL_API_ACCOUNT_EMAIL_1 }}
+                  GMAIL_API_ACCOUNT_REFRESH_1: ${{ secrets.TEST_GMAIL_API_ACCOUNT_REFRESH_1 }}
+                  GMAIL_API_ACCOUNT_EMAIL_2: ${{ secrets.TEST_GMAIL_API_ACCOUNT_EMAIL_2 }}
+                  GMAIL_API_ACCOUNT_REFRESH_2: ${{ secrets.TEST_GMAIL_API_ACCOUNT_REFRESH_2 }}
+                  GMAIL_SENDONLY_PROJECT_ID: ${{ secrets.GMAIL_SENDONLY_PROJECT_ID }}
+                  GMAIL_SENDONLY_CLIENT_ID: ${{ secrets.GMAIL_SENDONLY_CLIENT_ID }}
+                  GMAIL_SENDONLY_CLIENT_SECRET: ${{ secrets.GMAIL_SENDONLY_CLIENT_SECRET }}
+                  GMAIL_SENDONLY_ACCOUNT_EMAIL: ${{ secrets.GMAIL_SENDONLY_ACCOUNT_EMAIL }}
+                  GMAIL_SENDONLY_ACCOUNT_REFRESH: ${{ secrets.GMAIL_SENDONLY_ACCOUNT_REFRESH }}

package/.ncurc.js

@@ -1,10 +1,24 @@
 module.exports = {
     upgrade: true,
     reject: [
-        // v3 is ESM only
-        'node-fetch',
-        // Documentation required to use linkify-html package for latest versions but the package was not found.
-        // Remove once resolved
-        'linkifyjs'
+        // Block package upgrades that moved to ESM
+        'nanoid',
+        'gettext-parser',
+        'xgettext-template',
+        'chai',
+        'js-beautify',
+        'ical.js',
+        '@elastic/elasticsearch',
+
+        'pino-pretty',
+
+        // no support for Node 16
+        'marked',
+
+        // some kind of CVE in later versions. Only needed for license reference, so the actual version does not matter anyway
+        'startbootstrap-sb-admin-2',
+
+        // Keep joi at version 17.x for hapi-swagger compatibility
+        'joi'
     ]
 };

package/.prettierignore

@@ -0,0 +1,44 @@
+# Dependencies
+node_modules/
+
+# Build outputs
+ee-dist/
+dist/
+build/
+
+# Static assets and vendor files
+static/
+
+# Test fixtures
+test/fixtures/
+
+# IMAP core library (external dependency)
+lib/imapproxy/imap-core/
+
+# Generated files
+*.min.js
+*-min.js
+*.bundle.js
+
+# Logs
+*.log
+
+# Environment files
+.env*
+
+# Package manager files
+package-lock.json
+yarn.lock
+
+# OS files
+.DS_Store
+Thumbs.db
+
+# IDE files
+.vscode/
+.idea/
+*.swp
+*.swo
+
+# Documentation
+docs/