ipsedixit-org / dev-mailserver

This repository is mirrored from https://gitlab.com/ipsedixit-org/dev-mailserver . Running a mailserver for testing mail during development.

dev-mailserver

Running a mailserver for testing mail during development. The main purposes of a dev mailserver are to be able to:

• send/receive email via SMTP and IMAP services (container mailserver)
• read email using an UI that allow show HTML and attachments (container roundcube)
• send email to a remote SMTP server (container example-sender)

Start up

docker-compose up --build

Read email

To read email connect using your preffered browser to: http://localhost:8000

Login: [e-mail] Password: password

How it works

There are three containers each one has one specific role.

mailserver

Container that use as a base docker-mailserver in order to:

• SMTP daemon: send and receive email
• IMAP daemon: read email from UI (container roundcube)

Others services are disable using environment variables (see also docker-mailserver example ).

Two users are created when docker container start:

• [e-mail]: account that receive email. The password for this account is: password
• [e-mail]: account that send email, from container example-sender. The password for this account is: password

UI - roundcube

Roundcube is a browser-based multilingual IMAP client with an application-like user interface. The reason to use roundcube over the alternatives, such as squirrel, are:

• easy to use via browser
• available image in dockerhub
• easy to configure, just two environment variables

In this project roundcube connect via IMAP to mailserver.

example-sender

Starting from Ubuntu image is created a container that send an email from [e-mail] to [e-mail] every 30 seconds, sending email is done in entrypoint.sh.

In order to send email is used SSMTP a program that send mail via the departmental mailhub, using different protocol. In this project departmental mailhub is mailserver container via SMTP.

This project use SSMTP instead of sendmail because it is already configured a mailserver so it is not required to start also a mail daemon in example-sender. The flow to send email is:

                            ┌───────────────────────┐
                            │ MAILSERVER CONTAINER  │
┌───────┐    ┌───────┐      │ ┌────────┐            │
│ mailx ├────► SSMTP ├──────┼─►SMTP    │            │
└───────┘    └───────┘      │ └────────┘            │
                            │                       │
                            └───────────────────────┘

• mailx: is just a "Front End" for sending an email, it prepare the request to mail user agent configured in the server
• SSMTP: called by Operating System receive the request prepared from mailx and connect via SMTP to mailserver container
• Mailserver container: receive request from SSMTP, validate credential and deliver the email