Back to Lego

Mail-in-a-Box

docs/content/dns/zz_gen_mailinabox.md

4.35.21.8 KB
Original Source
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- providers/dns/mailinabox/mailinabox.toml --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->

Configuration for Mail-in-a-Box.

<!--more-->
  • Code: mailinabox
  • Since: v4.16.0

Here is an example bash command using the Mail-in-a-Box provider:

bash
[email protected] \
MAILINABOX_PASSWORD=yyyy \
MAILINABOX_BASE_URL=https://box.example.com \
lego --dns mailinabox -d '*.example.com' -d example.com run

Credentials

Environment Variable NameDescription
MAILINABOX_BASE_URLBase API URL (ex: https://box.example.com)
MAILINABOX_EMAILUser email
MAILINABOX_PASSWORDUser password

The environment variable names can be suffixed by _FILE to reference a file instead of a value. More information [here]({{% ref "dns#configuration-and-credentials" %}}).

Additional Configuration

Environment Variable NameDescription
MAILINABOX_HTTP_TIMEOUTAPI request timeout in seconds (Default: 30)
MAILINABOX_POLLING_INTERVALTime between DNS propagation check in seconds (Default: 4)
MAILINABOX_PROPAGATION_TIMEOUTMaximum waiting time for DNS propagation in seconds (Default: 120)

The environment variable names can be suffixed by _FILE to reference a file instead of a value. More information [here]({{% ref "dns#configuration-and-credentials" %}}).

More information

<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> <!-- providers/dns/mailinabox/mailinabox.toml --> <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->