Docs Packages
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Email
  5. getSuppression
Oracle Cloud Infrastructure v1.32.0 published on Thursday, Apr 18, 2024 by Pulumi
pulumi/pulumi-oci

oci.Email.getSuppression

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.32.0 published on Thursday, Apr 18, 2024 by Pulumi
pulumi/pulumi-oci

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

    Gets the details of a suppressed recipient email address for a given suppressionId. Each suppression is given a unique OCID.

    Example Usage

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

const testSuppression = oci.Email.getSuppression({
    suppressionId: oci_email_suppression.test_suppression.id,
});

    import pulumi
import pulumi_oci as oci

test_suppression = oci.Email.get_suppression(suppression_id=oci_email_suppression["test_suppression"]["id"])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Email.GetSuppression(ctx, &email.GetSuppressionArgs{
			SuppressionId: oci_email_suppression.Test_suppression.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 testSuppression = Oci.Email.GetSuppression.Invoke(new()
    {
        SuppressionId = oci_email_suppression.Test_suppression.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.GetSuppressionArgs;
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 testSuppression = EmailFunctions.getSuppression(GetSuppressionArgs.builder()
            .suppressionId(oci_email_suppression.test_suppression().id())
            .build());

    }
}

    variables:
  testSuppression:
    fn::invoke:
      Function: oci:Email:getSuppression
      Arguments:
        suppressionId: ${oci_email_suppression.test_suppression.id}

    Using getSuppression

    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 getSuppression(args: GetSuppressionArgs, opts?: InvokeOptions): Promise<GetSuppressionResult>
function getSuppressionOutput(args: GetSuppressionOutputArgs, opts?: InvokeOptions): Output<GetSuppressionResult>
    def get_suppression(suppression_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetSuppressionResult
def get_suppression_output(suppression_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetSuppressionResult]
    func GetSuppression(ctx *Context, args *GetSuppressionArgs, opts ...InvokeOption) (*GetSuppressionResult, error)
func GetSuppressionOutput(ctx *Context, args *GetSuppressionOutputArgs, opts ...InvokeOption) GetSuppressionResultOutput

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

    public static class GetSuppression 
{
    public static Task<GetSuppressionResult> InvokeAsync(GetSuppressionArgs args, InvokeOptions? opts = null)
    public static Output<GetSuppressionResult> Invoke(GetSuppressionInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSuppressionResult> getSuppression(GetSuppressionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    SuppressionId string
    The unique OCID of the suppression.
    SuppressionId string
    The unique OCID of the suppression.
    suppressionId String
    The unique OCID of the suppression.
    suppressionId string
    The unique OCID of the suppression.
    suppression_id str
    The unique OCID of the suppression.
    suppressionId String
    The unique OCID of the suppression.

    getSuppression Result

    The following output properties are available:

    CompartmentId string
    The OCID of the compartment to contain the suppression. Since suppressions are at the customer level, this must be the tenancy OCID.
    EmailAddress string
    The email address of the suppression.
    ErrorDetail string
    The specific error message returned by a system that resulted in the suppression. This message is usually an SMTP error code with additional descriptive text. Not provided for all types of suppressions.
    ErrorSource string
    DNS name of the source of the error that caused the suppression. Will be set to either the remote-mta or reporting-mta field from a delivery status notification (RFC 3464) when available. Not provided for all types of suppressions, and not always known.
    Id string
    The unique OCID of the suppression.
    MessageId string
    The value of the Message-ID header from the email that triggered a suppression. This value is as defined in RFC 5322 section 3.6.4, excluding angle-brackets. Not provided for all types of suppressions.
    Reason string
    The reason that the email address was suppressed. For more information on the types of bounces, see Suppression List.
    SuppressionId string
    TimeCreated string
    The date and time a recipient's email address was added to the suppression list, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
    TimeLastSuppressed string
    The last date and time the suppression prevented submission in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
    CompartmentId string
    The OCID of the compartment to contain the suppression. Since suppressions are at the customer level, this must be the tenancy OCID.
    EmailAddress string
    The email address of the suppression.
    ErrorDetail string
    The specific error message returned by a system that resulted in the suppression. This message is usually an SMTP error code with additional descriptive text. Not provided for all types of suppressions.
    ErrorSource string
    DNS name of the source of the error that caused the suppression. Will be set to either the remote-mta or reporting-mta field from a delivery status notification (RFC 3464) when available. Not provided for all types of suppressions, and not always known.
    Id string
    The unique OCID of the suppression.
    MessageId string
    The value of the Message-ID header from the email that triggered a suppression. This value is as defined in RFC 5322 section 3.6.4, excluding angle-brackets. Not provided for all types of suppressions.
    Reason string
    The reason that the email address was suppressed. For more information on the types of bounces, see Suppression List.
    SuppressionId string
    TimeCreated string
    The date and time a recipient's email address was added to the suppression list, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
    TimeLastSuppressed string
    The last date and time the suppression prevented submission in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
    compartmentId String
    The OCID of the compartment to contain the suppression. Since suppressions are at the customer level, this must be the tenancy OCID.
    emailAddress String
    The email address of the suppression.
    errorDetail String
    The specific error message returned by a system that resulted in the suppression. This message is usually an SMTP error code with additional descriptive text. Not provided for all types of suppressions.
    errorSource String
    DNS name of the source of the error that caused the suppression. Will be set to either the remote-mta or reporting-mta field from a delivery status notification (RFC 3464) when available. Not provided for all types of suppressions, and not always known.
    id String
    The unique OCID of the suppression.
    messageId String
    The value of the Message-ID header from the email that triggered a suppression. This value is as defined in RFC 5322 section 3.6.4, excluding angle-brackets. Not provided for all types of suppressions.
    reason String
    The reason that the email address was suppressed. For more information on the types of bounces, see Suppression List.
    suppressionId String
    timeCreated String
    The date and time a recipient's email address was added to the suppression list, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
    timeLastSuppressed String
    The last date and time the suppression prevented submission in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
    compartmentId string
    The OCID of the compartment to contain the suppression. Since suppressions are at the customer level, this must be the tenancy OCID.
    emailAddress string
    The email address of the suppression.
    errorDetail string
    The specific error message returned by a system that resulted in the suppression. This message is usually an SMTP error code with additional descriptive text. Not provided for all types of suppressions.
    errorSource string
    DNS name of the source of the error that caused the suppression. Will be set to either the remote-mta or reporting-mta field from a delivery status notification (RFC 3464) when available. Not provided for all types of suppressions, and not always known.
    id string
    The unique OCID of the suppression.
    messageId string
    The value of the Message-ID header from the email that triggered a suppression. This value is as defined in RFC 5322 section 3.6.4, excluding angle-brackets. Not provided for all types of suppressions.
    reason string
    The reason that the email address was suppressed. For more information on the types of bounces, see Suppression List.
    suppressionId string
    timeCreated string
    The date and time a recipient's email address was added to the suppression list, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
    timeLastSuppressed string
    The last date and time the suppression prevented submission in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
    compartment_id str
    The OCID of the compartment to contain the suppression. Since suppressions are at the customer level, this must be the tenancy OCID.
    email_address str
    The email address of the suppression.
    error_detail str
    The specific error message returned by a system that resulted in the suppression. This message is usually an SMTP error code with additional descriptive text. Not provided for all types of suppressions.
    error_source str
    DNS name of the source of the error that caused the suppression. Will be set to either the remote-mta or reporting-mta field from a delivery status notification (RFC 3464) when available. Not provided for all types of suppressions, and not always known.
    id str
    The unique OCID of the suppression.
    message_id str
    The value of the Message-ID header from the email that triggered a suppression. This value is as defined in RFC 5322 section 3.6.4, excluding angle-brackets. Not provided for all types of suppressions.
    reason str
    The reason that the email address was suppressed. For more information on the types of bounces, see Suppression List.
    suppression_id str
    time_created str
    The date and time a recipient's email address was added to the suppression list, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
    time_last_suppressed str
    The last date and time the suppression prevented submission in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
    compartmentId String
    The OCID of the compartment to contain the suppression. Since suppressions are at the customer level, this must be the tenancy OCID.
    emailAddress String
    The email address of the suppression.
    errorDetail String
    The specific error message returned by a system that resulted in the suppression. This message is usually an SMTP error code with additional descriptive text. Not provided for all types of suppressions.
    errorSource String
    DNS name of the source of the error that caused the suppression. Will be set to either the remote-mta or reporting-mta field from a delivery status notification (RFC 3464) when available. Not provided for all types of suppressions, and not always known.
    id String
    The unique OCID of the suppression.
    messageId String
    The value of the Message-ID header from the email that triggered a suppression. This value is as defined in RFC 5322 section 3.6.4, excluding angle-brackets. Not provided for all types of suppressions.
    reason String
    The reason that the email address was suppressed. For more information on the types of bounces, see Suppression List.
    suppressionId String
    timeCreated String
    The date and time a recipient's email address was added to the suppression list, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
    timeLastSuppressed String
    The last date and time the suppression prevented submission in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

    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 v1.32.0 published on Thursday, Apr 18, 2024 by Pulumi
    pulumi/pulumi-oci