Guide de configuration du service Mailpit pour ServBay

ServBay intègre le package Mailpit, qui offre un serveur mail local pratique, spécialement conçu pour que les développeurs puissent tester et déboguer l’envoi d’e-mails de leurs applications. Ce guide détaille l’installation, l’activation et la configuration du package Mailpit dans ServBay, incluant les quatre principaux onglets : Common, SMTP, POP3 et Relay.

Présentation du package Mailpit

Mailpit est un outil open source fournissant un serveur SMTP/POP3 local simple à utiliser, ainsi qu’une interface web intuitive. Il capture tous les e-mails envoyés par votre application, vous permettant de consulter le contenu, les en-têtes et les pièces jointes depuis un emplacement centralisé, sans risquer d’envoyer des messages de test dans de vraies boîtes de réception. Cela simplifie considérablement le processus de développement et de débogage, notamment pour la gestion de l’inscription utilisateur, la réinitialisation de mot de passe ou les notifications nécessitant un envoi d’e-mail.

Dans ServBay, Mailpit est intégré comme package principal. Son installation et sa gestion sont aisées, et vous profitez de l’intégration du système PKI puissant de ServBay permettant la configuration automatique des certificats SSL/TLS pour assurer un environnement de test sécurisé.

Installation et activation du package Mailpit

Avant de pouvoir utiliser Mailpit comme serveur mail local, vous devez d’abord installer et activer le package Mailpit dans ServBay.

1. Ouvrez l’application ServBay.
2. Dans la barre de navigation à gauche, sélectionnez Packages.
3. Dans la liste des packages, trouvez la catégorie Services généraux.
4. Recherchez le package Mailpit.
5. Si Mailpit n’est pas encore installé, cliquez sur le bouton vert d’installation à droite pour procéder à l’installation.
6. Une fois l’installation terminée, cliquez sur l’interrupteur à côté pour activer le package Mailpit.

Grâce au puissant système PKI de ServBay, les certificats SSL nécessaires sont générés et configurés automatiquement pour l’interface d’administration web de Mailpit ainsi que pour les services SMTP et POP3. Vous pouvez ainsi activer le chiffrement STARTTLS ou SSL/TLS immédiatement, sans avoir à demander ou configurer manuellement des certificats.

Interface web de gestion des e-mails

Mailpit inclut une interface web puissante permettant de visualiser et de gérer tous les e-mails capturés. La configuration est automatique avec ServBay : dès l’activation du package Mailpit, accédez à l’interface simplement depuis votre navigateur à l’adresse :

Adresse : https://mail.servbay.host

Depuis cette interface, vous pouvez parcourir la liste des e-mails reçus, consulter le détail d’un message individuel (incluant les versions HTML, texte brut et source), rechercher des e-mails et supprimer des messages.

Configuration du package Mailpit

ServBay offre une interface graphique pour paramétrer les différents réglages de Mailpit. Dans la barre latérale de ServBay, sélectionnez Mail, puis cliquez sur Mailpit Service Config pour accéder à la page de configuration. Quatre onglets principaux sont proposés : Common, SMTP, POP3 et Relay.

1. Onglet Common

L’onglet Common sert à définir les réglages et comportements généraux de Mailpit :

• Max Messages : Détermine le nombre maximal d’e-mails que Mailpit gardera en mémoire. Au-delà de cette limite, les messages les plus anciens sont automatiquement supprimés.
• Max Age : Définit la durée maximale (en jours) de conservation des e-mails sur le serveur Mailpit. Passé ce délai, les messages sont supprimés.
• SpamAssassin : Active ou désactive le filtrage antispam via SpamAssassin. Si activé, Mailpit tentera de marquer les e-mails reçus comme spam si nécessaire.
• Webhook URL : Permet de renseigner une URL de webhook. À chaque réception d’un nouvel e-mail, Mailpit envoie une requête HTTP POST à cette URL pour notifier des systèmes ou services externes, idéal pour l’intégration avec des tests automatisés ou des systèmes d’alerte.
• Webhook Limit : Définit la limite du nombre de notifications d’e-mails envoyées via le webhook.

2. Onglet SMTP

TIP

Grâce à l’intégration PKI avancée de ServBay, les certificats SSL sont générés et déjà configurés. Vous pouvez activer directement le chiffrement STARTTLS ou SSL/TLS, sans avoir à solliciter ou configurer des certificats supplémentaires.

L’onglet SMTP sert à configurer le serveur SMTP de Mailpit. Votre application devra se connecter à ce serveur SMTP pour envoyer les e-mails de test :

• SMTP Port : Indique le port d’écoute du serveur SMTP de Mailpit. Votre application doit envoyer les e-mails vers ce port sur 127.0.0.1 ou localhost. Le port par défaut est 1025.
• STARTTLS : Active ou désactive le cryptage STARTTLS. Cette option permet de passer d’une connexion claire à une connexion chiffrée, après l’établissement initial.
• SSL/TLS : Active ou désactive le chiffrement SSL/TLS immédiatement à la connexion.
• Username : Spécifie le nom d’utilisateur du serveur SMTP (optionnel). Si défini, l’application devra fournir ce nom d’utilisateur pour s’authentifier à l’envoi d’e-mails.
• Password : Mot de passe pour le serveur SMTP (optionnel), à utiliser avec le nom d’utilisateur.
• Max Recipients : Nombre maximum de destinataires autorisés par e-mail, pour éviter d’envoyer une même copie à trop d’adresses.
• Allowed Recipients : Liste des adresses ou domaines autorisés à recevoir des e-mails (optionnel). Si vide, Mailpit accepte tous les destinataires. Si renseigné, seuls les e-mails envoyés vers les adresses ou domaines de la liste seront acceptés.

