Oracle Cloud Infrastructure v2.31.0, Apr 17 25

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.Email.getEmailReturnPaths

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const testEmailReturnPaths = oci.Email.getEmailReturnPaths({
    compartmentId: compartmentId,
    id: emailReturnPathId,
    name: emailReturnPathName,
    parentResourceId: testResource.id,
    state: emailReturnPathState,
});

import pulumi
import pulumi_oci as oci

test_email_return_paths = oci.Email.get_email_return_paths(compartment_id=compartment_id,
    id=email_return_path_id,
    name=email_return_path_name,
    parent_resource_id=test_resource["id"],
    state=email_return_path_state)

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/email"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := email.GetEmailReturnPaths(ctx, &email.GetEmailReturnPathsArgs{
			CompartmentId:    pulumi.StringRef(compartmentId),
			Id:               pulumi.StringRef(emailReturnPathId),
			Name:             pulumi.StringRef(emailReturnPathName),
			ParentResourceId: pulumi.StringRef(testResource.Id),
			State:            pulumi.StringRef(emailReturnPathState),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testEmailReturnPaths = Oci.Email.GetEmailReturnPaths.Invoke(new()
    {
        CompartmentId = compartmentId,
        Id = emailReturnPathId,
        Name = emailReturnPathName,
        ParentResourceId = testResource.Id,
        State = emailReturnPathState,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Email.EmailFunctions;
import com.pulumi.oci.Email.inputs.GetEmailReturnPathsArgs;
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 testEmailReturnPaths = EmailFunctions.getEmailReturnPaths(GetEmailReturnPathsArgs.builder()
            .compartmentId(compartmentId)
            .id(emailReturnPathId)
            .name(emailReturnPathName)
            .parentResourceId(testResource.id())
            .state(emailReturnPathState)
            .build());

    }
}

variables:
  testEmailReturnPaths:
    fn::invoke:
      function: oci:Email:getEmailReturnPaths
      arguments:
        compartmentId: ${compartmentId}
        id: ${emailReturnPathId}
        name: ${emailReturnPathName}
        parentResourceId: ${testResource.id}
        state: ${emailReturnPathState}

Using getEmailReturnPaths

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.

TypeScript
Python
Go
C#
Java
YAML

function getEmailReturnPaths(args: GetEmailReturnPathsArgs, opts?: InvokeOptions): Promise<GetEmailReturnPathsResult>
function getEmailReturnPathsOutput(args: GetEmailReturnPathsOutputArgs, opts?: InvokeOptions): Output<GetEmailReturnPathsResult>

