diff --git a/source/_components/mailgun.markdown b/source/_components/mailgun.markdown index e1ecaefc72a..f503449ed2c 100644 --- a/source/_components/mailgun.markdown +++ b/source/_components/mailgun.markdown @@ -27,8 +27,18 @@ mailgun: api_key: XXXXXXXXXXXXX ``` -Configuration variables: - -- **domain** (*Required*): This is the domain name to be used when sending out mail. Defaults to the first custom domain you have set up. -- **api_key** (*Required*): This is the API token that has been generated in your Mailgun account. -- **sandbox** (*Deprecated*): Whether to use the sandboxed domain for outgoing mail. Since the `domain` item is required, it should be set to the sandbox domain name, so this isn't needed. Defaults to `False`. +{% configuration %} +domain: + description: This is the domain name to be used when sending out mail. Needs to be the first custom domain you have set up. + required: true + type: string +api_key: + description: This is the API token that has been generated in your Mailgun account. + required: true + type: string +sandbox: + description: "(**Deprecated**) Whether to use the sandboxed domain for outgoing mail. Since the `domain` item is required, it should be set to the sandbox domain name, so this isn't needed." + required: false + default: false + type: boolean +{% endconfiguration %} diff --git a/source/_components/notify.mailgun.markdown b/source/_components/notify.mailgun.markdown index 93695c7e458..5ddfdcb5efa 100644 --- a/source/_components/notify.mailgun.markdown +++ b/source/_components/notify.mailgun.markdown @@ -30,13 +30,30 @@ notify: recipient: me@example.com ``` -Configuration variables: - -- **domain** (*Required*): This is the domain name to be used when sending out mail. -- **sandbox** (*Deprecated*): If a sandboxed domain is used, specify it in `domain`. Defaults to `False`. -- **api_key** (*Required*): This is the API Key that has been generated in your Mailgun account. -- **recipient** (*Required*): The email address of the recipient. -- **sender** (*Optional*): The sender's email address. Defaults to `hass@DOMAIN`, where `DOMAIN` is the outgoing mail domain, as defined by the `domain` configuration entry. +{% configuration %} +domain: + description: This is the domain name to be used when sending out mail. + required: true + type: string +sandbox: + description: "(**Deprecated**) If a sandboxed domain is used, specify it in `domain`." + required: false + default: false + type: boolean +api_key: + description: This is the API Key that has been generated in your Mailgun account. + required: true + type: string +recipient: + description: The email address of the recipient. + required: true + type: string +sender: + description: The sender's email address. + required: false + default: "`hass@DOMAIN`, where `DOMAIN` is the outgoing mail domain, as defined by the `domain` configuration entry." + type: string +{% endconfiguration %} ## {% linkable_title Example automation %}