Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Email
  5. getEmailReturnPath
Oracle Cloud Infrastructure v3.7.0 published on Saturday, Sep 13, 2025 by Pulumi
pulumi/pulumi-oci

oci.Email.getEmailReturnPath

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v3.7.0 published on Saturday, Sep 13, 2025 by Pulumi
pulumi/pulumi-oci

    This data source provides details about a specific Email Return Path resource in Oracle Cloud Infrastructure Email service.

    Retrieves the specified email return path.

    Example Usage

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

const testEmailReturnPath = oci.Email.getEmailReturnPath({
    emailReturnPathId: testEmailReturnPathOciEmailEmailReturnPath.id,
});

    import pulumi
import pulumi_oci as oci

test_email_return_path = oci.Email.get_email_return_path(email_return_path_id=test_email_return_path_oci_email_email_return_path["id"])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := email.GetEmailReturnPath(ctx, &email.GetEmailReturnPathArgs{
			EmailReturnPathId: testEmailReturnPathOciEmailEmailReturnPath.Id,
		}, 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 testEmailReturnPath = Oci.Email.GetEmailReturnPath.Invoke(new()
    {
        EmailReturnPathId = testEmailReturnPathOciEmailEmailReturnPath.Id,
    });

});

    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.GetEmailReturnPathArgs;
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 testEmailReturnPath = EmailFunctions.getEmailReturnPath(GetEmailReturnPathArgs.builder()
            .emailReturnPathId(testEmailReturnPathOciEmailEmailReturnPath.id())
            .build());

    }
}

    variables:
  testEmailReturnPath:
    fn::invoke:
      function: oci:Email:getEmailReturnPath
      arguments:
        emailReturnPathId: ${testEmailReturnPathOciEmailEmailReturnPath.id}

    Using getEmailReturnPath

    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 getEmailReturnPath(args: GetEmailReturnPathArgs, opts?: InvokeOptions): Promise<GetEmailReturnPathResult>
function getEmailReturnPathOutput(args: GetEmailReturnPathOutputArgs, opts?: InvokeOptions): Output<GetEmailReturnPathResult>
    def get_email_return_path(email_return_path_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetEmailReturnPathResult
def get_email_return_path_output(email_return_path_id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetEmailReturnPathResult]
    func LookupEmailReturnPath(ctx *Context, args *LookupEmailReturnPathArgs, opts ...InvokeOption) (*LookupEmailReturnPathResult, error)
func LookupEmailReturnPathOutput(ctx *Context, args *LookupEmailReturnPathOutputArgs, opts ...InvokeOption) LookupEmailReturnPathResultOutput

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

    public static class GetEmailReturnPath 
{
    public static Task<GetEmailReturnPathResult> InvokeAsync(GetEmailReturnPathArgs args, InvokeOptions? opts = null)
    public static Output<GetEmailReturnPathResult> Invoke(GetEmailReturnPathInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetEmailReturnPathResult> getEmailReturnPath(GetEmailReturnPathArgs args, InvokeOptions options)
public static Output<GetEmailReturnPathResult> getEmailReturnPath(GetEmailReturnPathArgs args, InvokeOptions options)

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

    The following arguments are supported:

    EmailReturnPathId string
    The OCID of this email return path.
    EmailReturnPathId string
    The OCID of this email return path.
    emailReturnPathId String
    The OCID of this email return path.
    emailReturnPathId string
    The OCID of this email return path.
    email_return_path_id str
    The OCID of this email return path.
    emailReturnPathId String
    The OCID of this email return path.

    getEmailReturnPath Result

    The following output properties are available:

    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 lock compartment ID.
    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.
    EmailReturnPathId string
    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
    The OCID of the email return path.
    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.
    Locks List<GetEmailReturnPathLock>
    Locks associated with this resource.
    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.
    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 lock compartment ID.
    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.
    EmailReturnPathId string
    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
    The OCID of the email return path.
    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.
    Locks []GetEmailReturnPathLock
    Locks associated with this resource.
    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.
    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 lock compartment ID.
    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.
    emailReturnPathId String
    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
    The OCID of the email return path.
    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.
    locks List<GetReturnPathLock>
    Locks associated with this resource.
    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.
    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 lock compartment ID.
    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.
    emailReturnPathId string
    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
    The OCID of the email return path.
    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.
    locks GetEmailReturnPathLock[]
    Locks associated with this resource.
    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.
    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 lock compartment ID.
    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.
    email_return_path_id str
    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
    The OCID of the email return path.
    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.
    locks Sequence[GetEmailReturnPathLock]
    Locks associated with this resource.
    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.
    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 lock compartment ID.
    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.
    emailReturnPathId String
    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
    The OCID of the email return path.
    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.
    locks List<Property Map>
    Locks associated with this resource.
    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.
    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".

    Supporting Types

    GetEmailReturnPathLock

    CompartmentId string
    The lock compartment ID.
    Message string
    A message added by the lock creator. The message typically gives an indication of why the resource is locked.
    RelatedResourceId string
    The resource ID that is locking this resource. Indicates that deleting this resource removes the lock.
    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
    Type string
    Lock type.
    CompartmentId string
    The lock compartment ID.
    Message string
    A message added by the lock creator. The message typically gives an indication of why the resource is locked.
    RelatedResourceId string
    The resource ID that is locking this resource. Indicates that deleting this resource removes the lock.
    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
    Type string
    Lock type.
    compartmentId String
    The lock compartment ID.
    message String
    A message added by the lock creator. The message typically gives an indication of why the resource is locked.
    relatedResourceId String
    The resource ID that is locking this resource. Indicates that deleting this resource removes the lock.
    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
    type String
    Lock type.
    compartmentId string
    The lock compartment ID.
    message string
    A message added by the lock creator. The message typically gives an indication of why the resource is locked.
    relatedResourceId string
    The resource ID that is locking this resource. Indicates that deleting this resource removes the lock.
    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
    type string
    Lock type.
    compartment_id str
    The lock compartment ID.
    message str
    A message added by the lock creator. The message typically gives an indication of why the resource is locked.
    related_resource_id str
    The resource ID that is locking this resource. Indicates that deleting this resource removes the lock.
    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
    type str
    Lock type.
    compartmentId String
    The lock compartment ID.
    message String
    A message added by the lock creator. The message typically gives an indication of why the resource is locked.
    relatedResourceId String
    The resource ID that is locking this resource. Indicates that deleting this resource removes the lock.
    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
    type String
    Lock type.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v3.7.0 published on Saturday, Sep 13, 2025 by Pulumi
    pulumi/pulumi-oci