def get_email_return_paths(compartment_id: Optional[str] = None,
                           filters: Optional[Sequence[_email.GetEmailReturnPathsFilter]] = None,
                           id: Optional[str] = None,
                           name: Optional[str] = None,
                           parent_resource_id: Optional[str] = None,
                           state: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetEmailReturnPathsResult
def get_email_return_paths_output(compartment_id: Optional[pulumi.Input[str]] = None,
                           filters: Optional[pulumi.Input[Sequence[pulumi.Input[_email.GetEmailReturnPathsFilterArgs]]]] = None,
                           id: Optional[pulumi.Input[str]] = None,
                           name: Optional[pulumi.Input[str]] = None,
                           parent_resource_id: Optional[pulumi.Input[str]] = None,
                           state: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetEmailReturnPathsResult]

func GetEmailReturnPaths(ctx *Context, args *GetEmailReturnPathsArgs, opts ...InvokeOption) (*GetEmailReturnPathsResult, error)
func GetEmailReturnPathsOutput(ctx *Context, args *GetEmailReturnPathsOutputArgs, opts ...InvokeOption) GetEmailReturnPathsResultOutput

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

public static class GetEmailReturnPaths 
{
    public static Task<GetEmailReturnPathsResult> InvokeAsync(GetEmailReturnPathsArgs args, InvokeOptions? opts = null)
    public static Output<GetEmailReturnPathsResult> Invoke(GetEmailReturnPathsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetEmailReturnPathsResult> getEmailReturnPaths(GetEmailReturnPathsArgs args, InvokeOptions options)
public static Output<GetEmailReturnPathsResult> getEmailReturnPaths(GetEmailReturnPathsArgs args, InvokeOptions options)

fn::invoke:
  function: oci:Email/getEmailReturnPaths:getEmailReturnPaths
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: The OCID for the compartment.
Filters List<GetEmailReturnPathsFilter>
Id string: A filter to only return resources that match the given id exactly.
Name string: A filter to only return resources that match the given name exactly.
ParentResourceId string: The OCID of the Email Domain to which this Email Return Path belongs.
State string: Filter returned list by specified lifecycle state. This parameter is case-insensitive.

CompartmentId string: The OCID for the compartment.
Filters []GetEmailReturnPathsFilter
Id string: A filter to only return resources that match the given id exactly.
Name string: A filter to only return resources that match the given name exactly.
ParentResourceId string: The OCID of the Email Domain to which this Email Return Path belongs.
State string: Filter returned list by specified lifecycle state. This parameter is case-insensitive.

compartmentId String: The OCID for the compartment.
filters List<GetReturnPathsFilter>
id String: A filter to only return resources that match the given id exactly.
name String: A filter to only return resources that match the given name exactly.
parentResourceId String: The OCID of the Email Domain to which this Email Return Path belongs.
state String: Filter returned list by specified lifecycle state. This parameter is case-insensitive.

compartmentId string: The OCID for the compartment.
filters GetEmailReturnPathsFilter[]
id string: A filter to only return resources that match the given id exactly.
name string: A filter to only return resources that match the given name exactly.
parentResourceId string: The OCID of the Email Domain to which this Email Return Path belongs.
state string: Filter returned list by specified lifecycle state. This parameter is case-insensitive.

compartment_id str: The OCID for the compartment.
filters Sequence[email.GetEmailReturnPathsFilter]
id str: A filter to only return resources that match the given id exactly.
name str: A filter to only return resources that match the given name exactly.
parent_resource_id str: The OCID of the Email Domain to which this Email Return Path belongs.
state str: Filter returned list by specified lifecycle state. This parameter is case-insensitive.

compartmentId String: The OCID for the compartment.
filters List<Property Map>
id String: A filter to only return resources that match the given id exactly.
name String: A filter to only return resources that match the given name exactly.
parentResourceId String: The OCID of the Email Domain to which this Email Return Path belongs.
state String: Filter returned list by specified lifecycle state. This parameter is case-insensitive.

getEmailReturnPaths Result

The following output properties are available:

EmailReturnPathCollections List<GetEmailReturnPathsEmailReturnPathCollection>: The list of email_return_path_collection.
CompartmentId string: The OCID of the compartment that contains this email return path.
Filters List<GetEmailReturnPathsFilter>
Id string: The OCID of the email return path.
Name string: The email return path domain in the Internet Domain Name System (DNS). Example: iad1.rp.example.com
ParentResourceId string: The OCID of the EmailDomain that this email return path belongs to.
State string: The current state of the email return path.

EmailReturnPathCollections []GetEmailReturnPathsEmailReturnPathCollection: The list of email_return_path_collection.
CompartmentId string: The OCID of the compartment that contains this email return path.
Filters []GetEmailReturnPathsFilter
Id string: The OCID of the email return path.
Name string: The email return path domain in the Internet Domain Name System (DNS). Example: iad1.rp.example.com
ParentResourceId string: The OCID of the EmailDomain that this email return path belongs to.
State string: The current state of the email return path.

emailReturnPathCollections List<GetReturnPathsReturnPathCollection>: The list of email_return_path_collection.
compartmentId String: The OCID of the compartment that contains this email return path.
filters List<GetReturnPathsFilter>
id String: The OCID of the email return path.
name String: The email return path domain in the Internet Domain Name System (DNS). Example: iad1.rp.example.com
parentResourceId String: The OCID of the EmailDomain that this email return path belongs to.
state String: The current state of the email return path.

emailReturnPathCollections GetEmailReturnPathsEmailReturnPathCollection[]: The list of email_return_path_collection.
compartmentId string: The OCID of the compartment that contains this email return path.
filters GetEmailReturnPathsFilter[]
id string: The OCID of the email return path.
name string: The email return path domain in the Internet Domain Name System (DNS). Example: iad1.rp.example.com
parentResourceId string: The OCID of the EmailDomain that this email return path belongs to.
state string: The current state of the email return path.

email_return_path_collections Sequence[email.GetEmailReturnPathsEmailReturnPathCollection]: The list of email_return_path_collection.
compartment_id str: The OCID of the compartment that contains this email return path.
filters Sequence[email.GetEmailReturnPathsFilter]
id str: The OCID of the email return path.
name str: The email return path domain in the Internet Domain Name System (DNS). Example: iad1.rp.example.com
parent_resource_id str: The OCID of the EmailDomain that this email return path belongs to.
state str: The current state of the email return path.

emailReturnPathCollections List<Property Map>: The list of email_return_path_collection.
compartmentId String: The OCID of the compartment that contains this email return path.
filters List<Property Map>
id String: The OCID of the email return path.
name String: The email return path domain in the Internet Domain Name System (DNS). Example: iad1.rp.example.com
parentResourceId String: The OCID of the EmailDomain that this email return path belongs to.
state String: The current state of the email return path.

Supporting Types

GetEmailReturnPathsEmailReturnPathCollection

Items List<GetEmailReturnPathsEmailReturnPathCollectionItem>

Items []GetEmailReturnPathsEmailReturnPathCollectionItem

items List<GetReturnPathsReturnPathCollectionItem>

items GetEmailReturnPathsEmailReturnPathCollectionItem[]

items Sequence[email.GetEmailReturnPathsEmailReturnPathCollectionItem]

items List<Property Map>

GetEmailReturnPathsEmailReturnPathCollectionItem

CnameRecordValue string: The DNS CNAME record value to provision to the Return Patn DNS subdomain, when using the CNAME method for Email Return Path setup (preferred).
CompartmentId string: The OCID for the compartment.
DefinedTags Dictionary<string, string>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
Description string: The description of the email return path. Avoid entering confidential information.
DnsSubdomainName string: The name of the DNS subdomain that must be provisioned to enable email recipients to verify Email Return Path. It is usually created with a CNAME record set to the cnameRecordValue.
FreeformTags Dictionary<string, string>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
Id string: A filter to only return resources that match the given id exactly.
LifecycleDetails string: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state.
Name string: A filter to only return resources that match the given name exactly.
ParentResourceId string: The OCID of the Email Domain to which this Email Return Path belongs.
State string: Filter returned list by specified lifecycle state. This parameter is case-insensitive.
SystemTags Dictionary<string, string>: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The time the email return path was created. Times are expressed in RFC 3339 timestamp format, "YYYY-MM-ddThh:mmZ". Example: 2021-02-12T22:47:12.613Z
TimeUpdated string: The time of the last change to the Email Return Path configuration, due to a state change or an update operation. Times are expressed in RFC 3339 timestamp format, "YYYY-MM-ddThh:mmZ".

CnameRecordValue string: The DNS CNAME record value to provision to the Return Patn DNS subdomain, when using the CNAME method for Email Return Path setup (preferred).
CompartmentId string: The OCID for the compartment.
DefinedTags map[string]string: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
Description string: The description of the email return path. Avoid entering confidential information.
DnsSubdomainName string: The name of the DNS subdomain that must be provisioned to enable email recipients to verify Email Return Path. It is usually created with a CNAME record set to the cnameRecordValue.
FreeformTags map[string]string: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
Id string: A filter to only return resources that match the given id exactly.
LifecycleDetails string: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state.
Name string: A filter to only return resources that match the given name exactly.
ParentResourceId string: The OCID of the Email Domain to which this Email Return Path belongs.
State string: Filter returned list by specified lifecycle state. This parameter is case-insensitive.
SystemTags map[string]string: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The time the email return path was created. Times are expressed in RFC 3339 timestamp format, "YYYY-MM-ddThh:mmZ". Example: 2021-02-12T22:47:12.613Z
TimeUpdated string: The time of the last change to the Email Return Path configuration, due to a state change or an update operation. Times are expressed in RFC 3339 timestamp format, "YYYY-MM-ddThh:mmZ".

cnameRecordValue String: The DNS CNAME record value to provision to the Return Patn DNS subdomain, when using the CNAME method for Email Return Path setup (preferred).
compartmentId String: The OCID for the compartment.
definedTags Map<String,String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description String: The description of the email return path. Avoid entering confidential information.
dnsSubdomainName String: The name of the DNS subdomain that must be provisioned to enable email recipients to verify Email Return Path. It is usually created with a CNAME record set to the cnameRecordValue.
freeformTags Map<String,String>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id String: A filter to only return resources that match the given id exactly.
lifecycleDetails String: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state.
name String: A filter to only return resources that match the given name exactly.
parentResourceId String: The OCID of the Email Domain to which this Email Return Path belongs.
state String: Filter returned list by specified lifecycle state. This parameter is case-insensitive.
systemTags Map<String,String>: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The time the email return path was created. Times are expressed in RFC 3339 timestamp format, "YYYY-MM-ddThh:mmZ". Example: 2021-02-12T22:47:12.613Z
timeUpdated String: The time of the last change to the Email Return Path configuration, due to a state change or an update operation. Times are expressed in RFC 3339 timestamp format, "YYYY-MM-ddThh:mmZ".

cnameRecordValue string: The DNS CNAME record value to provision to the Return Patn DNS subdomain, when using the CNAME method for Email Return Path setup (preferred).
compartmentId string: The OCID for the compartment.
definedTags {[key: string]: string}: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description string: The description of the email return path. Avoid entering confidential information.
dnsSubdomainName string: The name of the DNS subdomain that must be provisioned to enable email recipients to verify Email Return Path. It is usually created with a CNAME record set to the cnameRecordValue.
freeformTags {[key: string]: string}: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id string: A filter to only return resources that match the given id exactly.
lifecycleDetails string: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state.
name string: A filter to only return resources that match the given name exactly.
parentResourceId string: The OCID of the Email Domain to which this Email Return Path belongs.
state string: Filter returned list by specified lifecycle state. This parameter is case-insensitive.
systemTags {[key: string]: string}: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated string: The time the email return path was created. Times are expressed in RFC 3339 timestamp format, "YYYY-MM-ddThh:mmZ". Example: 2021-02-12T22:47:12.613Z
timeUpdated string: The time of the last change to the Email Return Path configuration, due to a state change or an update operation. Times are expressed in RFC 3339 timestamp format, "YYYY-MM-ddThh:mmZ".

cname_record_value str: The DNS CNAME record value to provision to the Return Patn DNS subdomain, when using the CNAME method for Email Return Path setup (preferred).
compartment_id str: The OCID for the compartment.
defined_tags Mapping[str, str]: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description str: The description of the email return path. Avoid entering confidential information.
dns_subdomain_name str: The name of the DNS subdomain that must be provisioned to enable email recipients to verify Email Return Path. It is usually created with a CNAME record set to the cnameRecordValue.
freeform_tags Mapping[str, str]: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id str: A filter to only return resources that match the given id exactly.
lifecycle_details str: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state.
name str: A filter to only return resources that match the given name exactly.
parent_resource_id str: The OCID of the Email Domain to which this Email Return Path belongs.
state str: Filter returned list by specified lifecycle state. This parameter is case-insensitive.
system_tags Mapping[str, str]: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created str: The time the email return path was created. Times are expressed in RFC 3339 timestamp format, "YYYY-MM-ddThh:mmZ". Example: 2021-02-12T22:47:12.613Z
time_updated str: The time of the last change to the Email Return Path configuration, due to a state change or an update operation. Times are expressed in RFC 3339 timestamp format, "YYYY-MM-ddThh:mmZ".

cnameRecordValue String: The DNS CNAME record value to provision to the Return Patn DNS subdomain, when using the CNAME method for Email Return Path setup (preferred).
compartmentId String: The OCID for the compartment.
definedTags Map<String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description String: The description of the email return path. Avoid entering confidential information.
dnsSubdomainName String: The name of the DNS subdomain that must be provisioned to enable email recipients to verify Email Return Path. It is usually created with a CNAME record set to the cnameRecordValue.
freeformTags Map<String>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id String: A filter to only return resources that match the given id exactly.
lifecycleDetails String: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state.
name String: A filter to only return resources that match the given name exactly.
parentResourceId String: The OCID of the Email Domain to which this Email Return Path belongs.
state String: Filter returned list by specified lifecycle state. This parameter is case-insensitive.
systemTags Map<String>: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The time the email return path was created. Times are expressed in RFC 3339 timestamp format, "YYYY-MM-ddThh:mmZ". Example: 2021-02-12T22:47:12.613Z
timeUpdated String: The time of the last change to the Email Return Path configuration, due to a state change or an update operation. Times are expressed in RFC 3339 timestamp format, "YYYY-MM-ddThh:mmZ".

GetEmailReturnPathsFilter

Name string: A filter to only return resources that match the given name exactly.
Values List<string>
Regex bool

Name string: A filter to only return resources that match the given name exactly.
Values []string
Regex bool

name String: A filter to only return resources that match the given name exactly.
values List<String>
regex Boolean

name string: A filter to only return resources that match the given name exactly.
values string[]
regex boolean

name str: A filter to only return resources that match the given name exactly.
values Sequence[str]
regex bool

name String: A filter to only return resources that match the given name exactly.
values List<String>
regex Boolean

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

pulumi/pulumi-oci

oci.Email.getEmailReturnPaths

On this page

On this page

Example Usage

Using getEmailReturnPaths

getEmailReturnPaths Result

Supporting Types

GetEmailReturnPathsEmailReturnPathCollection

GetEmailReturnPathsEmailReturnPathCollectionItem

GetEmailReturnPathsFilter

Package Details

On this page

On this page