|
| 1 | +--- |
| 2 | +subcategory: "Transactional Email" |
| 3 | +page_title: "Scaleway: scaleway_tem_blocked_list" |
| 4 | +--- |
| 5 | + |
| 6 | +# Resource: scaleway_tem_blocked_list |
| 7 | + |
| 8 | +Creates and manages blocklisted email addresses for a Scaleway Transactional Email Domain. |
| 9 | +For more information refer to the [API documentation](https://www.scaleway.com/en/developers/api/transactional-email/#post-transactional-email-v1alpha1-regions-region-blocklists). |
| 10 | + |
| 11 | +## Example Usage |
| 12 | + |
| 13 | +### Basic |
| 14 | + |
| 15 | +```hcl |
| 16 | +resource "scaleway_tem_blocked_list" "test" { |
| 17 | + domain_id = "fr-par/12345678-1234-1234-1234-123456789abc" |
| 18 | + |
| 19 | + type = "mailbox_full" |
| 20 | + reason = "Spam detected" |
| 21 | + region = "fr-par" |
| 22 | +} |
| 23 | +``` |
| 24 | + |
| 25 | +## Argument Reference |
| 26 | + |
| 27 | +The following arguments are supported: |
| 28 | + |
| 29 | +- `domain_id` - (Required) The ID of the domain affected by the blocklist. Must be in the format `{region}/{domain_id}`. |
| 30 | +- `email` - (Required) The email address to block. |
| 31 | +- `type` - (Required) Type of the blocklist. Possible values are: |
| 32 | + - `mailbox_full` — The recipient's mailbox is full. |
| 33 | + - `mailbox_not_found` — The recipient's mailbox does not exist. |
| 34 | +- `reason` - (Optional, Default: `manual_block`) Reason for blocking the email address. |
| 35 | +- `region` - (Optional) The [region](../guides/regions_and_zones.md#regions) in which the blocklist is created. Defaults to the provider's region. |
| 36 | +- `project_id` - (Optional) The ID of the project this blocklist belongs to. Defaults to the provider's project ID. |
| 37 | + |
| 38 | +## Attributes Reference |
| 39 | + |
| 40 | +In addition to all arguments above, the following attributes are exported: |
| 41 | + |
| 42 | +- `id` - The ID of the blocklist, in the format `{region}/{id}`. |
| 43 | + |
| 44 | +~> **Important:** Blocklist IDs are [regional](../guides/regions_and_zones.md#resource-ids), and must be imported/exported using the full format. |
| 45 | + |
| 46 | +## Import |
| 47 | + |
| 48 | +Blocklists can be imported using the `{region}/{id}`, e.g. |
| 49 | + |
| 50 | +```bash |
| 51 | +terraform import scaleway_tem_blocked_list.test fr-par/11111111-1111-1111-1111-111111111111 |
| 52 | +``` |
| 53 | + |
0 commit comments