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

cloudflare.getEmailSendingSubdomain

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 = cloudflare.getEmailSendingSubdomain({
    zoneId: "023e105f4ecef8ad9ca31a8372d0c353",
    subdomainId: "aabbccdd11223344aabbccdd11223344",
});

    import pulumi
import pulumi_cloudflare as cloudflare

example_email_sending_subdomain = cloudflare.get_email_sending_subdomain(zone_id="023e105f4ecef8ad9ca31a8372d0c353",
    subdomain_id="aabbccdd11223344aabbccdd11223344")

    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.GetEmailSendingSubdomain(ctx, &cloudflare.LookupEmailSendingSubdomainArgs{
			ZoneId:      "023e105f4ecef8ad9ca31a8372d0c353",
			SubdomainId: "aabbccdd11223344aabbccdd11223344",
		}, nil)
		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 = Cloudflare.GetEmailSendingSubdomain.Invoke(new()
    {
        ZoneId = "023e105f4ecef8ad9ca31a8372d0c353",
        SubdomainId = "aabbccdd11223344aabbccdd11223344",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.CloudflareFunctions;
import com.pulumi.cloudflare.inputs.GetEmailSendingSubdomainArgs;
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) {
        final var exampleEmailSendingSubdomain = CloudflareFunctions.getEmailSendingSubdomain(GetEmailSendingSubdomainArgs.builder()
            .zoneId("023e105f4ecef8ad9ca31a8372d0c353")
            .subdomainId("aabbccdd11223344aabbccdd11223344")
            .build());

    }
}

    variables:
  exampleEmailSendingSubdomain:
    fn::invoke:
      function: cloudflare:getEmailSendingSubdomain
      arguments:
        zoneId: 023e105f4ecef8ad9ca31a8372d0c353
        subdomainId: aabbccdd11223344aabbccdd11223344

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

data "cloudflare_getemailsendingsubdomain" "exampleEmailSendingSubdomain" {
  zone_id      = "023e105f4ecef8ad9ca31a8372d0c353"
  subdomain_id = "aabbccdd11223344aabbccdd11223344"
}

    Using getEmailSendingSubdomain

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getEmailSendingSubdomain(args: GetEmailSendingSubdomainArgs, opts?: InvokeOptions): Promise<GetEmailSendingSubdomainResult>
function getEmailSendingSubdomainOutput(args: GetEmailSendingSubdomainOutputArgs, opts?: InvokeOutputOptions): Output<GetEmailSendingSubdomainResult>
    def get_email_sending_subdomain(subdomain_id: Optional[str] = None,
                                zone_id: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetEmailSendingSubdomainResult
def get_email_sending_subdomain_output(subdomain_id: pulumi.Input[Optional[str]] = None,
                                zone_id: pulumi.Input[Optional[str]] = None,
                                opts: Optional[InvokeOutputOptions] = None) -> Output[GetEmailSendingSubdomainResult]
    func LookupEmailSendingSubdomain(ctx *Context, args *LookupEmailSendingSubdomainArgs, opts ...InvokeOption) (*LookupEmailSendingSubdomainResult, error)
func LookupEmailSendingSubdomainOutput(ctx *Context, args *LookupEmailSendingSubdomainOutputArgs, opts ...InvokeOption) LookupEmailSendingSubdomainResultOutput

    > Note: This function is named LookupEmailSendingSubdomain in the Go SDK.

    public static class GetEmailSendingSubdomain 
{
    public static Task<GetEmailSendingSubdomainResult> InvokeAsync(GetEmailSendingSubdomainArgs args, InvokeOptions? opts = null)
    public static Output<GetEmailSendingSubdomainResult> Invoke(GetEmailSendingSubdomainInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetEmailSendingSubdomainResult> Invoke(GetEmailSendingSubdomainInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetEmailSendingSubdomainResult> getEmailSendingSubdomain(GetEmailSendingSubdomainArgs args, InvokeOptions options)
public static Output<GetEmailSendingSubdomainResult> getEmailSendingSubdomain(GetEmailSendingSubdomainArgs args, InvokeOptions options)
public static Output<GetEmailSendingSubdomainResult> getEmailSendingSubdomain(GetEmailSendingSubdomainArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: cloudflare:index/getEmailSendingSubdomain:getEmailSendingSubdomain
  arguments:
    # arguments dictionary
    data "cloudflare_get_email_sending_subdomain" "name" {
    # arguments
}

    The following arguments are supported:

    SubdomainId string
    Sending subdomain identifier.
    ZoneId string
    Identifier.
    SubdomainId string
    Sending subdomain identifier.
    ZoneId string
    Identifier.
    subdomain_id string
    Sending subdomain identifier.
    zone_id string
    Identifier.
    subdomainId String
    Sending subdomain identifier.
    zoneId String
    Identifier.
    subdomainId string
    Sending subdomain identifier.
    zoneId string
    Identifier.
    subdomain_id str
    Sending subdomain identifier.
    zone_id str
    Identifier.
    subdomainId String
    Sending subdomain identifier.
    zoneId String
    Identifier.

    getEmailSendingSubdomain Result

    The following output properties are available:

    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.
    Id string
    Sending subdomain identifier.
    Modified string
    The date and time the destination address was last modified.
    Name string
    The exact domain name or a leftmost wildcard such as *.example.com.
    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>.
    SubdomainId string
    Sending subdomain identifier.
    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.
    Id string
    Sending subdomain identifier.
    Modified string
    The date and time the destination address was last modified.
    Name string
    The exact domain name or a leftmost wildcard such as *.example.com.
    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>.
    SubdomainId string
    Sending subdomain identifier.
    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.
    id string
    Sending subdomain identifier.
    modified string
    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>.
    subdomain_id string
    Sending subdomain identifier.
    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.
    id String
    Sending subdomain identifier.
    modified String
    The date and time the destination address was last modified.
    name String
    The exact domain name or a leftmost wildcard such as *.example.com.
    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>.
    subdomainId String
    Sending subdomain identifier.
    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.
    id string
    Sending subdomain identifier.
    modified string
    The date and time the destination address was last modified.
    name string
    The exact domain name or a leftmost wildcard such as *.example.com.
    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>.
    subdomainId string
    Sending subdomain identifier.
    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.
    id str
    Sending subdomain identifier.
    modified str
    The date and time the destination address was last modified.
    name str
    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 str
    The return-path domain used for bounce handling. Wildcard rows use cf-bounce.<base>.
    subdomain_id str
    Sending subdomain identifier.
    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.
    id String
    Sending subdomain identifier.
    modified String
    The date and time the destination address was last modified.
    name String
    The exact domain name or a leftmost wildcard such as *.example.com.
    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>.
    subdomainId String
    Sending subdomain identifier.
    tag String
    Sending subdomain identifier.
    zoneId String
    Identifier.

    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