3. Onglet POP3

TIP

Grâce à PKI, ServBay fournit et configure automatiquement les certificats SSL nécessaires. Vous pouvez utiliser le chiffrement SSL/TLS pour sécuriser la connexion POP3, sans gestion supplémentaire de certificats.

L’onglet POP3 permet de paramétrer le serveur POP3 de Mailpit. Si vous souhaitez tester la réception d’e-mails par votre application, configurez votre client pour se connecter à ce serveur :

• Enable POP3 Server : Active/désactive la fonctionnalité POP3 de Mailpit.
• POP3 Server Port : Définit le port d’écoute du serveur POP3, par défaut 1110.
• Username : Nom d’utilisateur du serveur POP3 (optionnel). Si défini, l’authentification est demandée à la connexion.
• Password : Mot de passe associé pour l’authentification POP3 (optionnel).
• SSL/TLS : Active ou désactive le chiffrement SSL/TLS lors de la connexion.

4. Onglet Relay

L’onglet Relay permet de paramétrer le transfert d’e-mails capturés vers un vrai serveur SMTP externe. Vous pouvez ainsi relayer certains ou tous vos courriels capturés :

• Enable SMTP Relay : Active ou désactive la fonction de relais SMTP.
• Host : Adresse du serveur SMTP externe de relais (exemple : smtp.gmail.com, smtp.sendgrid.net).
• Port : Port du serveur SMTP externe pour le relais, valeurs typiques : 25 (SMTP standard), 465 (SMTPS), 587 (submission).
• STARTTLS : Active ou non le chiffrement STARTTLS pour la connexion de relais.
• Allow Insecure : Autorise la connexion à des serveurs SMTP de relais avec certificat non fiable (déconseillé en production).
• Auth : Sélectionne la méthode d’authentification avec le serveur relais : Login (nom d’utilisateur/mot de passe), Plain (similaire à Login), ou CRAM-MD5 (authentification par défi/réponse).
• Username : Nom d’utilisateur pour l’authentification relais SMTP.
• Password : Mot de passe pour le relais SMTP.
• Return Path : Spécifie l’adresse de retour (en-tête Return-Path) des e-mails relayés.
• Allowed Recipients : Liste (optionnelle) d’adresses ou domaines autorisés pour le relais.
• Blocked Recipients : Liste (optionnelle) d’adresses ou domaines à bloquer pour le relais.
• Relay All : Si activé, Mailpit tentera de relayer tous les e-mails capturés (dans la limite des Allowed/Blocked Recipients).
• Relay Matching : Si coché, seuls les e-mails correspondant aux critères Allowed Recipients ou Blocked Recipients seront relayés.

Sauvegarde de la configuration

Après toute modification de la configuration Mailpit, veillez à cliquer sur le bouton Save en bas de l’interface pour sauvegarder les réglages.

Le bouton Reset permet de rétablir tous les paramètres par défaut de Mailpit.

Foire aux questions (FAQ)

• Q : Pourquoi les e-mails envoyés par mon application n’apparaissent-ils pas dans Mailpit ?
  • R : Vérifiez la configuration d’e-mailing (généralement le serveur SMTP et le port) de votre application. Elle doit pointer vers l’adresse sur laquelle Mailpit fonctionne via ServBay (127.0.0.1 ou localhost) et le port SMTP indiqué dans votre configuration Mailpit (par défaut : 1025). Assurez-vous également que le package Mailpit est bien démarré dans ServBay, le statut peut être vérifié dans la liste des packages de ServBay.
• Q : Dois-je configurer un certificat SSL pour Mailpit ?
  • R : Non, cela n’est pas nécessaire. ServBay, grâce à son système PKI, génère et configure automatiquement les certificats nécessaires pour l’interface web, le SMTP et le POP3 (STARTTLS/SSL/TLS) de Mailpit. Il vous suffit simplement d’activer l’option de chiffrement désirée dans les onglets de configuration correspondants.
• Q : Quel est le nom d’utilisateur et mot de passe par défaut pour l’interface web Mailpit ?
  • R : Par défaut, l’interface web est accessible via https://mail.servbay.host sans besoin d’authentification. Les services SMTP et POP3, eux aussi, n’exigent pas d’authentification par défaut. Si vous souhaitez exiger une authentification sur SMTP ou POP3, renseignez simplement un nom d’utilisateur et un mot de passe dans les onglets de configuration concernés.

Résumé

Grâce à l’intégration de Mailpit dans ServBay, vous créez facilement un environnement local pour tester les fonctionnalités e-mail. En configurant les paramètres SMTP, POP3 et Relay au sein de Mailpit, et via son interface web intuitive, vous optimisez considérablement l’efficacité, la rapidité et la convivialité de la gestion des e-mails lors du développement.

Notez qu’après modification de la configuration, un redémarrage du package Mailpit peut être nécessaire pour appliquer les changements. Vous pouvez retrouver Mailpit dans la gestion des packages de ServBay et cliquer sur le bouton de redémarrage.