getSender

Oracle Cloud Infrastructure v4.2.0, Mar 6 26

Viewing docs for Oracle Cloud Infrastructure v4.2.0
published on Friday, Mar 6, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-oci

Viewing docs for Oracle Cloud Infrastructure v4.2.0
published on Friday, Mar 6, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-oci

Example Usage

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

const testSender = oci.Email.getSender({
    senderId: testSenderOciEmailSender.id,
});

import pulumi
import pulumi_oci as oci

test_sender = oci.Email.get_sender(sender_id=test_sender_oci_email_sender["id"])

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := email.GetSender(ctx, &email.GetSenderArgs{
			SenderId: testSenderOciEmailSender.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 testSender = Oci.Email.GetSender.Invoke(new()
    {
        SenderId = testSenderOciEmailSender.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.GetSenderArgs;
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 testSender = EmailFunctions.getSender(GetSenderArgs.builder()
            .senderId(testSenderOciEmailSender.id())
            .build());

    }
}

variables:
  testSender:
    fn::invoke:
      function: oci:Email:getSender
      arguments:
        senderId: ${testSenderOciEmailSender.id}

Using getSender

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 getSender(args: GetSenderArgs, opts?: InvokeOptions): Promise<GetSenderResult>
function getSenderOutput(args: GetSenderOutputArgs, opts?: InvokeOptions): Output<GetSenderResult>

def get_sender(sender_id: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetSenderResult
def get_sender_output(sender_id: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetSenderResult]

func LookupSender(ctx *Context, args *LookupSenderArgs, opts ...InvokeOption) (*LookupSenderResult, error)
func LookupSenderOutput(ctx *Context, args *LookupSenderOutputArgs, opts ...InvokeOption) LookupSenderResultOutput

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

public static class GetSender 
{
    public static Task<GetSenderResult> InvokeAsync(GetSenderArgs args, InvokeOptions? opts = null)
    public static Output<GetSenderResult> Invoke(GetSenderInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSenderResult> getSender(GetSenderArgs args, InvokeOptions options)
public static Output<GetSenderResult> getSender(GetSenderArgs args, InvokeOptions options)

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

The following arguments are supported:

SenderId string: The unique OCID of the sender.

SenderId string: The unique OCID of the sender.

senderId String: The unique OCID of the sender.

senderId string: The unique OCID of the sender.

sender_id str: The unique OCID of the sender.

senderId String: The unique OCID of the sender.

getSender Result

The following output properties are available:

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"}
EmailAddress string: The email address of the sender.
EmailDomainId string: The email domain used to assert responsibility for emails sent from this sender.
EmailIpPoolId string: The IpPool OCID used to submit an email by Email Delivery when 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<GetSenderLock>: Locks associated with this resource.
SenderId string
State string: The current status of the approved 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 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"}
EmailAddress string: The email address of the sender.
EmailDomainId string: The email domain used to assert responsibility for emails sent from this sender.
EmailIpPoolId string: The IpPool OCID used to submit an email by Email Delivery when 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 []GetSenderLock: Locks associated with this resource.
SenderId string
State string: The current status of the approved 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 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"}
emailAddress String: The email address of the sender.
emailDomainId String: The email domain used to assert responsibility for emails sent from this sender.
emailIpPoolId String: The IpPool OCID used to submit an email by Email Delivery when 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<GetSenderLock>: Locks associated with this resource.
senderId String
state String: The current status of the approved 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 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"}
emailAddress string: The email address of the sender.
emailDomainId string: The email domain used to assert responsibility for emails sent from this sender.
emailIpPoolId string: The IpPool OCID used to submit an email by Email Delivery when 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 GetSenderLock[]: Locks associated with this resource.
senderId string
state string: The current status of the approved 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 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"}
email_address str: The email address of the sender.
email_domain_id str: The email domain used to assert responsibility for emails sent from this sender.
email_ip_pool_id str: The IpPool OCID used to submit an email by Email Delivery when 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[GetSenderLock]: Locks associated with this resource.
sender_id str
state str: The current status of the approved 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 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"}
emailAddress String: The email address of the sender.
emailDomainId String: The email domain used to assert responsibility for emails sent from this sender.
emailIpPoolId String: The IpPool OCID used to submit an email by Email Delivery when 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.
senderId String
state String: The current status of the approved 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.

Supporting Types

GetSenderLock

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 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 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 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 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 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 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 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 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 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 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 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.

Viewing docs for Oracle Cloud Infrastructure v4.2.0
published on Friday, Mar 6, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-oci

oci.Email.getSender

On this page

On this page

Example Usage

Using getSender

getSender Result

Supporting Types

GetSenderLock

Package Details

On this page

On this page