Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. getEmailRoutingRules
Cloudflare v6.0.1 published on Wednesday, Apr 16, 2025 by Pulumi
pulumi/pulumi-cloudflare

cloudflare.getEmailRoutingRules

Explore with Pulumi AI

Cloudflare v6.0.1 published on Wednesday, Apr 16, 2025 by Pulumi
pulumi/pulumi-cloudflare

Example Usage

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

const exampleEmailRoutingRules = cloudflare.getEmailRoutingRules({
    zoneId: "023e105f4ecef8ad9ca31a8372d0c353",
    enabled: true,
});
Copy
import pulumi
import pulumi_cloudflare as cloudflare

example_email_routing_rules = cloudflare.get_email_routing_rules(zone_id="023e105f4ecef8ad9ca31a8372d0c353",
    enabled=True)
Copy
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.LookupEmailRoutingRules(ctx, &cloudflare.LookupEmailRoutingRulesArgs{
			ZoneId:  "023e105f4ecef8ad9ca31a8372d0c353",
			Enabled: pulumi.BoolRef(true),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;

return await Deployment.RunAsync(() => 
{
    var exampleEmailRoutingRules = Cloudflare.GetEmailRoutingRules.Invoke(new()
    {
        ZoneId = "023e105f4ecef8ad9ca31a8372d0c353",
        Enabled = true,
    });

});
Copy
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.GetEmailRoutingRulesArgs;
import java.util.List;
import java.util.ArrayList;
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 exampleEmailRoutingRules = CloudflareFunctions.getEmailRoutingRules(GetEmailRoutingRulesArgs.builder()
            .zoneId("023e105f4ecef8ad9ca31a8372d0c353")
            .enabled(true)
            .build());

    }
}
Copy
variables:
  exampleEmailRoutingRules:
    fn::invoke:
      function: cloudflare:getEmailRoutingRules
      arguments:
        zoneId: 023e105f4ecef8ad9ca31a8372d0c353
        enabled: true
Copy

