Руководство по настройке сервиса Mailpit в ServBay

ServBay интегрирует пакет Mailpit, предоставляя удобный локальный почтовый сервер, специально предназначенный для тестирования и отладки функций отправки электронных писем приложениями. В этом руководстве подробно описано, как установить, включить и настроить пакет Mailpit в ServBay, включая четыре основные вкладки конфигурации: Common, SMTP, POP3 и Relay.

Обзор пакета Mailpit

Mailpit — это бесплатный инструмент с открытым исходным кодом, предоставляющий легкий в использовании локальный SMTP/POP3 сервер и интуитивно понятный веб-интерфейс. Он перехватывает все письма, отправленные вашим приложением, позволяя просматривать их содержимое, заголовки, вложения и другую информацию в одном месте, без необходимости отправлять тестовые письма в реальные почтовые ящики. Это значительно упрощает процесс разработки и отладки, особенно при реализации таких функций, как регистрация пользователя, восстановление пароля и отправка уведомлений.

В ServBay Mailpit интегрирован как основной программный пакет, который легко установить и управлять им. Благодаря мощной системе PKI в ServBay, SSL/TLS автоматически настраиваются для безопасного окружения тестирования.

Установка и активация пакета Mailpit

Перед тем, как использовать Mailpit как локальный почтовый сервер, необходимо установить и активировать пакет Mailpit через ServBay.

1. Откройте приложение ServBay.
2. В левой навигационной панели выберите раздел Пакеты.
3. В списке пакетов найдите категорию Общие сервисы.
4. Найдите пакет Mailpit.
5. Если Mailpit ещё не установлен, нажмите зелёную кнопку установки справа для его инсталляции.
6. После завершения установки нажмите переключатель рядом, чтобы включить пакет Mailpit.

Благодаря мощной системе PKI ServBay автоматически сгенерирует и настроит необходимые SSL-сертификаты для веб-интерфейса Mailpit, а также для SMTP и POP3 сервисов. Это означает, что вы можете сразу включить шифрование STARTTLS или SSL/TLS без необходимости вручную получать или настраивать сертификаты.

Веб-интерфейс управления почтой

Mailpit поставляется с мощным веб-интерфейсом для просмотра и управления перехваченными письмами. В ServBay этот интерфейс уже настроен, и после включения пакета вы сможете получить к нему доступ прямо из браузера:

Адрес для доступа: https://mail.servbay.host

В этом интерфейсе вы сможете легко просматривать список полученных писем, видеть подробную информацию о каждом письме (HTML, обычный текст, исходный код), искать или удалять письма и многое другое.

Настройка пакета Mailpit

ServBay предлагает графический интерфейс для настройки всех параметров Mailpit. В левой навигационной панели ServBay выберите Mail, а затем перейдите в раздел Mailpit Service Config. Вы увидите четыре основные вкладки настроек: Common, SMTP, POP3 и Relay.

1. Вкладка Common

Вкладка Common используется для задания базовых параметров и поведения Mailpit:

• Max Messages: Ограничение максимального количества писем, которые Mailpit может хранить. Если количество писем превышает заданный лимит, самые старые письма будут удаляться автоматически.
• Max Age: Максимальное время хранения писем на сервере Mailpit в днях. Письма, превышающие указанный срок, автоматически удаляются.
• SpamAssassin: Включение или отключение фильтрации спама через SpamAssassin. Если включено, Mailpit будет пытаться помечать поступающие письма как спам.
• Webhook URL: Указание Webhook-адреса. При получении нового письма Mailpit будет отправлять HTTP POST-запрос на этот URL, уведомляя внешние системы. Особенно полезно для интеграции с автоматизированными тестами или системами оповещения.
• Webhook Limit: Максимальное количество писем, о которых будут отправляться уведомления через Webhook.

2. Вкладка SMTP

TIP

Благодаря мощной PKI системе ServBay, SSL-сертификаты уже сгенерированы и настроены по умолчанию. Вы можете сразу включить шифрование через STARTTLS или SSL/TLS — дополнительное получение и настройка сертификатов не требуется.

Вкладка SMTP предназначена для настройки параметров SMTP сервера Mailpit. Ваше приложение будет подключаться к этому серверу для отправки тестовых писем:

• SMTP Port: Порт, на котором SMTP-сервер Mailpit слушает подключения. Укажите этот порт в настройках отправки почты вашего приложения (127.0.0.1 или localhost). По умолчанию — 1025.
• STARTTLS: Включение или отключение шифрования STARTTLS. Позволяет обновлять нешифрованное соединение на защищённое после его установления.
• SSL/TLS: Включение или отключение SSL/TLS. В этом случае защищённое соединение устанавливается сразу при подключении.
• Username: Имя пользователя для SMTP-сервера (необязательно). Если указано — ваше приложение должно использовать его для аутентификации при отправке сообщений.
• Password: Пароль к SMTP-серверу (необязательно). Используется вместе с Username для аутентификации.
• Max Recipients: Максимальное число получателей для одного письма, чтобы предотвратить массовую рассылку.
• Allowed Recipients: Разрешённые адреса или домены получателей (необязательно). Если поле пустое — сообщения принимаются для любых адресатов. Если заполнено — принимаются только письма для указанных адресов или доменов.

