Skip to content
Cloudflare API
Start here
API Reference

Email Sending

Email SendingSubdomains

resource cloudflare_email_sending_subdomain

required Expand Collapse
zone_id: String

Identifier.

name: String

The domain name within the zone. A wildcard is allowed only as the complete leftmost label (*.example.com) and requires the account wildcard Email Sending entitlement. The derived Return-Path hostname, including its bounce prefix, must be at most 201 characters after ASCII conversion; wildcards use the base hostname.

optional Expand Collapse
drop_suppressed_recipients?: Bool

Whether a send request that includes a recipient suppressed on this subdomain drops that recipient and still delivers to the rest, instead of failing the entire request.

preview_enabled?: Bool

Whether sent messages from this subdomain can be previewed in the activity log.

computed Expand Collapse
id: String

Sending subdomain identifier.

tag: String

Sending subdomain identifier.

created: Time

The date and time the destination address has been created.

dkim_selector: String

The DKIM selector used for email signing. Wildcard rows publish the selector and sign with d=<base>.

enabled: Bool

Whether Email Sending is enabled on this subdomain.

modified: Time

The date and time the destination address was last modified.

return_path_domain: String

The return-path domain used for bounce handling. Wildcard rows use cf-bounce.<base>.

cloudflare_email_sending_subdomain

resource "cloudflare_email_sending_subdomain" "example_email_sending_subdomain" {
  zone_id = "023e105f4ecef8ad9ca31a8372d0c353"
  name = "sub.example.com"
}

data cloudflare_email_sending_subdomain

required Expand Collapse
subdomain_id: String

Sending subdomain identifier.

zone_id: String

Identifier.

computed Expand Collapse
id: String

Sending subdomain identifier.

created: Time

The date and time the destination address has been created.

dkim_selector: String

The DKIM selector used for email signing. Wildcard rows publish the selector and sign with d=<base>.

drop_suppressed_recipients: Bool

Whether a send request that includes a recipient suppressed on this subdomain drops that recipient and still delivers to the rest, instead of failing the entire request.

enabled: Bool

Whether Email Sending is enabled on this subdomain.

modified: Time

The date and time the destination address was last modified.

name: String

The exact domain name or a leftmost wildcard such as *.example.com.

preview_enabled: Bool

Whether sent messages from this subdomain can be previewed in the activity log.

return_path_domain: String

The return-path domain used for bounce handling. Wildcard rows use cf-bounce.<base>.

tag: String

Sending subdomain identifier.

cloudflare_email_sending_subdomain

data "cloudflare_email_sending_subdomain" "example_email_sending_subdomain" {
  zone_id = "023e105f4ecef8ad9ca31a8372d0c353"
  subdomain_id = "aabbccdd11223344aabbccdd11223344"
}

data cloudflare_email_sending_subdomains

required Expand Collapse
zone_id: String

Identifier.

optional Expand Collapse
max_items?: Int64

Max items to fetch, default: 1000

computed Expand Collapse
result: List[Attributes]

The items returned by the data source

id: String

Sending subdomain identifier.

enabled: Bool

Whether Email Sending is enabled on this subdomain.

name: String

The exact domain name or a leftmost wildcard such as *.example.com.

tag: String

Sending subdomain identifier.

created: Time

The date and time the destination address has been created.

dkim_selector: String

The DKIM selector used for email signing. Wildcard rows publish the selector and sign with d=<base>.

drop_suppressed_recipients: Bool

Whether a send request that includes a recipient suppressed on this subdomain drops that recipient and still delivers to the rest, instead of failing the entire request.

modified: Time

The date and time the destination address was last modified.

preview_enabled: Bool

Whether sent messages from this subdomain can be previewed in the activity log.

return_path_domain: String

The return-path domain used for bounce handling. Wildcard rows use cf-bounce.<base>.

cloudflare_email_sending_subdomains

data "cloudflare_email_sending_subdomains" "example_email_sending_subdomains" {
  zone_id = "023e105f4ecef8ad9ca31a8372d0c353"
}