Using getEmailRoutingRules

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 getEmailRoutingRules(args: GetEmailRoutingRulesArgs, opts?: InvokeOptions): Promise<GetEmailRoutingRulesResult>
function getEmailRoutingRulesOutput(args: GetEmailRoutingRulesOutputArgs, opts?: InvokeOptions): Output<GetEmailRoutingRulesResult>
Copy
def get_email_routing_rules(enabled: Optional[bool] = None,
                            max_items: Optional[int] = None,
                            zone_id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetEmailRoutingRulesResult
def get_email_routing_rules_output(enabled: Optional[pulumi.Input[bool]] = None,
                            max_items: Optional[pulumi.Input[int]] = None,
                            zone_id: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetEmailRoutingRulesResult]
Copy
func LookupEmailRoutingRules(ctx *Context, args *LookupEmailRoutingRulesArgs, opts ...InvokeOption) (*LookupEmailRoutingRulesResult, error)
func LookupEmailRoutingRulesOutput(ctx *Context, args *LookupEmailRoutingRulesOutputArgs, opts ...InvokeOption) LookupEmailRoutingRulesResultOutput
Copy

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

public static class GetEmailRoutingRules 
{
    public static Task<GetEmailRoutingRulesResult> InvokeAsync(GetEmailRoutingRulesArgs args, InvokeOptions? opts = null)
    public static Output<GetEmailRoutingRulesResult> Invoke(GetEmailRoutingRulesInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetEmailRoutingRulesResult> getEmailRoutingRules(GetEmailRoutingRulesArgs args, InvokeOptions options)
public static Output<GetEmailRoutingRulesResult> getEmailRoutingRules(GetEmailRoutingRulesArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: cloudflare:index/getEmailRoutingRules:getEmailRoutingRules
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ZoneId This property is required. string
Identifier
Enabled bool
Filter by enabled routing rules.
MaxItems int
Max items to fetch, default: 1000
ZoneId This property is required. string
Identifier
Enabled bool
Filter by enabled routing rules.
MaxItems int
Max items to fetch, default: 1000
zoneId This property is required. String
Identifier
enabled Boolean
Filter by enabled routing rules.
maxItems Integer
Max items to fetch, default: 1000
zoneId This property is required. string
Identifier
enabled boolean
Filter by enabled routing rules.
maxItems number
Max items to fetch, default: 1000
zone_id This property is required. str
Identifier
enabled bool
Filter by enabled routing rules.
max_items int
Max items to fetch, default: 1000
zoneId This property is required. String
Identifier
enabled Boolean
Filter by enabled routing rules.
maxItems Number
Max items to fetch, default: 1000

getEmailRoutingRules Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Results List<GetEmailRoutingRulesResult>
The items returned by the data source
ZoneId string
Identifier
Enabled bool
Filter by enabled routing rules.
MaxItems int
Max items to fetch, default: 1000
Id string
The provider-assigned unique ID for this managed resource.
Results []GetEmailRoutingRulesResult
The items returned by the data source
ZoneId string
Identifier
Enabled bool
Filter by enabled routing rules.
MaxItems int
Max items to fetch, default: 1000
id String
The provider-assigned unique ID for this managed resource.
results List<GetEmailRoutingRulesResult>
The items returned by the data source
zoneId String
Identifier
enabled Boolean
Filter by enabled routing rules.
maxItems Integer
Max items to fetch, default: 1000
id string
The provider-assigned unique ID for this managed resource.
results GetEmailRoutingRulesResult[]
The items returned by the data source
zoneId string
Identifier
enabled boolean
Filter by enabled routing rules.
maxItems number
Max items to fetch, default: 1000
id str
The provider-assigned unique ID for this managed resource.
results Sequence[GetEmailRoutingRulesResult]
The items returned by the data source
zone_id str
Identifier
enabled bool
Filter by enabled routing rules.
max_items int
Max items to fetch, default: 1000
id String
The provider-assigned unique ID for this managed resource.
results List<Property Map>
The items returned by the data source
zoneId String
Identifier
enabled Boolean
Filter by enabled routing rules.
maxItems Number
Max items to fetch, default: 1000

Supporting Types

GetEmailRoutingRulesResult

Actions This property is required. List<GetEmailRoutingRulesResultAction>
List actions patterns.
Enabled This property is required. bool
Routing rule status.
Id This property is required. string
Routing rule identifier.
Matchers This property is required. List<GetEmailRoutingRulesResultMatcher>
Matching patterns to forward to your actions.
Name This property is required. string
Routing rule name.
Priority This property is required. double
Priority of the routing rule.
Tag This property is required. string
Routing rule tag. (Deprecated, replaced by routing rule identifier)
Actions This property is required. []GetEmailRoutingRulesResultAction
List actions patterns.
Enabled This property is required. bool
Routing rule status.
Id This property is required. string
Routing rule identifier.
Matchers This property is required. []GetEmailRoutingRulesResultMatcher
Matching patterns to forward to your actions.
Name This property is required. string
Routing rule name.
Priority This property is required. float64
Priority of the routing rule.
Tag This property is required. string
Routing rule tag. (Deprecated, replaced by routing rule identifier)
actions This property is required. List<GetEmailRoutingRulesResultAction>
List actions patterns.
enabled This property is required. Boolean
Routing rule status.
id This property is required. String
Routing rule identifier.
matchers This property is required. List<GetEmailRoutingRulesResultMatcher>
Matching patterns to forward to your actions.
name This property is required. String
Routing rule name.
priority This property is required. Double
Priority of the routing rule.
tag This property is required. String
Routing rule tag. (Deprecated, replaced by routing rule identifier)
actions This property is required. GetEmailRoutingRulesResultAction[]
List actions patterns.
enabled This property is required. boolean
Routing rule status.
id This property is required. string
Routing rule identifier.
matchers This property is required. GetEmailRoutingRulesResultMatcher[]
Matching patterns to forward to your actions.
name This property is required. string
Routing rule name.
priority This property is required. number
Priority of the routing rule.
tag This property is required. string
Routing rule tag. (Deprecated, replaced by routing rule identifier)
actions This property is required. Sequence[GetEmailRoutingRulesResultAction]
List actions patterns.
enabled This property is required. bool
Routing rule status.
id This property is required. str
Routing rule identifier.
matchers This property is required. Sequence[GetEmailRoutingRulesResultMatcher]
Matching patterns to forward to your actions.
name This property is required. str
Routing rule name.
priority This property is required. float
Priority of the routing rule.
tag This property is required. str
Routing rule tag. (Deprecated, replaced by routing rule identifier)
actions This property is required. List<Property Map>
List actions patterns.
enabled This property is required. Boolean
Routing rule status.
id This property is required. String
Routing rule identifier.
matchers This property is required. List<Property Map>
Matching patterns to forward to your actions.
name This property is required. String
Routing rule name.
priority This property is required. Number
Priority of the routing rule.
tag This property is required. String
Routing rule tag. (Deprecated, replaced by routing rule identifier)

GetEmailRoutingRulesResultAction

Type This property is required. string
Type of supported action. Available values: "drop", "forward", "worker".
Values This property is required. List<string>
Type This property is required. string
Type of supported action. Available values: "drop", "forward", "worker".
Values This property is required. []string
type This property is required. String
Type of supported action. Available values: "drop", "forward", "worker".
values This property is required. List<String>
type This property is required. string
Type of supported action. Available values: "drop", "forward", "worker".
values This property is required. string[]
type This property is required. str
Type of supported action. Available values: "drop", "forward", "worker".
values This property is required. Sequence[str]
type This property is required. String
Type of supported action. Available values: "drop", "forward", "worker".
values This property is required. List<String>

GetEmailRoutingRulesResultMatcher

Field This property is required. string
Field for type matcher. Available values: "to".
Type This property is required. string
Type of matcher. Available values: "literal".
Value This property is required. string
Value for matcher.
Field This property is required. string
Field for type matcher. Available values: "to".
Type This property is required. string
Type of matcher. Available values: "literal".
Value This property is required. string
Value for matcher.
field This property is required. String
Field for type matcher. Available values: "to".
type This property is required. String
Type of matcher. Available values: "literal".
value This property is required. String
Value for matcher.
field This property is required. string
Field for type matcher. Available values: "to".
type This property is required. string
Type of matcher. Available values: "literal".
value This property is required. string
Value for matcher.
field This property is required. str
Field for type matcher. Available values: "to".
type This property is required. str
Type of matcher. Available values: "literal".
value This property is required. str
Value for matcher.
field This property is required. String
Field for type matcher. Available values: "to".
type This property is required. String
Type of matcher. Available values: "literal".
value This property is required. String
Value for matcher.

Package Details

Repository
Cloudflare pulumi/pulumi-cloudflare
License
Apache-2.0
Notes
This Pulumi package is based on the cloudflare Terraform Provider.
Cloudflare v6.0.1 published on Wednesday, Apr 16, 2025 by Pulumi
pulumi/pulumi-cloudflare