Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Email
  5. Suppression
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

oci.Email.Suppression

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

    This resource provides the Suppression resource in Oracle Cloud Infrastructure Email service.

    Adds recipient email addresses to the suppression list for a tenancy. Addresses added to the suppression list via the API are denoted as “MANUAL” in the reason field. Note: All email addresses added to the suppression list are normalized to include only lowercase letters.

    Example Usage

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

const testSuppression = new oci.email.Suppression("test_suppression", {
    compartmentId: tenancyOcid,
    emailAddress: suppressionEmailAddress,
});

    import pulumi
import pulumi_oci as oci

test_suppression = oci.email.Suppression("test_suppression",
    compartment_id=tenancy_ocid,
    email_address=suppression_email_address)

    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.NewSuppression(ctx, "test_suppression", &Email.SuppressionArgs{
			CompartmentId: pulumi.Any(tenancyOcid),
			EmailAddress:  pulumi.Any(suppressionEmailAddress),
		})
		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 = new Oci.Email.Suppression("test_suppression", new()
    {
        CompartmentId = tenancyOcid,
        EmailAddress = suppressionEmailAddress,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Email.Suppression;
import com.pulumi.oci.Email.SuppressionArgs;
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) {
        var testSuppression = new Suppression("testSuppression", SuppressionArgs.builder()
            .compartmentId(tenancyOcid)
            .emailAddress(suppressionEmailAddress)
            .build());

    }
}

    resources:
  testSuppression:
    type: oci:Email:Suppression
    name: test_suppression
    properties:
      compartmentId: ${tenancyOcid}
      emailAddress: ${suppressionEmailAddress}

    Create Suppression Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Suppression(name: string, args: SuppressionArgs, opts?: CustomResourceOptions);
    @overload
def Suppression(resource_name: str,
                args: SuppressionArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def Suppression(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                compartment_id: Optional[str] = None,
                email_address: Optional[str] = None)
    func NewSuppression(ctx *Context, name string, args SuppressionArgs, opts ...ResourceOption) (*Suppression, error)
    public Suppression(string name, SuppressionArgs args, CustomResourceOptions? opts = null)
    public Suppression(String name, SuppressionArgs args)
public Suppression(String name, SuppressionArgs args, CustomResourceOptions options)

    type: oci:Email:Suppression
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SuppressionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SuppressionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SuppressionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SuppressionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SuppressionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var suppressionResource = new Oci.Email.Suppression("suppressionResource", new()
{
    CompartmentId = "string",
    EmailAddress = "string",
});

    example, err := Email.NewSuppression(ctx, "suppressionResource", &Email.SuppressionArgs{
	CompartmentId: pulumi.String("string"),
	EmailAddress:  pulumi.String("string"),
})

    var suppressionResource = new Suppression("suppressionResource", SuppressionArgs.builder()
    .compartmentId("string")
    .emailAddress("string")
    .build());

    suppression_resource = oci.email.Suppression("suppressionResource",
    compartment_id="string",
    email_address="string")

    const suppressionResource = new oci.email.Suppression("suppressionResource", {
    compartmentId: "string",
    emailAddress: "string",
});

    type: oci:Email:Suppression
properties:
    compartmentId: string
    emailAddress: string

    Suppression Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Suppression resource accepts the following input properties:

    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 recipient email address of the suppression.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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 recipient email address of the suppression.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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 recipient email address of the suppression.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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 recipient email address of the suppression.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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 recipient email address of the suppression.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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 recipient email address of the suppression.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Suppression resource produces the following output properties:

    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 provider-assigned unique ID for this managed resource.
    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.
    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.
    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 provider-assigned unique ID for this managed resource.
    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.
    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.
    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 provider-assigned unique ID for this managed resource.
    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.
    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.
    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 provider-assigned unique ID for this managed resource.
    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.
    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.
    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 provider-assigned unique ID for this managed resource.
    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.
    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.
    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 provider-assigned unique ID for this managed resource.
    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.
    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.

    Look up Existing Suppression Resource

    Get an existing Suppression resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SuppressionState, opts?: CustomResourceOptions): Suppression
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        email_address: Optional[str] = None,
        error_detail: Optional[str] = None,
        error_source: Optional[str] = None,
        message_id: Optional[str] = None,
        reason: Optional[str] = None,
        time_created: Optional[str] = None,
        time_last_suppressed: Optional[str] = None) -> Suppression
    func GetSuppression(ctx *Context, name string, id IDInput, state *SuppressionState, opts ...ResourceOption) (*Suppression, error)
    public static Suppression Get(string name, Input<string> id, SuppressionState? state, CustomResourceOptions? opts = null)
    public static Suppression get(String name, Output<String> id, SuppressionState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    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 recipient email address of the suppression.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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.
    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.
    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 recipient email address of the suppression.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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.
    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.
    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 recipient email address of the suppression.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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.
    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.
    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 recipient email address of the suppression.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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.
    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.
    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 recipient email address of the suppression.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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.
    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.
    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 recipient email address of the suppression.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

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

    Import

    Suppressions can be imported using the id, e.g.

    $ pulumi import oci:Email/suppression:Suppression test_suppression "id"

    To learn more about importing existing cloud resources, see Importing resources.

    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.17.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-oci