Skip to content

Commit cec43bc

Browse files
bene2k1Laure-di
bene2k1
authored and
Laure-di
committed
feat(tem): add domain autoconfiguration (scaleway#3824)
1 parent f8ef350 commit cec43bc

File tree

4 files changed

+96
-13
lines changed

4 files changed

+96
-13
lines changed

‎faq/transactional-email.mdx‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,14 @@ After configuring your SPF and DKIM records, you must launch a verification of t
3535

3636
Setting up an [MX record](/managed-services/transactional-email/concepts#mx-record) is highly recommended to ensure your email deliverability. Find out [how to add an MX record to your domain](/managed-services/transactional-email/how-to/add-mx-record-to-your-domain/#how-to-add-your-own-mx-record). You can also [use Scaleway's blackhole MX](/managed-services/transactional-email/how-to/add-mx-record-to-your-domain/#how-to-add-scaleway's-mx-record) if you do not have your own MX.
3737

38+
## What happens to automatically configured DNS records when I delete a domain in the Transactional Email service?
39+
40+
When a domain is removed from Scalway's Transactional Email platform, [autoconfigured DNS records](/managed-services/transactional-email/how-to/autoconfigure-domain/) are not automatically deleted in the Domains & DNS section. If you no longer use the domain for sending emails, you must manually delete or modify these records. It is recommended to verify the associated DNS records to ensure they are correctly configured or removed.
41+
42+
## What is the impact on the Transactional Email service if a DNS zone is deleted in Scaleway Domains & DNS?
43+
44+
If a DNS zone is deleted while [autoconfig is enabled]((/managed-services/transactional-email/how-to/autoconfigure-domain/)), the DNS records will be added to the parent zone. This ensures that the domain remains validated on the Transactional Email platform, allowing continued use of the service without interruption.
45+
3846
## What are the limitations and restrictions when using Transactional Email?
3947

4048
Find out about [limits and quotas](/managed-services/transactional-email/reference-content/tem-capabilities-and-limits/) available for Transactional Email. If you want to increase your quota beyond the values shown on this page, [contact our support team](https://console.scaleway.com/support/create).

‎managed-services/transactional-email/how-to/autoconfigure-domain.mdx‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
meta:
3+
title: How to autoconfigure a Scaleway domain with Transactional Email
4+
description: This page provides instructions how to automatically configure the required DNS records on your domain with Transactional Email.
5+
content:
6+
h1: How to autoconfigure a Scaleway domain with Transactional Email
7+
paragraph: This page provides instructions how to automatically configure the required DNS records on your domain with Transactional Email.
8+
tags: autoconfiguration autoconfig domain dns spf spf-record dkim dkim-records transactional
9+
dates:
10+
validation: 2024-10-11
11+
posted: 2024-10-11
12+
categories:
13+
- managed-services
14+
---
15+
16+
With Scaleway domains, you can now benefit from automatic DNS record creation and updates (autoconfiguration) for domains already registered with the Transactional Email service.
17+
Automatic configuration of your DNS zone streamlines the setup of your domain for Transactional Email, allowing you to focus on sending emails and tracking traffic without manual configuration delays.
18+
19+
You can enable autoconfiguration directly from the Scaleway console (see instructions below), through the [Transactional Email API](https://www.scaleway.com/en/developers/api/transactional-email/#path-domains-register-a-domain-in-a-project), or via [Terraform](https://github.com/scaleway/terraform-provider-scaleway/blob/master/docs/data-sources/tem_domain.md) using the `autoconfig` parameter (`bool`).
20+
21+
<Message type="note">
22+
This documentation covers the use of DNS autoconfiguration for domains already registerd with Transactional Email. If you want to add a new domain, refer to [How to configure your sending domain with Transactional Email](/managed-services/transactional-email/how-to/configure-domain-with-transactional-email/).
23+
</Message>
24+
25+
<Macro id="requirements" />
26+
27+
- A Scaleway account logged into the [console](https://console.scaleway.com)
28+
- [Owner](/identity-and-access-management/iam/concepts/#owner) status or [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allowing you to perform actions in the intended Organization
29+
- A domain name registered with [Scaleway Domains and DNS](/network/domains-and-dns/)
30+
31+
## How to enable DNS autoconfiguration
32+
33+
1. Click **Transactional Email** in the **Managed Services** section of the [console](https://console.scaleway.com/) side menu. The **Transactional Email** overview page displays.
34+
2. Click the domain you want to configure. The Transactional Email dashboard for the domain displays.
35+
3. Click the **DNS Verification** tab.
36+
4. Navigate to the **Autoconfiguration** section of the page, then click **Enable autoconfigration**. A pop-up displays.
37+
5. Confirm by clicking **Enable autoconfiguration** in the pop-up. The DNS zone of your domain will be updated with SPF, DKIM, DMARC and MX records.
38+
<Message type="tip">
39+
During the autoconfiguration process, a blue dot appears next to your domain to indicate the status. Once the configuration is complete, the dot will turn green.
40+
</Message>
41+
42+
## How to disable DNS autoconfiguration
43+
44+
1. Click **Transactional Email** in the **Managed Services** section of the [console](https://console.scaleway.com/) side menu. The **Transactional Email** overview page displays.
45+
2. Click the domain you want to configure. The Transactional Email dashobard for the domain displays.
46+
3. Click the **DNS Verification** tab.
47+
4. Navigate to the **Autoconfiguration** section of the page, then click **Disable autoconfigration**. A pop-up displays.
48+
5. Type **DISABLE** and click **Disable autoconfiguation** to disable the automatic configuration of the DNS.
49+
50+
<Message type="note">
51+
- If you disable autoconfig, you have to **manually manage** DNS records (SPF, DKIM, MX, DMARC).
52+
- **Existing DNS records are not deleted**. Disabling autoconfig does not remove the previously created DNS records. They will remain in place until manually modified or deleted. You can configure multiple mail servers or providers, which requires a single SPF and DMARC record for different domains. Therefore, the records are not automatically removed.
53+
</Message>
54+

‎managed-services/transactional-email/how-to/configure-domain-with-transactional-email.mdx‎

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: Guide to configuring your domain for Scaleway Transactional Email.
88
tags: transactional sending-domain sending domain managed-services
99
dates:
10-
validation: 2024-06-26
10+
validation: 2024-10-11
1111
posted: 2022-11-07
1212
categories:
1313
- managed-services
@@ -21,13 +21,30 @@ This page shows you how to configure your sending domain to start sending [trans
2121
- [Owner](/identity-and-access-management/iam/concepts/#owner) status or [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allowing you to perform actions in the intended Organization
2222
- A domain name
2323

24+
## Automatic configuration for a Scaleway domain
25+
26+
When you use a domain name registered with [Scaleway Domains and DNS](/network/domains-and-dns/), you can benefit from DNS autoconfiguration. We can automatically configure SPF, DKIM, DMARC, MX on your behalf so
27+
your domain name can be validated automatically and you can focus on sending emails and observing the reputation status of your domain.
28+
29+
1. Click **Transactional Email** in the **Managed Services** section of the [console](https://console.scaleway.com/) side menu. The **Transactional Email** overview page displays.
30+
2. Click **Add domain**. The domain creation wizard displays.
31+
3. Add your domain. Select **Use Scaleway domain** and choose your Scaleway domain from the drop down list.
32+
4. Optionally, tick the checkbox **Add a domain prefix** to configure a subdomain for use with the Transactional Email service.
33+
4. Tick the checkbox **Configure my Transactional Email DNS records automatically**.
34+
5. Tick the checkbox to confirm that you agree to Scaleway's antispam policy, then click **Validate domain name** to confirm.
35+
36+
## Manual configuration for an external domain
37+
38+
If your domain is registered with an external registrar, you can use it with the Transactional Email service by configuring the required DNS records manually.
39+
Validation time of domain ownership may be extended.
40+
2441
1. Click **Transactional Email** in the **Managed Services** section of the [console](https://console.scaleway.com/) side menu. The **Transactional Email** overview page displays.
25-
2. Click **Add domain**.
42+
2. Click **Add domain**. The domain creation wizard displays.
2643
3. Enter the domain name you want to use with Transactional Email.
27-
4. Click **Validate domain name** to confirm.
44+
4. Tick the checkbox to confirm that you agree to Scaleway's antispam policy, then click **Validate domain name** to confirm.
2845

2946
<Message type="important">
30-
You need to configure your [SPF](/managed-services/transactional-email/concepts/#spf-record), [DKIM](/managed-services/transactional-email/concepts/#dkim-record) and [MX](/managed-services/transactional-email/concepts/#mx-record) records to verify your domain and to be able to send emails.
47+
For external domains, you need to configure your [SPF](/managed-services/transactional-email/concepts/#spf-record), [DKIM](/managed-services/transactional-email/concepts/#dkim-record) and [MX](/managed-services/transactional-email/concepts/#mx-record) records **manually** to verify your domain and to be able to send emails.
3148
</Message>
3249

3350

‎menu/navigation.json‎

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2372,6 +2372,10 @@
23722372
"label": "Configure your domain with Transactional Email",
23732373
"slug": "configure-domain-with-transactional-email"
23742374
},
2375+
{
2376+
"label": "Autoconfigure a Scaleway domain with Transactional Email",
2377+
"slug": "autoconfigure-domain"
2378+
},
23752379
{
23762380
"label": "Add SPF and DKIM records to your domain",
23772381
"slug": "add-spf-dkim-records-to-your-domain"
@@ -2930,15 +2934,15 @@
29302934
"slug": "api-cli"
29312935
},
29322936
{
2933-
"items": [
2934-
{
2935-
"label": "Public connectivity: best practices",
2936-
"slug": "public-connectivity-best-practices"
2937-
}
2938-
],
2939-
"label": "Additional Content",
2940-
"slug": "reference-content"
2941-
}
2937+
"items": [
2938+
{
2939+
"label": "Public connectivity: best practices",
2940+
"slug": "public-connectivity-best-practices"
2941+
}
2942+
],
2943+
"label": "Additional Content",
2944+
"slug": "reference-content"
2945+
}
29422946
],
29432947
"label": "IPAM",
29442948
"slug": "ipam"

0 commit comments

Comments
 (0)