benschubert.infrastructure.mailpit_test_gateway role – Setup a Mailpit STMP gateway

Note

This role is part of the benschubert.infrastructure collection (version 0.0.1).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it use: ansible-galaxy collection install benschubert.infrastructure.

To use it in a playbook, specify: benschubert.infrastructure.mailpit_test_gateway.

Entry point main – Setup a Mailpit STMP gateway

Synopsis

  • This allow setting up a Mailpit SMTP Gateway, to allow testing the setup without actually sending emails

  • Note that this is for testing only, and is not meant to be used in production.

  • It will be possible to see the emails that would have been sent when connecting to mailpit_test_gateway_mailpit_hostname

Parameters

Parameter

Comments

ingress_https_port

integer

The port at which the service is exposed via the ingress, in order to be able to make API calls to the service

Default: 443

mailpit_test_gateway_allowlisted_groups

list / elements=string

A list of groups to restrict Mailpit to.

Users not in any of the specified groups won’t be able to see or login to Mailpit.

null or [] doesn’t restrict the access.

mailpit_test_gateway_mailpit_hostname

string / required

The hostname at which to expose the Mailpit web UI

mailpit_test_gateway_networks

list / elements=string / required

The list of networks that the gateway should be attached to

mailpit_test_gateway_smtp_password

string / required

The password used to authenticate against the SMTP gateway

mailpit_test_gateway_smtp_username

string / required

The username used to authenticate against the SMTP gateway