1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Email
  5. getSenders
Oracle Cloud Infrastructure v3.9.0 published on Wednesday, Sep 24, 2025 by Pulumi
pulumi/pulumi-oci

oci.Email.getSenders

Get Started
oci logo
Oracle Cloud Infrastructure v3.9.0 published on Wednesday, Sep 24, 2025 by Pulumi
pulumi/pulumi-oci

    This data source provides the list of Senders in Oracle Cloud Infrastructure Email service.

    Gets a collection of approved sender email addresses and sender IDs.

    Example Usage

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

const testSenders = oci.Email.getSenders({
    compartmentId: compartmentId,
    domain: senderDomain,
    emailAddress: senderEmailAddress,
    state: senderState,
});

    import pulumi
import pulumi_oci as oci

test_senders = oci.Email.get_senders(compartment_id=compartment_id,
    domain=sender_domain,
    email_address=sender_email_address,
    state=sender_state)

    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.GetSenders(ctx, &email.GetSendersArgs{
			CompartmentId: compartmentId,
			Domain:        pulumi.StringRef(senderDomain),
			EmailAddress:  pulumi.StringRef(senderEmailAddress),
			State:         pulumi.StringRef(senderState),
		}, 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 testSenders = Oci.Email.GetSenders.Invoke(new()
    {
        CompartmentId = compartmentId,
        Domain = senderDomain,
        EmailAddress = senderEmailAddress,
        State = senderState,
    });

});

    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.GetSendersArgs;
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 testSenders = EmailFunctions.getSenders(GetSendersArgs.builder()
            .compartmentId(compartmentId)
            .domain(senderDomain)
            .emailAddress(senderEmailAddress)
            .state(senderState)
            .build());

    }
}

    variables:
  testSenders:
    fn::invoke:
      function: oci:Email:getSenders
      arguments:
        compartmentId: ${compartmentId}
        domain: ${senderDomain}
        emailAddress: ${senderEmailAddress}
        state: ${senderState}

    Using getSenders

    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 getSenders(args: GetSendersArgs, opts?: InvokeOptions): Promise<GetSendersResult>
function getSendersOutput(args: GetSendersOutputArgs, opts?: InvokeOptions): Output<GetSendersResult>
    def get_senders(compartment_id: Optional[str] = None,
                domain: Optional[str] = None,
                email_address: Optional[str] = None,
                filters: Optional[Sequence[GetSendersFilter]] = None,
                state: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetSendersResult
def get_senders_output(compartment_id: Optional[pulumi.Input[str]] = None,
                domain: Optional[pulumi.Input[str]] = None,
                email_address: Optional[pulumi.Input[str]] = None,
                filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetSendersFilterArgs]]]] = None,
                state: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetSendersResult]
    func GetSenders(ctx *Context, args *GetSendersArgs, opts ...InvokeOption) (*GetSendersResult, error)
func GetSendersOutput(ctx *Context, args *GetSendersOutputArgs, opts ...InvokeOption) GetSendersResultOutput

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

    public static class GetSenders 
{
    public static Task<GetSendersResult> InvokeAsync(GetSendersArgs args, InvokeOptions? opts = null)
    public static Output<GetSendersResult> Invoke(GetSendersInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSendersResult> getSenders(GetSendersArgs args, InvokeOptions options)
public static Output<GetSendersResult> getSenders(GetSendersArgs args, InvokeOptions options)

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

    The following arguments are supported:

    CompartmentId string
    The OCID for the compartment.
    Domain string
    A filter to only return resources that match the given domain exactly.
    EmailAddress string
    The email address of the approved sender.
    Filters List<GetSendersFilter>
    State string
    The current state of a sender.
    CompartmentId string
    The OCID for the compartment.
    Domain string
    A filter to only return resources that match the given domain exactly.
    EmailAddress string
    The email address of the approved sender.
    Filters []GetSendersFilter
    State string
    The current state of a sender.
    compartmentId String
    The OCID for the compartment.
    domain String
    A filter to only return resources that match the given domain exactly.
    emailAddress String
    The email address of the approved sender.
    filters List<GetSendersFilter>
    state String
    The current state of a sender.
    compartmentId string
    The OCID for the compartment.
    domain string
    A filter to only return resources that match the given domain exactly.
    emailAddress string
    The email address of the approved sender.
    filters GetSendersFilter[]
    state string
    The current state of a sender.
    compartment_id str
    The OCID for the compartment.
    domain str
    A filter to only return resources that match the given domain exactly.
    email_address str
    The email address of the approved sender.
    filters Sequence[GetSendersFilter]
    state str
    The current state of a sender.
    compartmentId String
    The OCID for the compartment.
    domain String
    A filter to only return resources that match the given domain exactly.
    emailAddress String
    The email address of the approved sender.
    filters List<Property Map>
    state String
    The current state of a sender.

    getSenders Result

    The following output properties are available:

    CompartmentId string
    The lock compartment ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    Senders List<GetSendersSender>
    The list of senders.
    Domain string
    EmailAddress string
    The email address of the sender.
    Filters List<GetSendersFilter>
    State string
    The current status of the approved sender.
    CompartmentId string
    The lock compartment ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    Senders []GetSendersSender
    The list of senders.
    Domain string
    EmailAddress string
    The email address of the sender.
    Filters []GetSendersFilter
    State string
    The current status of the approved sender.
    compartmentId String
    The lock compartment ID.
    id String
    The provider-assigned unique ID for this managed resource.
    senders List<GetSendersSender>
    The list of senders.
    domain String
    emailAddress String
    The email address of the sender.
    filters List<GetSendersFilter>
    state String
    The current status of the approved sender.
    compartmentId string
    The lock compartment ID.
    id string
    The provider-assigned unique ID for this managed resource.
    senders GetSendersSender[]
    The list of senders.
    domain string
    emailAddress string
    The email address of the sender.
    filters GetSendersFilter[]
    state string
    The current status of the approved sender.
    compartment_id str
    The lock compartment ID.
    id str
    The provider-assigned unique ID for this managed resource.
    senders Sequence[GetSendersSender]
    The list of senders.
    domain str
    email_address str
    The email address of the sender.
    filters Sequence[GetSendersFilter]
    state str
    The current status of the approved sender.
    compartmentId String
    The lock compartment ID.
    id String
    The provider-assigned unique ID for this managed resource.
    senders List<Property Map>
    The list of senders.
    domain String
    emailAddress String
    The email address of the sender.
    filters List<Property Map>
    state String
    The current status of the approved sender.

    Supporting Types

    GetSendersFilter

    Name string
    Values List<string>
    Regex bool
    Name string
    Values []string
    Regex bool
    name String
    values List<String>
    regex Boolean
    name string
    values string[]
    regex boolean
    name str
    values Sequence[str]
    regex bool
    name String
    values List<String>
    regex Boolean

    GetSendersSender

    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"}
    EmailAddress string
    The email address of the approved sender.
    EmailDomainId string
    The email domain used to assert responsibility for emails sent from this sender.
    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 unique OCID of the sender.
    IsSpf bool
    Value of the SPF field. For more information about SPF, please see SPF Authentication.
    Locks List<GetSendersSenderLock>
    Locks associated with this resource.
    State string
    The current state of a sender.
    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 date and time the approved sender was added in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
    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"}
    EmailAddress string
    The email address of the approved sender.
    EmailDomainId string
    The email domain used to assert responsibility for emails sent from this sender.
    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 unique OCID of the sender.
    IsSpf bool
    Value of the SPF field. For more information about SPF, please see SPF Authentication.
    Locks []GetSendersSenderLock
    Locks associated with this resource.
    State string
    The current state of a sender.
    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 date and time the approved sender was added in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
    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"}
    emailAddress String
    The email address of the approved sender.
    emailDomainId String
    The email domain used to assert responsibility for emails sent from this sender.
    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 unique OCID of the sender.
    isSpf Boolean
    Value of the SPF field. For more information about SPF, please see SPF Authentication.
    locks List<GetSendersSenderLock>
    Locks associated with this resource.
    state String
    The current state of a sender.
    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 date and time the approved sender was added in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
    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"}
    emailAddress string
    The email address of the approved sender.
    emailDomainId string
    The email domain used to assert responsibility for emails sent from this sender.
    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 unique OCID of the sender.
    isSpf boolean
    Value of the SPF field. For more information about SPF, please see SPF Authentication.
    locks GetSendersSenderLock[]
    Locks associated with this resource.
    state string
    The current state of a sender.
    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 date and time the approved sender was added in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
    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"}
    email_address str
    The email address of the approved sender.
    email_domain_id str
    The email domain used to assert responsibility for emails sent from this sender.
    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 unique OCID of the sender.
    is_spf bool
    Value of the SPF field. For more information about SPF, please see SPF Authentication.
    locks Sequence[GetSendersSenderLock]
    Locks associated with this resource.
    state str
    The current state of a sender.
    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 date and time the approved sender was added in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
    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"}
    emailAddress String
    The email address of the approved sender.
    emailDomainId String
    The email domain used to assert responsibility for emails sent from this sender.
    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 unique OCID of the sender.
    isSpf Boolean
    Value of the SPF field. For more information about SPF, please see SPF Authentication.
    locks List<Property Map>
    Locks associated with this resource.
    state String
    The current state of a sender.
    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 date and time the approved sender was added in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

    GetSendersSenderLock

    CompartmentId string
    The OCID for the compartment.
    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 date and time the approved sender was added in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
    Type string
    Lock type.
    CompartmentId string
    The OCID for the compartment.
    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 date and time the approved sender was added in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
    Type string
    Lock type.
    compartmentId String
    The OCID for the compartment.
    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 date and time the approved sender was added in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
    type String
    Lock type.
    compartmentId string
    The OCID for the compartment.
    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 date and time the approved sender was added in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
    type string
    Lock type.
    compartment_id str
    The OCID for the compartment.
    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 date and time the approved sender was added in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
    type str
    Lock type.
    compartmentId String
    The OCID for the compartment.
    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 date and time the approved sender was added in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
    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.9.0 published on Wednesday, Sep 24, 2025 by Pulumi
    pulumi/pulumi-oci
      Meet Neo: Your AI Platform Teammate