Midway.js + Mailexam

Минимальный пример Midway.js 3 (Koa), который отправляет тестовое письмо через SMTP Mailexam с помощью Nodemailer.

Основан на руководстве Mailexam для Midway.js.

Что понадобится

• Аккаунт Mailexam и проект с SMTP-учётными данными.
• Node.js 18+ и npm.

Из приветственного письма или личного кабинета Mailexam:

Быстрый старт (на хосте)

1. Установите зависимости:

npm install

2. Скопируйте пример файла окружения и заполните учётные данные:

cp .env.example .env

3. Отредактируйте .env:

MAILEXAM_LOGIN=ВАШ_ЛОГИН
MAILEXAM_PASSWORD=ВАШ_ПАРОЛЬ
MAILEXAM_PORT=587
MAIL_FROM=noreply@example.test

4. Соберите и запустите сервер:

npm run build
npm start

По умолчанию сервер слушает http://127.0.0.1:7001.

5. Отправьте тестовое письмо:

curl -X POST http://127.0.0.1:7001/mail/test \
  -H 'Content-Type: application/json' \
  -d '{"to":"user@example.test","subject":"Тест","text":"Привет"}'

Письмо появится в личном кабинете Mailexam → ваш проект → входящие.

Переменные окружения

Для порта 587 транспорт использует STARTTLS (secure: false). Для порта 465 — SMTPS (secure: true).

Структура проекта

.
├── package.json
├── tsconfig.json
├── bootstrap.js              # загружает .env, запускает Midway
├── src/
│   ├── configuration.ts
│   ├── config/config.default.ts
│   ├── service/mail.service.ts
│   └── controller/mail.controller.ts
├── .env.example
├── Dockerfile                # только для локальной отладки
└── docker-compose.yml

Docker (отладка)

Docker предназначен для локальной отладки. Для повседневной разработки запускайте приложение на хосте через npm run build && npm start (см. выше).

cp .env.example .env
# отредактируйте .env с учётными данными Mailexam

docker compose up --build

Затем вызовите тот же endpoint на проброшенном порту:

curl -X POST http://127.0.0.1:7001/mail/test \
  -H 'Content-Type: application/json' \
  -d '{"to":"user@example.test","subject":"Тест","text":"Привет"}'

Внутри контейнера сервер слушает 0.0.0.0:7001.

CI

Задайте эти секреты в окружении CI:

variables:
  MAILEXAM_LOGIN: $MAILEXAM_LOGIN
  MAILEXAM_PASSWORD: $MAILEXAM_PASSWORD
  MAILEXAM_PORT: "587"
  MAIL_FROM: "noreply@example.test"

После отправки письма в тесте проверьте доставку через API Mailexam.

Типичные проблемы

Таймаут соединения / ошибка аутентификации

• Хост должен быть {логин}.mailexam.ru, где {логин} совпадает с MAILEXAM_LOGIN.
• Логин и пароль должны быть из одного проекта Mailexam.

Порт 587 и TLS

• Для 587: secure: false (STARTTLS). Для 465: secure: true.

Переменные undefined

• Добавьте файл .env в корень проекта или экспортируйте переменные в shell/CI.
• bootstrap.js загружает .env через dotenv до запуска приложения.

Письмо не в кабинете

• Откройте входящие того же проекта Mailexam.
• Проверьте логи сервера на ошибки SMTP при sendMail.

См. также

• Руководство Mailexam для Midway.js (wiki)
• Пример на NestJS — другой Node.js-фреймворк с Nodemailer
• Пример на Next.js — App Router с Nodemailer
• Документация Midway.js
• Документация Nodemailer
• Документация API Mailexam

Лицензия

Apache 2.0