1. Registry
  2. Packages
  3. Cloudflare Provider
  4. API Docs
  5. getEmailSendingSubdomains
Viewing docs for Cloudflare v6.21.0
published on Thursday, Sep 17, 2026 by Pulumi
cloudflare logo cloudflare logo
Viewing docs for Cloudflare v6.21.0
published on Thursday, Sep 17, 2026 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as cloudflare from "@pulumi/cloudflare";
    
    const exampleEmailSendingSubdomains = cloudflare.getEmailSendingSubdomains({
        zoneId: "023e105f4ecef8ad9ca31a8372d0c353",
    });
    
    import pulumi
    import pulumi_cloudflare as cloudflare
    
    example_email_sending_subdomains = cloudflare.get_email_sending_subdomains(zone_id="023e105f4ecef8ad9ca31a8372d0c353")
    
    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.GetEmailSendingSubdomains(ctx, &cloudflare.LookupEmailSendingSubdomainsArgs{
    			ZoneId: "023e105f4ecef8ad9ca31a8372d0c353",
    		}, 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 exampleEmailSendingSubdomains = Cloudflare.GetEmailSendingSubdomains.Invoke(new()
        {
            ZoneId = "023e105f4ecef8ad9ca31a8372d0c353",
        });
    
    });
    
    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.GetEmailSendingSubdomainsArgs;
    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 exampleEmailSendingSubdomains = CloudflareFunctions.getEmailSendingSubdomains(GetEmailSendingSubdomainsArgs.builder()
                .zoneId("023e105f4ecef8ad9ca31a8372d0c353")
                .build());
    
        }
    }
    
    variables:
      exampleEmailSendingSubdomains:
        fn::invoke:
          function: cloudflare:getEmailSendingSubdomains
          arguments:
            zoneId: 023e105f4ecef8ad9ca31a8372d0c353
    
    pulumi {
      required_providers {
        cloudflare = {
          source = "pulumi/cloudflare"
        }
      }
    }
    
    data "cloudflare_getemailsendingsubdomains" "exampleEmailSendingSubdomains" {
      zone_id = "023e105f4ecef8ad9ca31a8372d0c353"
    }
    

    Using getEmailSendingSubdomains

    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 getEmailSendingSubdomains(args: GetEmailSendingSubdomainsArgs, opts?: InvokeOptions): Promise<GetEmailSendingSubdomainsResult>
    function getEmailSendingSubdomainsOutput(args: GetEmailSendingSubdomainsOutputArgs, opts?: InvokeOutputOptions): Output<GetEmailSendingSubdomainsResult>
    def get_email_sending_subdomains(max_items: Optional[int] = None,
                                     zone_id: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetEmailSendingSubdomainsResult
    def get_email_sending_subdomains_output(max_items: pulumi.Input[Optional[int]] = None,
                                     zone_id: pulumi.Input[Optional[str]] = None,
                                     opts: Optional[InvokeOutputOptions] = None) -> Output[GetEmailSendingSubdomainsResult]
    func LookupEmailSendingSubdomains(ctx *Context, args *LookupEmailSendingSubdomainsArgs, opts ...InvokeOption) (*LookupEmailSendingSubdomainsResult, error)
    func LookupEmailSendingSubdomainsOutput(ctx *Context, args *LookupEmailSendingSubdomainsOutputArgs, opts ...InvokeOption) LookupEmailSendingSubdomainsResultOutput

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

    public static class GetEmailSendingSubdomains 
    {
        public static Task<GetEmailSendingSubdomainsResult> InvokeAsync(GetEmailSendingSubdomainsArgs args, InvokeOptions? opts = null)
        public static Output<GetEmailSendingSubdomainsResult> Invoke(GetEmailSendingSubdomainsInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetEmailSendingSubdomainsResult> Invoke(GetEmailSendingSubdomainsInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetEmailSendingSubdomainsResult> getEmailSendingSubdomains(GetEmailSendingSubdomainsArgs args, InvokeOptions options)
    public static Output<GetEmailSendingSubdomainsResult> getEmailSendingSubdomains(GetEmailSendingSubdomainsArgs args, InvokeOptions options)
    public static Output<GetEmailSendingSubdomainsResult> getEmailSendingSubdomains(GetEmailSendingSubdomainsArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: cloudflare:index/getEmailSendingSubdomains:getEmailSendingSubdomains
      arguments:
        # arguments dictionary
    data "cloudflare_get_email_sending_subdomains" "name" {
        # arguments
    }

    The following arguments are supported:

    ZoneId string
    Identifier.
    MaxItems int
    Max items to fetch, default: 1000
    ZoneId string
    Identifier.
    MaxItems int
    Max items to fetch, default: 1000
    zone_id string
    Identifier.
    max_items number
    Max items to fetch, default: 1000
    zoneId String
    Identifier.
    maxItems Integer
    Max items to fetch, default: 1000
    zoneId string
    Identifier.
    maxItems number
    Max items to fetch, default: 1000
    zone_id str
    Identifier.
    max_items int
    Max items to fetch, default: 1000
    zoneId String
    Identifier.
    maxItems Number
    Max items to fetch, default: 1000

    getEmailSendingSubdomains Result

    The following output properties are available:

    Results List<GetEmailSendingSubdomainsResult>
    The items returned by the data source
    ZoneId string
    Identifier.
    MaxItems int
    Max items to fetch, default: 1000
    Results []GetEmailSendingSubdomainsResult
    The items returned by the data source
    ZoneId string
    Identifier.
    MaxItems int
    Max items to fetch, default: 1000
    results list(object)
    The items returned by the data source
    zone_id string
    Identifier.
    max_items number
    Max items to fetch, default: 1000
    results List<GetEmailSendingSubdomainsResult>
    The items returned by the data source
    zoneId String
    Identifier.
    maxItems Integer
    Max items to fetch, default: 1000
    results GetEmailSendingSubdomainsResult[]
    The items returned by the data source
    zoneId string
    Identifier.
    maxItems number
    Max items to fetch, default: 1000
    results Sequence[GetEmailSendingSubdomainsResult]
    The items returned by the data source
    zone_id str
    Identifier.
    max_items int
    Max items to fetch, default: 1000
    results List<Property Map>
    The items returned by the data source
    zoneId String
    Identifier.
    maxItems Number
    Max items to fetch, default: 1000

    Supporting Types

    GetEmailSendingSubdomainsResult

    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>.
    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>.
    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>.
    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>.
    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>.
    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>.
    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>.
    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>.
    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>.
    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>.
    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>.
    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>.
    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>.
    tag String
    Sending subdomain 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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial