Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Email
  5. getEmailDomain
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci

oci.Email.getEmailDomain

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci

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

    Retrieves the specified email domain.

    Example Usage

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

const testEmailDomain = oci.Email.getEmailDomain({
    emailDomainId: testEmailDomainOciEmailEmailDomain.id,
});

    import pulumi
import pulumi_oci as oci

test_email_domain = oci.Email.get_email_domain(email_domain_id=test_email_domain_oci_email_email_domain["id"])

    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.GetEmailDomain(ctx, &email.GetEmailDomainArgs{
			EmailDomainId: testEmailDomainOciEmailEmailDomain.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 testEmailDomain = Oci.Email.GetEmailDomain.Invoke(new()
    {
        EmailDomainId = testEmailDomainOciEmailEmailDomain.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.GetEmailDomainArgs;
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 testEmailDomain = EmailFunctions.getEmailDomain(GetEmailDomainArgs.builder()
            .emailDomainId(testEmailDomainOciEmailEmailDomain.id())
            .build());

    }
}

    variables:
  testEmailDomain:
    fn::invoke:
      function: oci:Email:getEmailDomain
      arguments:
        emailDomainId: ${testEmailDomainOciEmailEmailDomain.id}

    Using getEmailDomain

    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 getEmailDomain(args: GetEmailDomainArgs, opts?: InvokeOptions): Promise<GetEmailDomainResult>
function getEmailDomainOutput(args: GetEmailDomainOutputArgs, opts?: InvokeOptions): Output<GetEmailDomainResult>
    def get_email_domain(email_domain_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetEmailDomainResult
def get_email_domain_output(email_domain_id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetEmailDomainResult]
    func GetEmailDomain(ctx *Context, args *GetEmailDomainArgs, opts ...InvokeOption) (*GetEmailDomainResult, error)
func GetEmailDomainOutput(ctx *Context, args *GetEmailDomainOutputArgs, opts ...InvokeOption) GetEmailDomainResultOutput

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

    public static class GetEmailDomain 
{
    public static Task<GetEmailDomainResult> InvokeAsync(GetEmailDomainArgs args, InvokeOptions? opts = null)
    public static Output<GetEmailDomainResult> Invoke(GetEmailDomainInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetEmailDomainResult> getEmailDomain(GetEmailDomainArgs args, InvokeOptions options)
public static Output<GetEmailDomainResult> getEmailDomain(GetEmailDomainArgs args, InvokeOptions options)

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

    The following arguments are supported:

    EmailDomainId string
    The OCID of this email domain.
    EmailDomainId string
    The OCID of this email domain.
    emailDomainId String
    The OCID of this email domain.
    emailDomainId string
    The OCID of this email domain.
    email_domain_id str
    The OCID of this email domain.
    emailDomainId String
    The OCID of this email domain.

    getEmailDomain Result

    The following output properties are available:

    ActiveDkimId string
    The OCID of the DKIM key that will be used to sign mail sent from this email domain.
    CompartmentId string
    The OCID of the compartment that contains this email domain.
    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 an email domain.
    DomainVerificationId string
    Id for Domain in Domain Management (under governance) if DOMAINID verification method used.
    DomainVerificationStatus string
    The current domain verification status.
    EmailDomainId 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 domain.
    IsSpf bool
    Value of the SPF field. For more information about SPF, please see SPF Authentication.
    Name string
    The name of the email domain in the Internet Domain Name System (DNS). Example: mydomain.example.com
    State string
    The current state of the email domain.
    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 domain was created, expressed in RFC 3339 timestamp format, "YYYY-MM-ddThh:mmZ". Example: 2021-02-12T22:47:12.613Z
    ActiveDkimId string
    The OCID of the DKIM key that will be used to sign mail sent from this email domain.
    CompartmentId string
    The OCID of the compartment that contains this email domain.
    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 an email domain.
    DomainVerificationId string
    Id for Domain in Domain Management (under governance) if DOMAINID verification method used.
    DomainVerificationStatus string
    The current domain verification status.
    EmailDomainId 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 domain.
    IsSpf bool
    Value of the SPF field. For more information about SPF, please see SPF Authentication.
    Name string
    The name of the email domain in the Internet Domain Name System (DNS). Example: mydomain.example.com
    State string
    The current state of the email domain.
    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 domain was created, expressed in RFC 3339 timestamp format, "YYYY-MM-ddThh:mmZ". Example: 2021-02-12T22:47:12.613Z
    activeDkimId String
    The OCID of the DKIM key that will be used to sign mail sent from this email domain.
    compartmentId String
    The OCID of the compartment that contains this email domain.
    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 an email domain.
    domainVerificationId String
    Id for Domain in Domain Management (under governance) if DOMAINID verification method used.
    domainVerificationStatus String
    The current domain verification status.
    emailDomainId 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 domain.
    isSpf Boolean
    Value of the SPF field. For more information about SPF, please see SPF Authentication.
    name String
    The name of the email domain in the Internet Domain Name System (DNS). Example: mydomain.example.com
    state String
    The current state of the email domain.
    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 domain was created, expressed in RFC 3339 timestamp format, "YYYY-MM-ddThh:mmZ". Example: 2021-02-12T22:47:12.613Z
    activeDkimId string
    The OCID of the DKIM key that will be used to sign mail sent from this email domain.
    compartmentId string
    The OCID of the compartment that contains this email domain.
    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 an email domain.
    domainVerificationId string
    Id for Domain in Domain Management (under governance) if DOMAINID verification method used.
    domainVerificationStatus string
    The current domain verification status.
    emailDomainId 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 domain.
    isSpf boolean
    Value of the SPF field. For more information about SPF, please see SPF Authentication.
    name string
    The name of the email domain in the Internet Domain Name System (DNS). Example: mydomain.example.com
    state string
    The current state of the email domain.
    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 domain was created, expressed in RFC 3339 timestamp format, "YYYY-MM-ddThh:mmZ". Example: 2021-02-12T22:47:12.613Z
    active_dkim_id str
    The OCID of the DKIM key that will be used to sign mail sent from this email domain.
    compartment_id str
    The OCID of the compartment that contains this email domain.
    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 an email domain.
    domain_verification_id str
    Id for Domain in Domain Management (under governance) if DOMAINID verification method used.
    domain_verification_status str
    The current domain verification status.
    email_domain_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 domain.
    is_spf bool
    Value of the SPF field. For more information about SPF, please see SPF Authentication.
    name str
    The name of the email domain in the Internet Domain Name System (DNS). Example: mydomain.example.com
    state str
    The current state of the email domain.
    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 domain was created, expressed in RFC 3339 timestamp format, "YYYY-MM-ddThh:mmZ". Example: 2021-02-12T22:47:12.613Z
    activeDkimId String
    The OCID of the DKIM key that will be used to sign mail sent from this email domain.
    compartmentId String
    The OCID of the compartment that contains this email domain.
    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 an email domain.
    domainVerificationId String
    Id for Domain in Domain Management (under governance) if DOMAINID verification method used.
    domainVerificationStatus String
    The current domain verification status.
    emailDomainId 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 domain.
    isSpf Boolean
    Value of the SPF field. For more information about SPF, please see SPF Authentication.
    name String
    The name of the email domain in the Internet Domain Name System (DNS). Example: mydomain.example.com
    state String
    The current state of the email domain.
    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 domain was created, expressed in RFC 3339 timestamp format, "YYYY-MM-ddThh:mmZ". Example: 2021-02-12T22:47:12.613Z

    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 v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
    pulumi/pulumi-oci