Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Cloudflare Provider
  4. API Docs
  5. EmailSendingSubdomain
Viewing docs for Cloudflare v6.21.0
published on Thursday, Sep 17, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-cloudflare

cloudflare.EmailSendingSubdomain

cloudflare logo cloudflare logo
Viewing docs for Cloudflare v6.21.0
published on Thursday, Sep 17, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-cloudflare

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";

const exampleEmailSendingSubdomain = new cloudflare.EmailSendingSubdomain("example_email_sending_subdomain", {
    zoneId: "023e105f4ecef8ad9ca31a8372d0c353",
    name: "sub.example.com",
});

    import pulumi
import pulumi_cloudflare as cloudflare

example_email_sending_subdomain = cloudflare.EmailSendingSubdomain("example_email_sending_subdomain",
    zone_id="023e105f4ecef8ad9ca31a8372d0c353",
    name="sub.example.com")

    package main

import (
	"github.com/pulumi/pulumi-cloudflare/sdk/v6/go/cloudflare"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudflare.NewEmailSendingSubdomain(ctx, "example_email_sending_subdomain", &cloudflare.EmailSendingSubdomainArgs{
			ZoneId: pulumi.String("023e105f4ecef8ad9ca31a8372d0c353"),
			Name:   pulumi.String("sub.example.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;

return await Deployment.RunAsync(() => 
{
    var exampleEmailSendingSubdomain = new Cloudflare.EmailSendingSubdomain("example_email_sending_subdomain", new()
    {
        ZoneId = "023e105f4ecef8ad9ca31a8372d0c353",
        Name = "sub.example.com",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.EmailSendingSubdomain;
import com.pulumi.cloudflare.EmailSendingSubdomainArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleEmailSendingSubdomain = new EmailSendingSubdomain("exampleEmailSendingSubdomain", EmailSendingSubdomainArgs.builder()
            .zoneId("023e105f4ecef8ad9ca31a8372d0c353")
            .name("sub.example.com")
            .build());

    }
}

    resources:
  exampleEmailSendingSubdomain:
    type: cloudflare:EmailSendingSubdomain
    name: example_email_sending_subdomain
    properties:
      zoneId: 023e105f4ecef8ad9ca31a8372d0c353
      name: sub.example.com

    pulumi {
  required_providers {
    cloudflare = {
      source = "pulumi/cloudflare"
    }
  }
}

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

    Create EmailSendingSubdomain Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new EmailSendingSubdomain(name: string, args: EmailSendingSubdomainArgs, opts?: CustomResourceOptions);
    @overload
def EmailSendingSubdomain(resource_name: str,
                          args: EmailSendingSubdomainArgs,
                          opts: Optional[ResourceOptions] = None)

@overload
def EmailSendingSubdomain(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          name: Optional[str] = None,
                          zone_id: Optional[str] = None,
                          drop_suppressed_recipients: Optional[bool] = None,
                          preview_enabled: Optional[bool] = None)
    func NewEmailSendingSubdomain(ctx *Context, name string, args EmailSendingSubdomainArgs, opts ...ResourceOption) (*EmailSendingSubdomain, error)
    public EmailSendingSubdomain(string name, EmailSendingSubdomainArgs args, CustomResourceOptions? opts = null)
    public EmailSendingSubdomain(String name, EmailSendingSubdomainArgs args)
public EmailSendingSubdomain(String name, EmailSendingSubdomainArgs args, CustomResourceOptions options)

    type: cloudflare:EmailSendingSubdomain
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "cloudflare_email_sending_subdomain" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args EmailSendingSubdomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args EmailSendingSubdomainArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args EmailSendingSubdomainArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EmailSendingSubdomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EmailSendingSubdomainArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var emailSendingSubdomainResource = new Cloudflare.EmailSendingSubdomain("emailSendingSubdomainResource", new()
{
    Name = "string",
    ZoneId = "string",
    DropSuppressedRecipients = false,
    PreviewEnabled = false,
});

    example, err := cloudflare.NewEmailSendingSubdomain(ctx, "emailSendingSubdomainResource", &cloudflare.EmailSendingSubdomainArgs{
	Name:                     pulumi.String("string"),
	ZoneId:                   pulumi.String("string"),
	DropSuppressedRecipients: pulumi.Bool(false),
	PreviewEnabled:           pulumi.Bool(false),
})

    resource "cloudflare_email_sending_subdomain" "emailSendingSubdomainResource" {
  lifecycle {
    create_before_destroy = true
  }
  name                       = "string"
  zone_id                    = "string"
  drop_suppressed_recipients = false
  preview_enabled            = false
}

    var emailSendingSubdomainResource = new EmailSendingSubdomain("emailSendingSubdomainResource", EmailSendingSubdomainArgs.builder()
    .name("string")
    .zoneId("string")
    .dropSuppressedRecipients(false)
    .previewEnabled(false)
    .build());

    email_sending_subdomain_resource = cloudflare.EmailSendingSubdomain("emailSendingSubdomainResource",
    name="string",
    zone_id="string",
    drop_suppressed_recipients=False,
    preview_enabled=False)

    const emailSendingSubdomainResource = new cloudflare.EmailSendingSubdomain("emailSendingSubdomainResource", {
    name: "string",
    zoneId: "string",
    dropSuppressedRecipients: false,
    previewEnabled: false,
});

    type: cloudflare:EmailSendingSubdomain
properties:
    dropSuppressedRecipients: false
    name: string
    previewEnabled: false
    zoneId: string

    EmailSendingSubdomain Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The EmailSendingSubdomain resource accepts the following input properties:

    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.
    ZoneId string
    Identifier.
    DropSuppressedRecipients 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.
    PreviewEnabled bool
    Whether sent messages from this subdomain can be previewed in the activity log.
    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.
    ZoneId string
    Identifier.
    DropSuppressedRecipients 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.
    PreviewEnabled bool
    Whether sent messages from this subdomain can be previewed in the activity log.
    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.
    zone_id string
    Identifier.
    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.
    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.
    zoneId String
    Identifier.
    dropSuppressedRecipients Boolean
    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.
    previewEnabled Boolean
    Whether sent messages from this subdomain can be previewed in the activity log.
    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.
    zoneId string
    Identifier.
    dropSuppressedRecipients boolean
    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.
    previewEnabled boolean
    Whether sent messages from this subdomain can be previewed in the activity log.
    name str
    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.
    zone_id str
    Identifier.
    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.
    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.
    zoneId String
    Identifier.
    dropSuppressedRecipients Boolean
    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.
    previewEnabled Boolean
    Whether sent messages from this subdomain can be previewed in the activity log.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the EmailSendingSubdomain resource produces the following output properties:

    Created string
    The date and time the destination address has been created.
    DkimSelector 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.
    Id string
    The provider-assigned unique ID for this managed resource.
    Modified string
    The date and time the destination address was last modified.
    ReturnPathDomain string
    The return-path domain used for bounce handling. Wildcard rows use cf-bounce.<base>.
    Tag string
    Sending subdomain identifier.
    Created string
    The date and time the destination address has been created.
    DkimSelector 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.
    Id string
    The provider-assigned unique ID for this managed resource.
    Modified string
    The date and time the destination address was last modified.
    ReturnPathDomain string
    The return-path domain used for bounce handling. Wildcard rows use cf-bounce.<base>.
    Tag string
    Sending subdomain identifier.
    created string
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    modified string
    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>.
    tag string
    Sending subdomain identifier.
    created String
    The date and time the destination address has been created.
    dkimSelector String
    The DKIM selector used for email signing. Wildcard rows publish the selector and sign with d=<base>.
    enabled Boolean
    Whether Email Sending is enabled on this subdomain.
    id String
    The provider-assigned unique ID for this managed resource.
    modified String
    The date and time the destination address was last modified.
    returnPathDomain String
    The return-path domain used for bounce handling. Wildcard rows use cf-bounce.<base>.
    tag String
    Sending subdomain identifier.
    created string
    The date and time the destination address has been created.
    dkimSelector string
    The DKIM selector used for email signing. Wildcard rows publish the selector and sign with d=<base>.
    enabled boolean
    Whether Email Sending is enabled on this subdomain.
    id string
    The provider-assigned unique ID for this managed resource.
    modified string
    The date and time the destination address was last modified.
    returnPathDomain string
    The return-path domain used for bounce handling. Wildcard rows use cf-bounce.<base>.
    tag string
    Sending subdomain identifier.
    created str
    The date and time the destination address has been created.
    dkim_selector str
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    modified str
    The date and time the destination address was last modified.
    return_path_domain str
    The return-path domain used for bounce handling. Wildcard rows use cf-bounce.<base>.
    tag str
    Sending subdomain identifier.
    created String
    The date and time the destination address has been created.
    dkimSelector String
    The DKIM selector used for email signing. Wildcard rows publish the selector and sign with d=<base>.
    enabled Boolean
    Whether Email Sending is enabled on this subdomain.
    id String
    The provider-assigned unique ID for this managed resource.
    modified String
    The date and time the destination address was last modified.
    returnPathDomain String
    The return-path domain used for bounce handling. Wildcard rows use cf-bounce.<base>.
    tag String
    Sending subdomain identifier.

    Look up Existing EmailSendingSubdomain Resource

    Get an existing EmailSendingSubdomain resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: EmailSendingSubdomainState, opts?: CustomResourceOptions): EmailSendingSubdomain
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created: Optional[str] = None,
        dkim_selector: Optional[str] = None,
        drop_suppressed_recipients: Optional[bool] = None,
        enabled: Optional[bool] = None,
        modified: Optional[str] = None,
        name: Optional[str] = None,
        preview_enabled: Optional[bool] = None,
        return_path_domain: Optional[str] = None,
        tag: Optional[str] = None,
        zone_id: Optional[str] = None) -> EmailSendingSubdomain
    func GetEmailSendingSubdomain(ctx *Context, name string, id IDInput, state *EmailSendingSubdomainState, opts ...ResourceOption) (*EmailSendingSubdomain, error)
    public static EmailSendingSubdomain Get(string name, Input<string> id, EmailSendingSubdomainState? state, CustomResourceOptions? opts = null)
    public static EmailSendingSubdomain get(String name, Output<String> id, EmailSendingSubdomainState state, CustomResourceOptions options)
    resources:  _:    type: cloudflare:EmailSendingSubdomain    get:      id: ${id}
    import {
  to = cloudflare_email_sending_subdomain.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Created string
    The date and time the destination address has been created.
    DkimSelector string
    The DKIM selector used for email signing. Wildcard rows publish the selector and sign with d=<base>.
    DropSuppressedRecipients 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 string
    The date and time the destination address was last modified.
    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.
    PreviewEnabled bool
    Whether sent messages from this subdomain can be previewed in the activity log.
    ReturnPathDomain string
    The return-path domain used for bounce handling. Wildcard rows use cf-bounce.<base>.
    Tag string
    Sending subdomain identifier.
    ZoneId string
    Identifier.
    Created string
    The date and time the destination address has been created.
    DkimSelector string
    The DKIM selector used for email signing. Wildcard rows publish the selector and sign with d=<base>.
    DropSuppressedRecipients 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 string
    The date and time the destination address was last modified.
    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.
    PreviewEnabled bool
    Whether sent messages from this subdomain can be previewed in the activity log.
    ReturnPathDomain string
    The return-path domain used for bounce handling. Wildcard rows use cf-bounce.<base>.
    Tag string
    Sending subdomain identifier.
    ZoneId string
    Identifier.
    created string
    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 string
    The date and time the destination address was last modified.
    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.
    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.
    zone_id string
    Identifier.
    created String
    The date and time the destination address has been created.
    dkimSelector String
    The DKIM selector used for email signing. Wildcard rows publish the selector and sign with d=<base>.
    dropSuppressedRecipients Boolean
    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 Boolean
    Whether Email Sending is enabled on this subdomain.
    modified String
    The date and time the destination address was last modified.
    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.
    previewEnabled Boolean
    Whether sent messages from this subdomain can be previewed in the activity log.
    returnPathDomain String
    The return-path domain used for bounce handling. Wildcard rows use cf-bounce.<base>.
    tag String
    Sending subdomain identifier.
    zoneId String
    Identifier.
    created string
    The date and time the destination address has been created.
    dkimSelector string
    The DKIM selector used for email signing. Wildcard rows publish the selector and sign with d=<base>.
    dropSuppressedRecipients boolean
    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 boolean
    Whether Email Sending is enabled on this subdomain.
    modified string
    The date and time the destination address was last modified.
    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.
    previewEnabled boolean
    Whether sent messages from this subdomain can be previewed in the activity log.
    returnPathDomain string
    The return-path domain used for bounce handling. Wildcard rows use cf-bounce.<base>.
    tag string
    Sending subdomain identifier.
    zoneId string
    Identifier.
    created str
    The date and time the destination address has been created.
    dkim_selector str
    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 str
    The date and time the destination address was last modified.
    name str
    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.
    preview_enabled bool
    Whether sent messages from this subdomain can be previewed in the activity log.
    return_path_domain str
    The return-path domain used for bounce handling. Wildcard rows use cf-bounce.<base>.
    tag str
    Sending subdomain identifier.
    zone_id str
    Identifier.
    created String
    The date and time the destination address has been created.
    dkimSelector String
    The DKIM selector used for email signing. Wildcard rows publish the selector and sign with d=<base>.
    dropSuppressedRecipients Boolean
    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 Boolean
    Whether Email Sending is enabled on this subdomain.
    modified String
    The date and time the destination address was last modified.
    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.
    previewEnabled Boolean
    Whether sent messages from this subdomain can be previewed in the activity log.
    returnPathDomain String
    The return-path domain used for bounce handling. Wildcard rows use cf-bounce.<base>.
    tag String
    Sending subdomain identifier.
    zoneId String
    Identifier.

    Import

    $ pulumi import cloudflare:index/emailSendingSubdomain:EmailSendingSubdomain example '<zone_id>/<subdomain_id>'

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Cloudflare pulumi/pulumi-cloudflare
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudflare Terraform Provider.
    cloudflare logo cloudflare logo
    Viewing docs for Cloudflare v6.21.0
    published on Thursday, Sep 17, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-cloudflare

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial