Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(tem): scale plan MTA-5622 #4576

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion faq/transactional-email.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,4 +57,25 @@ Check out our [dedicated page](https://www.scaleway.com/en/pricing/?tags=managed
Yes, you can manually unblock any address, even if it is still under the temporary block period. You can unblock up to five addresses every 24 hours.

## What happens if an address on a TEM blocklist becomes valid again?
You can manually unblock the address. Make sure you confirm that the initial cause of the bounce was resolved before doing so to avoid further issues.
You can manually unblock any addresses. Make sure you confirm that the initial cause of the bounce was resolved before doing so to avoid further issues.

## Can I remove addresses from the blocklist?
Yes, all blocked addresses can be unblocked via the interface. For addresses you added manually, you have full control over when and if they are removed from the blocklist.

## What are the main benefits of the Scale offer?
The Scale offer provides advanced control over email deliverability through a dedicated IP, detailed performance tracking, and advanced webhook management. It is ideal for businesses with high email sending volume requirements.

## What is the difference between a dedicated IP and a shared IP?
A dedicated IP is used exclusively by a single user, allowing for better control over sending reputation. A shared IP is shared among multiple users, which can impact deliverability based on the practices of other senders.

## What happens if my dedicated IP is blacklisted?
TEM can assist in identifying the problem and recommending corrective actions, but the final resolution depends on your sending practices. Therefore, it is essential to follow [best practices for deliverability](/transactional-email/reference-content/understanding-tem-reputation-score/#best-practices-for-domain-reputation-and-deliverability) to avoid this type of situation.

## Can I use both a dedicated IP and a shared IP on the same project?
No, a project using a dedicated IP cannot send emails via a shared IP. If you want to use a shared IP, you must create a separate project.

## Does a dedicated IP include both IPv4 and IPv6?
Yes, each dedicated IP provided with the Scale offer includes both an IPv4 and an IPv6 address. This ensures better compatibility with different email providers and optimizes the deliverability of sent emails.

## Can I add a new dedicated IP to my Organization?
If you want to add a new dedicated IP to your Organization, you must create a new project with the Scale offer or contact support to review your request.
8 changes: 8 additions & 0 deletions menu/navigation.json
Original file line number Diff line number Diff line change
Expand Up @@ -2766,6 +2766,10 @@
"label": "Manage your email activity",
"slug": "manage-email-activity"
},
{
"label": "Monitor Transactional Emails with Cockpit",
"slug": "monitor-transactional-email-cockpit"
},
{
"label": "Generate API keys for API and SMTP sending with IAM",
"slug": "generate-api-keys-for-tem-with-iam"
Expand Down Expand Up @@ -2829,6 +2833,10 @@
{
"label": "Setting up SMTP",
"slug": "smtp-configuration"
},
{
"label": "Understanding managed dedicated IPs",
"slug": "tem-dedicated-ip"
}
],
"label": "Additional Content",
Expand Down
31 changes: 31 additions & 0 deletions pages/transactional-email/how-to/change-tem-plans.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
meta:
title: How to manage TEM plans
description: Guide to managing your TEM plans with Scaleway, including upgrading, downgrading, and monitoring usage.
content:
h1: How to manage TEM plans
paragraph: Step-by-step guide to managing your TEM plans with Scaleway.
tags: tem plans management transactional email
dates:
validation: 2024-03-12
posted: 2024-03-12
categories:
- transactional-email
---

When you configure a domain with Transactional Email in a Project for the first time, you are prompted to select a TEM plan between Essential and Scale.

You can change your selected plan anytime in the Scaleway console.

<Macro id="requirements" />

- A Scaleway account logged into the [console](https://console.scaleway.com)
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
- [Configured your domain(s) with Transactional Email](/transactional-email/how-to/configure-domain-with-transactional-email/)
- Added [SPF, DKIM](/transactional-email/how-to/add-spf-dkim-records-to-your-domain/), [MX](/transactional-email/how-to/add-mx-record-to-your-domain/) and [DMARC](/transactional-email/how-to/add-dmarc-record/) records to your domain(s)



1. Click **Transactional Email** in the **Managed Services** section of the [console](https://console.scaleway.com/) side menu. Your domains display.
2. Click the **Plans** tab.
3. **Cli
Original file line number Diff line number Diff line change
Expand Up @@ -21,30 +21,43 @@ This page shows you how to configure your sending domain to start sending [trans
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
- A domain name

## Automatic configuration for a Scaleway domain

When you use a domain name registered with [Scaleway Domains and DNS](/domains-and-dns/), you can benefit from DNS autoconfiguration. We can automatically configure SPF, DKIM, DMARC, MX on your behalf so
your domain name can be validated automatically and you can focus on sending emails and observing the reputation status of your domain.

1. Click **Transactional Email** in the **Managed Services** section of the [console](https://console.scaleway.com/) side menu. The **Transactional Email** overview page displays.
2. Click **Add domain**. The domain creation wizard displays.
3. Add your domain. Select **Use Scaleway domain** and choose your Scaleway domain from the drop down list.
4. Optionally, tick the checkbox **Add a domain prefix** to configure a subdomain for use with the Transactional Email service.
4. Tick the checkbox **Configure my Transactional Email DNS records automatically**.
5. Tick the checkbox to confirm that you agree to Scaleway's antispam policy, then click **Validate domain name** to confirm.

## Manual configuration for an external domain

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.
Validation time of domain ownership may be extended.

1. Click **Transactional Email** in the **Managed Services** section of the [console](https://console.scaleway.com/) side menu. The **Transactional Email** overview page displays.
2. Click **Add domain**. The domain creation wizard displays.
3. Enter the domain name you want to use with Transactional Email.
4. Tick the checkbox to confirm that you agree to Scaleway's antispam policy, then click **Validate domain name** to confirm.

<Message type="important">
For external domains, you need to configure your [SPF](/transactional-email/concepts/#spf-record), [DKIM](/transactional-email/concepts/#dkim-record), [DMARC](/transactional-email/how-to/add-dmarc-record) and [MX](/transactional-email/concepts/#mx-record) records **manually** to verify your domain and to be able to send emails.
</Message>
2. Click **Select a plan**. The Transactional Email creation wizard displays.
3. Select a plan. Two plans are available:
- **Essential** - pay-as-you-go plan designed for occasional or low-volume email sending needs. This plan offers simplified management and a single webhook per domain.
- **Scale** - fixed-price plan tailored for high-volume email sending. Includes 100K emails. Additional emails are charged. This plan includes a dedicated IP address and unlimited webhooks per domain. It also features advanced blocklist management, allowing for manual additions.
4. Tick the checkbox to confirm that you agree to Scaleway's anti-spam policy, which can be found in the [contracts](https://www.scaleway.com/en/contracts/) section of the Scaleway website.
5. Click **Choose a plan and add a domain**.
6. Select whether to **Use a Scaleway domain** or **Add a domain external to Scaleway**. Follow the next steps according to your choice.
<Tabs id="domain-type">
<TabsTab label="Scaleway domain">
<Message type="tip">
When you use a domain name registered with [Scaleway Domains and DNS](/domains-and-dns/), you can benefit from DNS autoconfiguration. We can automatically configure SPF, DKIM, DMARC, MX on your behalf so your domain name can be validated automatically and you can focus on sending emails and observing the reputation status of your domain.
</Message>
1. Choose your existing Scaleway domain from the drop down list.

<Message type="important">
If you do not have an active domain in your current Project, click **Register a domain** to [register a domain](/domains-and-dns/how-to/register-internal-domain/) with Scaleway Domains and DNS.
</Message>

2. Optionally, tick the checkbox **Add a domain prefix** to configure a subdomain for use with the Transactional Email service.
3. Tick the checkbox **Configure my Transactional Email DNS records automatically**.
4. Review the estimated monthly cost.
5. Click **Validate domain name**.
</TabsTab>
<TabsTab label="External domain">
<Message type="important">
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. Validation time of domain ownership may be extended.
</Message>

1. Enter the domain name you want to use with Transactional Email.
2. Click **Validate domain name**.
<Message type="important">
For external domains, you need to configure your [SPF](/transactional-email/concepts/#spf-record), [DKIM](/transactional-email/concepts/#dkim-record), [DMARC](/transactional-email/how-to/add-dmarc-record) and [MX](/transactional-email/concepts/#mx-record) records **manually** to verify your domain and to be able to send emails.
</Message>

</TabsTab>
</Tabs>


15 changes: 14 additions & 1 deletion pages/transactional-email/how-to/manage-blocklists.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,27 @@ categories:
- managed-services
---

The Transactional Email blocklist feature allows your to manage email addresses that generate errors, or “bounces”. Emails are automatically blocked when a mailbox does not exist, or is full, to prevent sending emails to a recipient address that is not reachable.
The Transactional Email (TEM) blocklist feature allows your to manage email addresses that generate errors, or “bounces”. Emails are automatically blocked when a mailbox does not exist, or is full, to prevent sending emails to a recipient address that is not reachable. You can also add emails to the blocklist manually if you subscribe to the [TEM Scale plan]() and have a Scaleway domain.

<Macro id="requirements" />

- A Scaleway account logged into the [console](https://console.scaleway.com)
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization. For blocklists your can apply the `TransactionalEmailBlocklistFullAccess` permission
- [Configured your domain(s) with Transactional Email](/transactional-email/how-to/configure-domain-with-transactional-email/)

## How to add an email address to the blocklist

You can manually add address to your blocklist in the Scaleway console. When you add an email to the blocklist, it remains blocked indefinitely until you decide to [unblock it](#how-to-unblock-an-email-adress).

<Message type="important">
Manually adding an email address to a domain's blocklist is only available for users who have a Scaleway domain and subscribe to the [TEM Scale plan]() for that domain's Project.
</Message>

1. Click **Transactional Email** in the **Managed Services** section of the [console](https://console.scaleway.com/) side menu. Your domains display.
2. Click the domain for which you want to manage the blocklist. An overview of your domain appears.
3. Click the **Blocklist** tab.
4.

## How to monitor temporary blocklists

If any of your emails bounced, you will see a temporary blocklist entry, with a duration of 48 hours, containing the details of the email that bounced and the reason, or flag. Some examples of bounce reasons are:
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
---
meta:
title: How to monitor your Transactional Email with Scaleway Cockpit
description: Learn how to effectively monitor your Transactional Email using Scaleway Cockpit for optimal deliverability and performance.
content:
h1: How to monitor your Transactional Email with Scaleway Cockpit
paragraph: Learn how to effectively monitor your Transactional Email using Scaleway Cockpit for optimal deliverability and performance.
tags: transactional-email email-deliverability cockpit observability dashboard metrics logs alerts
dates:
validation: 2025-03-05
posted: 2025-03-05
categories:
- transactional-email
---

You can use Scaleway Cockpit to track TEM metrics and monitor email activity, detect potential deliverability issues, and check key indicators to track your domain's reputation.

This page explains how to get started with Scaleway Cockpit for viewing your Transactional Email metrics and logs.

<Macro id="requirements" />

- A Scaleway account logged into the [console](https://console.scaleway.com)
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
- [Configured your domain(s) with Transactional Email](/transactional-email/how-to/configure-domain-with-transactional-email/)
- Added [SPF, DKIM](/transactional-email/how-to/add-spf-dkim-records-to-your-domain/), [MX](/transactional-email/how-to/add-mx-record-to-your-domain/) and [DMARC](/transactional-email/how-to/add-dmarc-record/) records to your domain(s)

## How to activate your Cockpit

Scaleway Cockpit is activated by default if you have created any [Scaleway resources integrated with Cockpit](/cockpit/reference-content/cockpit-limitations/#product-integration-into-cockpit).

## How to access the Grafana dashboard

To view your TEM metrics, use the Grafana dashboard which is accessible from the Scaleway console:
- First, you must create a user and their associated credentials (a username and password) for Grafana
- Then, you can use these credentials to access the Grafana dashboard for all your Scaleway products, via the Scaleway console.

1. Create a Grafana user and retrieve their username and password by [following this procedure](/cockpit/how-to/retrieve-grafana-credentials/).

2. From the Scaleway console [Cockpit overview page](https://console.scaleway.com/cockpit/overview), click **Open dashboards** in the top right corner.

3. Enter your Grafana username and password to log in.

You are directed to the Scaleway Cockpit dashboards homepage.

## How to view and understand your TEM metrics

1. Click **Open dashboards** on the top right from the Scaleway Cockpit dashboards homepage.
2. Click either **TEM Overview** or **TEM Overview**, depending on your engine of choice, on the left side menu.

You are directed to the TEM Overview dashboard.

<Lightbox src="scaleway-grafana-tem.webp" alt="" />

### List of Metrics

Metrics are refreshed every minute, and report on the following data:

<Message type="important">
Metrics on dedicated IPs are only accessible to users that subscribe to the Scale offer.
</Message>

| Category | Metric | Description |
| --- | --- | --- |
| Reputation | Current reputation score | Current reputation score of the domain. |
| Reputation | Reputation score evolution | History and evolution of the reputation score. |
| Email Activity | Global email traffic distribution by IP type | Distribution of email traffic between dedicated and shared IPs. |
| Email Activity | Global email traffic by IP type | Total volume of emails sent, segmented by IP type. |
| Email Activity | Email activity - all IPs | Total number of emails delivered and rejected across all IPs. |
| Email Activity | General activity - all IPs | An overview of email traffic. |
| Email Activity | Email rejected distribution - All IPs | Distribution of rejected emails by rejection type. |
| Errors | Errors activity - all IPs | Main recipient domains of sent emails. |
| Destinations and Rejections | Top recipient destination - all IPs | Main recipient domains of sent emails. |
| Destinations and Rejections | Top bounce recipient - all IPs | List of recipients with the most bounces. |
| Destinations and Rejections | Top fail recipient - all IPs | List of recipients for whom emails consistently failed. |


### Choosing metric parameters

At the top of the dashboard, you can configure the following parameters, that control which metrics are displayed:

- **Datasource** - Select the SCW region for which you want to see the metrics.
- **Domain** - Select the specific domain for which you want to see the metrics
- **Timeframe** - Get metrics from the last five minutes up to 31 days (free plan) and 365 days (premium plan).
13 changes: 9 additions & 4 deletions pages/transactional-email/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,20 @@ In this quickstart, we show you how to configure your domain with Transactional
## How to configure your domain with Transactional Email

1. Click **Transactional Email** in the **Managed Services** section of the [console](https://console.scaleway.com/) side menu. The **Transactional Email** overview page displays.
2. Click **Add domain**.
2. Click **Select a plan**. The Transactional Email creation wizard displays.
3. Select a plan. Two plans are available:
- **Essential** - pay-as-you-go plan designed for occasional or low-volume email sending needs. This plan offers simplified management and a single webhook per domain.
- **Scale** - fixed-price plan tailored for high-volume email sending. Includes 100K emails. Additional emails are charged. This plan includes a dedicated IP address and unlimited webhooks per domain. It also features advanced blocklist management, allowing for manual additions.
4. Tick the checkbox to confirm that you agree to Scaleway's anti-spam policy, which can be found in the [contracts](https://www.scaleway.com/en/contracts/) section of the Scaleway website.
5. Click **Choose a plan and add a domain**.
6. Select whether to **Use a Scaleway domain** or **Add a domain external to Scaleway**.
3. Enter the domain name you want to use with Transactional Email.
4. Tick the box to acknowledge you have read Scaleway’s antispam policy, then, click **Validate domain name** to confirm.
4. Click **Validate domain name** to confirm.

<Message type="important">
You need to configure your [SPF](/transactional-email/concepts/#spf-record), [DKIM](/transactional-email/concepts/#dkim-record) and [MX](/transactional-email/concepts/#mx-record) records to verify your domain and to be able to send emails.
You need to configure your [SPF](/transactional-email/concepts/#spf-record), [DKIM](/transactional-email/concepts/#dkim-record), [MX](/transactional-email/concepts/#mx-record) and [DMARC](/transactional-email/concepts/#dmarc-record) records to verify your external domain and to be able to send emails.
</Message>


## How to add SPF and DKIM records to your domain

After you have configured your domain with Transactional Email, you are prompted to verify your domain by adding SPF, DKIM and MX records. You can choose to do so right after you have validated your domain, or at a later time.
Expand Down
Loading