Перейти к содержанию

NestJS

Инструкция для приложений на NestJS (Node.js 18+). Mailexam подключается как SMTP через Nodemailer и модуль @nestjs-modules/mailer.

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

  • Аккаунт Mailexam и проект с SMTP-учётными данными.
  • Nest-приложение (CLI: nest new).

Скопируйте из приветственного письма (или кабинета) для вашего проекта:

  • ВАШ_ЛОГИН — SMTP-логин (например, xxxxx);
  • ВАШ_ПАРОЛЬ — SMTP-пароль (уникальная пара к логину);
  • хост — ВАШ_ЛОГИН.mailexam.ru (совпадает с логином).

1. Зависимости

npm install @nestjs-modules/mailer nodemailer
npm install -D @types/nodemailer

Опционально для .env:

npm install @nestjs/config

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

Файл .env в корне проекта (не коммитьте пароли в git):

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

Хост SMTP: ВАШ_ЛОГИН.mailexam.ru.

Адрес отправителя

MAIL_FROM может быть любым тестовым адресом — письмо попадёт в Mailexam, а не реальному получателю.

Альтернативные порты

MAILEXAM_PORT=587

В транспорте: secure: false (STARTTLS на 587).

MAILEXAM_PORT=2525
MAILEXAM_PORT=465

В транспорте укажите secure: true.

3. Модуль Mailer

app.module.ts:

import { Module } from '@nestjs/common';
import { MailerModule } from '@nestjs-modules/mailer';
import { ConfigModule } from '@nestjs/config';
import { MailController } from './mail.controller';

@Module({
  imports: [
    ConfigModule.forRoot({ isGlobal: true }),
    MailerModule.forRootAsync({
      useFactory: () => {
        const login = process.env.MAILEXAM_LOGIN!;
        const port = Number(process.env.MAILEXAM_PORT ?? 587);

        return {
          transport: {
            host: `${login}.mailexam.ru`,
            port,
            secure: port === 465,
            auth: {
              user: login,
              pass: process.env.MAILEXAM_PASSWORD,
            },
          },
          defaults: {
            from: process.env.MAIL_FROM ?? 'noreply@example.test',
          },
        };
      },
    }),
  ],
  controllers: [MailController],
})
export class AppModule {}

Без @nestjs/config уберите ConfigModule и убедитесь, что переменные заданы в окружении процесса.

4. Тестовый маршрут

// mail.controller.ts
import { Body, Controller, Post } from '@nestjs/common';
import { MailerService } from '@nestjs-modules/mailer';

class SendMailDto {
  to?: string;
  subject?: string;
  text?: string;
}

@Controller('mail')
export class MailController {
  constructor(private readonly mailer: MailerService) {}

  @Post('test')
  async test(@Body() body: SendMailDto) {
    await this.mailer.sendMail({
      to: body.to ?? 'user@example.test',
      subject: body.subject ?? 'Nest + Mailexam',
      text: body.text ?? 'Тест Mailexam из NestJS',
    });

    return { status: 'ok' };
  }
}

Запуск и проверка:

npm run start:dev
curl -X POST http://127.0.0.1:3000/mail/test \
  -H 'Content-Type: application/json' \
  -d '{"to":"user@example.test","subject":"Проверка","text":"Привет"}'

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

5. Локальная разработка и CI

Среда Рекомендация
local .env + ConfigModule.forRoot()
CI Секреты MAILEXAM_LOGIN, MAILEXAM_PASSWORD в GitLab CI/CD Variables

Пример для .gitlab-ci.yml:

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

Для unit-тестов подмените MailerService моком или используйте transport: { jsonTransport: true } в тестовом модуле.

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

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

Connection timeout / authentication failed

  • host должен быть {логин}.mailexam.ru, auth.user — тот же логин из письма.
  • Логин и пароль — пара из письма одного проекта.

Порт 587 и TLS

  • Используйте secure: false для 587 (STARTTLS). Для 465 — secure: true.

Переменные undefined

  • Подключите ConfigModule.forRoot() или экспортируйте .env в CI.

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

  • Смотрите входящие того же проекта Mailexam.
  • Проверьте логи Nest при sendMail (ошибки SMTP выводятся в консоль).

См. также