3. Вкладка POP3

TIP

Благодаря мощной PKI системе ServBay, SSL-сертификаты уже настроены. Вы можете сразу активировать SSL/TLS для защищенного соединения — дополнительная настройка не требуется.

Вкладка POP3 отвечает за параметры POP3 сервера Mailpit. Если вам нужно протестировать получение писем в вашем приложении — настройте почтовый клиент на подключение к этому серверу:

• Enable POP3 Server: Включение или отключение функции POP3-сервера Mailpit.
• POP3 Server Port: Порт, на котором POP3-сервер слушает подключения. По умолчанию — 1110.
• Username: Имя пользователя для POP3-сервера (необязательно). Если указано, клиент должен пройти аутентификацию.
• Password: Пароль для POP3-сервера (необязательно). Используется вместе с Username.
• SSL/TLS: Включение или отключение SSL/TLS для защищённого подключения.

4. Вкладка Relay

Вкладка Relay позволяет настроить пересылку писем из Mailpit на внешний SMTP-сервер, чтобы выбранные или все сообщения автоматически ретранслировались на реальную почтовую систему:

• Enable SMTP Relay: Включение/выключение функции отправки писем через внешний SMTP (релэй).
• Host: Адрес внешнего SMTP-сервера для пересылки сообщений (например, smtp.gmail.com, smtp.sendgrid.net).
• Port: Порт внешнего SMTP-сервера для отправки (обычно 25 — стандартный SMTP, 465 — SMTPS, или 587 — Submission).
• STARTTLS: Включение или отключение защищённого соединения по протоколу STARTTLS с внешним SMTP-сервером.
• Allow Insecure: Разрешить подключение к SMTP серверам с недоверенными сертификатами (не рекомендуется для продакшн-окружений).
• Auth: Метод аутентификации с внешним SMTP-сервером. Обычно выбирается один из: Login (логин и пароль), Plain (аналогично Login), либо CRAM-MD5 (механизм challenge/response).
• Username: Имя пользователя для внешнего SMTP.
• Password: Пароль для внешнего SMTP.
• Return Path: Адрес для возврата недоставленных писем (заголовок Return-Path).
• Allowed Recipients: Разрешённые адреса и домены для пересылаемых писем (необязательно).
• Blocked Recipients: Заблокированные адреса и домены для пересылаемых писем (необязательно).
• Relay All: Если включено, Mailpit попытается переслать все перехваченные письма (с учетом Allowed/Blocked Recipients).
• Relay Matching: Если включено, Mailpit будет пересылать только письма, удовлетворяющие правилам Allowed или Blocked Recipients.

Сохранение настроек

После внесения изменений в настройку Mailpit обязательно нажмите кнопку Save внизу страницы для сохранения параметров.

Кнопка Reset восстановит все параметры до значений по умолчанию.

Часто задаваемые вопросы (FAQ)

• В: Почему письма, отправленные моим приложением, не появляются в Mailpit?
  • О: Проверьте настройки отправки почты в вашем приложении (обычно это SMTP-хост и порт), чтобы они указывали на адрес, где работает Mailpit в ServBay (127.0.0.1 или localhost) и порт SMTP, указанный в настройках Mailpit (по умолчанию 1025). Также убедитесь, что пакет Mailpit запущен через список пакетов ServBay.
• В: Нужно ли вручную настраивать SSL-сертификат для Mailpit?
  • О: Нет, не нужно. Благодаря системе PKI ServBay необходимые сертификаты для веб-интерфейса, SMTP и POP3 (STARTTLS/SSL/TLS) создаются и настраиваются автоматически. Просто включите нужный тип шифрования в нужной вкладке.
• В: Какой логин и пароль используются по умолчанию для веб-интерфейса Mailpit?
  • О: По умолчанию для доступа к веб-интерфейсу Mailpit по адресу https://mail.servbay.host вводить логин и пароль не требуется. Для SMTP и POP3 сервисов аутентификация также по умолчанию отключена. Если хотите требовать авторизацию — укажите имя пользователя и пароль в соответствующей вкладке настроек.

Резюме

С помощью интегрированного пакета Mailpit в ServBay вы легко организуете локальную среду для тестирования электронной почты. Гибко настраиваемые параметры SMTP, POP3 и Relay в совокупности с интуитивным веб-интерфейсом значительно повысят эффективность и удобство работы с почтовым функционалом в процессе разработки.

Помните: после изменения конфигурации может понадобиться перезапустить Mailpit, чтобы применить новые настройки. Вы можете сделать это через интерфейс управления пакетами ServBay, выбрав Mailpit и нажав соответствующую кнопку перезапуска.