FastAPI + Mailexam
Минимальный пример FastAPI, который отправляет тестовое письмо через SMTP Mailexam с помощью стандартной библиотеки Python smtplib.
Основан на руководстве Mailexam для FastAPI.
Что понадобится
- Аккаунт Mailexam и проект с SMTP-учётными данными.
- Python 3.10+ и pip.
Из приветственного письма или личного кабинета Mailexam:
| Переменная | Описание |
|---|---|
MAILEXAM_LOGIN |
SMTP-логин (например, xxxxx) |
MAILEXAM_PASSWORD |
SMTP-пароль (пара к логину) |
| Хост |
{MAILEXAM_LOGIN}.mailexam.ru (формируется автоматически в коде) |
Быстрый старт (на хосте)
- Создайте виртуальное окружение и установите зависимости:
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
- Скопируйте пример файла окружения и заполните учётные данные:
cp .env.example .env
- Отредактируйте
.env:
MAILEXAM_LOGIN=ВАШ_ЛОГИН
MAILEXAM_PASSWORD=ВАШ_ПАРОЛЬ
MAILEXAM_PORT=587
MAIL_FROM=noreply@example.test
- Запустите сервер:
uvicorn main:app --host 127.0.0.1 --port 8000
По умолчанию сервер слушает http://127.0.0.1:8000. Интерактивная документация API: http://127.0.0.1:8000/docs
- Отправьте тестовое письмо:
curl -X POST http://127.0.0.1:8000/mail/test \
-H 'Content-Type: application/json' \
-d '{"to":"user@example.test","subject":"Тест","body":"Привет"}'
Письмо появится в личном кабинете Mailexam → ваш проект → входящие.
Переменные окружения
| Переменная | Обязательна | По умолчанию | Описание |
|---|---|---|---|
MAILEXAM_LOGIN |
да | — | SMTP-логин; также используется для формирования имени хоста |
MAILEXAM_PASSWORD |
да | — | SMTP-пароль |
MAILEXAM_PORT |
нет | 587 |
SMTP-порт (587, 2525 или 25) |
MAIL_FROM |
нет | noreply@example.test |
Адрес отправителя (подойдёт любой тестовый) |
HTTP_HOST |
нет | 127.0.0.1 |
Адрес привязки HTTP (Docker) |
HTTP_PORT |
нет | 8000 |
Порт HTTP (Docker) |
Для порта 587 код вызывает starttls() перед входом. Для порта 25 подключение без STARTTLS.
Структура проекта
.
├── requirements.txt
├── mail.py # транспорт smtplib и send_test()
├── main.py # приложение FastAPI и POST /mail/test
├── .env.example
├── Dockerfile # только для локальной отладки
└── docker-compose.yml
Docker (отладка)
Docker предназначен для локальной отладки. Для повседневной разработки запускайте приложение на хосте через uvicorn (см. выше).
cp .env.example .env
# отредактируйте .env с учётными данными
docker compose up --build
Затем вызовите тот же endpoint на проброшенном порту:
curl -X POST http://127.0.0.1:8000/mail/test \
-H 'Content-Type: application/json' \
-d '{"to":"user@example.test","subject":"Тест","body":"Привет"}'
Внутри контейнера сервер слушает 0.0.0.0:8000, чтобы работало проброс портов.
CI
Задайте эти секреты в окружении CI:
variables:
MAILEXAM_LOGIN: $MAILEXAM_LOGIN
MAILEXAM_PASSWORD: $MAILEXAM_PASSWORD
MAILEXAM_PORT: "587"
MAIL_FROM: "noreply@example.test"
После отправки письма в тесте проверьте доставку через API Mailexam.
Типичные проблемы
Ошибка TLS или подключения
- Хост должен быть
{логин}.mailexam.ru, где{логин}совпадает сMAILEXAM_LOGIN. - Логин и пароль должны быть из одного проекта Mailexam.
- Для порта 587 вызывайте
starttls()передlogin().
Блокировка event loop
-
send_test()выполняется внутриasyncio.to_thread(), чтобы асинхронный обработчик не блокировался.
Письмо не в кабинете
- Откройте входящие того же проекта Mailexam.
- Проверьте ответ
/mail/testи логи uvicorn.
Порт уже занят
- Измените порт в команде uvicorn или задайте
HTTP_PORTв Docker.
См. также
- Руководство Mailexam для FastAPI (wiki)
-
Пример на Flask — тот же модуль
mail.py, синхронный маршрут - Документация FastAPI
- Документация API Mailexam
Лицензия
Apache 2.0