Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Ibm Provider
  4. API Docs
  5. EnDestinationCustomEmail
Viewing docs for ibm 2.3.0-beta0
published on Monday, Jun 15, 2026 by ibm-cloud
Schema (JSON)
ibm-cloud/terraform-provider-ibm

ibm.EnDestinationCustomEmail

Viewing docs for ibm 2.3.0-beta0
published on Monday, Jun 15, 2026 by ibm-cloud
Schema (JSON)
ibm-cloud/terraform-provider-ibm

    Create, update, or delete a Custom Email destination by using IBM Cloud™ Event Notifications.

    Example Usage

    Production Custom Email Destination

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

const customDomainEnDestination = new ibm.EnDestinationCustomEmail("custom_domain_en_destination", {
    instanceGuid: enTerraformTestResource.guid,
    name: "Custom Email EN Destination",
    type: "smtp_custom",
    collectFailedEvents: true,
    isSandbox: false,
    description: "Production custom email destination for event notification",
    config: {
        params: [{
            domain: "mailx.com",
        }],
    },
});

    import pulumi
import pulumi_ibm as ibm

custom_domain_en_destination = ibm.EnDestinationCustomEmail("custom_domain_en_destination",
    instance_guid=en_terraform_test_resource["guid"],
    name="Custom Email EN Destination",
    type="smtp_custom",
    collect_failed_events=True,
    is_sandbox=False,
    description="Production custom email destination for event notification",
    config={
        "params": [{
            "domain": "mailx.com",
        }],
    })

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/v2/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewEnDestinationCustomEmail(ctx, "custom_domain_en_destination", &ibm.EnDestinationCustomEmailArgs{
			InstanceGuid:        pulumi.Any(enTerraformTestResource.Guid),
			Name:                pulumi.String("Custom Email EN Destination"),
			Type:                pulumi.String("smtp_custom"),
			CollectFailedEvents: pulumi.Bool(true),
			IsSandbox:           pulumi.Bool(false),
			Description:         pulumi.String("Production custom email destination for event notification"),
			Config: &ibm.EnDestinationCustomEmailConfigArgs{
				Params: ibm.EnDestinationCustomEmailConfigParamArray{
					&ibm.EnDestinationCustomEmailConfigParamArgs{
						Domain: pulumi.String("mailx.com"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var customDomainEnDestination = new Ibm.EnDestinationCustomEmail("custom_domain_en_destination", new()
    {
        InstanceGuid = enTerraformTestResource.Guid,
        Name = "Custom Email EN Destination",
        Type = "smtp_custom",
        CollectFailedEvents = true,
        IsSandbox = false,
        Description = "Production custom email destination for event notification",
        Config = new Ibm.Inputs.EnDestinationCustomEmailConfigArgs
        {
            Params = new[]
            {
                new Ibm.Inputs.EnDestinationCustomEmailConfigParamArgs
                {
                    Domain = "mailx.com",
                },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.EnDestinationCustomEmail;
import com.pulumi.ibm.EnDestinationCustomEmailArgs;
import com.pulumi.ibm.inputs.EnDestinationCustomEmailConfigArgs;
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 customDomainEnDestination = new EnDestinationCustomEmail("customDomainEnDestination", EnDestinationCustomEmailArgs.builder()
            .instanceGuid(enTerraformTestResource.guid())
            .name("Custom Email EN Destination")
            .type("smtp_custom")
            .collectFailedEvents(true)
            .isSandbox(false)
            .description("Production custom email destination for event notification")
            .config(EnDestinationCustomEmailConfigArgs.builder()
                .params(EnDestinationCustomEmailConfigParamArgs.builder()
                    .domain("mailx.com")
                    .build())
                .build())
            .build());

    }
}

    resources:
  customDomainEnDestination:
    type: ibm:EnDestinationCustomEmail
    name: custom_domain_en_destination
    properties:
      instanceGuid: ${enTerraformTestResource.guid}
      name: Custom Email EN Destination
      type: smtp_custom
      collectFailedEvents: true
      isSandbox: false
      description: Production custom email destination for event notification
      config:
        params:
          - domain: mailx.com

    Example coming soon!

    Sandbox Custom Email Destination

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

const sandboxCustomDomainEnDestination = new ibm.EnDestinationCustomEmail("sandbox_custom_domain_en_destination", {
    instanceGuid: enTerraformTestResource.guid,
    name: "Sandbox Custom Email EN Destination",
    type: "smtp_custom",
    collectFailedEvents: false,
    isSandbox: true,
    description: "Sandbox custom email destination for testing",
    config: {
        params: [{
            domain: "sandbox.example.com",
        }],
    },
});

    import pulumi
import pulumi_ibm as ibm

sandbox_custom_domain_en_destination = ibm.EnDestinationCustomEmail("sandbox_custom_domain_en_destination",
    instance_guid=en_terraform_test_resource["guid"],
    name="Sandbox Custom Email EN Destination",
    type="smtp_custom",
    collect_failed_events=False,
    is_sandbox=True,
    description="Sandbox custom email destination for testing",
    config={
        "params": [{
            "domain": "sandbox.example.com",
        }],
    })

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/v2/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewEnDestinationCustomEmail(ctx, "sandbox_custom_domain_en_destination", &ibm.EnDestinationCustomEmailArgs{
			InstanceGuid:        pulumi.Any(enTerraformTestResource.Guid),
			Name:                pulumi.String("Sandbox Custom Email EN Destination"),
			Type:                pulumi.String("smtp_custom"),
			CollectFailedEvents: pulumi.Bool(false),
			IsSandbox:           pulumi.Bool(true),
			Description:         pulumi.String("Sandbox custom email destination for testing"),
			Config: &ibm.EnDestinationCustomEmailConfigArgs{
				Params: ibm.EnDestinationCustomEmailConfigParamArray{
					&ibm.EnDestinationCustomEmailConfigParamArgs{
						Domain: pulumi.String("sandbox.example.com"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var sandboxCustomDomainEnDestination = new Ibm.EnDestinationCustomEmail("sandbox_custom_domain_en_destination", new()
    {
        InstanceGuid = enTerraformTestResource.Guid,
        Name = "Sandbox Custom Email EN Destination",
        Type = "smtp_custom",
        CollectFailedEvents = false,
        IsSandbox = true,
        Description = "Sandbox custom email destination for testing",
        Config = new Ibm.Inputs.EnDestinationCustomEmailConfigArgs
        {
            Params = new[]
            {
                new Ibm.Inputs.EnDestinationCustomEmailConfigParamArgs
                {
                    Domain = "sandbox.example.com",
                },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.EnDestinationCustomEmail;
import com.pulumi.ibm.EnDestinationCustomEmailArgs;
import com.pulumi.ibm.inputs.EnDestinationCustomEmailConfigArgs;
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 sandboxCustomDomainEnDestination = new EnDestinationCustomEmail("sandboxCustomDomainEnDestination", EnDestinationCustomEmailArgs.builder()
            .instanceGuid(enTerraformTestResource.guid())
            .name("Sandbox Custom Email EN Destination")
            .type("smtp_custom")
            .collectFailedEvents(false)
            .isSandbox(true)
            .description("Sandbox custom email destination for testing")
            .config(EnDestinationCustomEmailConfigArgs.builder()
                .params(EnDestinationCustomEmailConfigParamArgs.builder()
                    .domain("sandbox.example.com")
                    .build())
                .build())
            .build());

    }
}

    resources:
  sandboxCustomDomainEnDestination:
    type: ibm:EnDestinationCustomEmail
    name: sandbox_custom_domain_en_destination
    properties:
      instanceGuid: ${enTerraformTestResource.guid}
      name: Sandbox Custom Email EN Destination
      type: smtp_custom
      collectFailedEvents: false
      isSandbox: true
      description: Sandbox custom email destination for testing
      config:
        params:
          - domain: sandbox.example.com

    Example coming soon!

    Create EnDestinationCustomEmail Resource

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

    Constructor syntax

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

@overload
def EnDestinationCustomEmail(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             instance_guid: Optional[str] = None,
                             type: Optional[str] = None,
                             collect_failed_events: Optional[bool] = None,
                             config: Optional[EnDestinationCustomEmailConfigArgs] = None,
                             description: Optional[str] = None,
                             en_destination_custom_email_id: Optional[str] = None,
                             is_sandbox: Optional[bool] = None,
                             name: Optional[str] = None,
                             verification_type: Optional[str] = None)
    func NewEnDestinationCustomEmail(ctx *Context, name string, args EnDestinationCustomEmailArgs, opts ...ResourceOption) (*EnDestinationCustomEmail, error)
    public EnDestinationCustomEmail(string name, EnDestinationCustomEmailArgs args, CustomResourceOptions? opts = null)
    public EnDestinationCustomEmail(String name, EnDestinationCustomEmailArgs args)
public EnDestinationCustomEmail(String name, EnDestinationCustomEmailArgs args, CustomResourceOptions options)

    type: ibm:EnDestinationCustomEmail
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "ibm_endestinationcustomemail" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args EnDestinationCustomEmailArgs
    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 EnDestinationCustomEmailArgs
    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 EnDestinationCustomEmailArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EnDestinationCustomEmailArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EnDestinationCustomEmailArgs
    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 enDestinationCustomEmailResource = new Ibm.EnDestinationCustomEmail("enDestinationCustomEmailResource", new()
{
    InstanceGuid = "string",
    Type = "string",
    CollectFailedEvents = false,
    Config = new Ibm.Inputs.EnDestinationCustomEmailConfigArgs
    {
        Params = new[]
        {
            new Ibm.Inputs.EnDestinationCustomEmailConfigParamArgs
            {
                Domain = "string",
                Dkims = new[]
                {
                    new Ibm.Inputs.EnDestinationCustomEmailConfigParamDkimArgs
                    {
                        PublicKey = "string",
                        Selector = "string",
                        Verification = "string",
                    },
                },
                Spfs = new[]
                {
                    new Ibm.Inputs.EnDestinationCustomEmailConfigParamSpfArgs
                    {
                        TxtName = "string",
                        TxtValue = "string",
                        Verification = "string",
                    },
                },
            },
        },
    },
    Description = "string",
    EnDestinationCustomEmailId = "string",
    IsSandbox = false,
    Name = "string",
    VerificationType = "string",
});

    example, err := ibm.NewEnDestinationCustomEmail(ctx, "enDestinationCustomEmailResource", &ibm.EnDestinationCustomEmailArgs{
	InstanceGuid:        pulumi.String("string"),
	Type:                pulumi.String("string"),
	CollectFailedEvents: pulumi.Bool(false),
	Config: &ibm.EnDestinationCustomEmailConfigArgs{
		Params: ibm.EnDestinationCustomEmailConfigParamArray{
			&ibm.EnDestinationCustomEmailConfigParamArgs{
				Domain: pulumi.String("string"),
				Dkims: ibm.EnDestinationCustomEmailConfigParamDkimArray{
					&ibm.EnDestinationCustomEmailConfigParamDkimArgs{
						PublicKey:    pulumi.String("string"),
						Selector:     pulumi.String("string"),
						Verification: pulumi.String("string"),
					},
				},
				Spfs: ibm.EnDestinationCustomEmailConfigParamSpfArray{
					&ibm.EnDestinationCustomEmailConfigParamSpfArgs{
						TxtName:      pulumi.String("string"),
						TxtValue:     pulumi.String("string"),
						Verification: pulumi.String("string"),
					},
				},
			},
		},
	},
	Description:                pulumi.String("string"),
	EnDestinationCustomEmailId: pulumi.String("string"),
	IsSandbox:                  pulumi.Bool(false),
	Name:                       pulumi.String("string"),
	VerificationType:           pulumi.String("string"),
})

    resource "ibm_endestinationcustomemail" "enDestinationCustomEmailResource" {
  instance_guid         = "string"
  type                  = "string"
  collect_failed_events = false
  config = {
    params = [{
      "domain" = "string"
      "dkims" = [{
        "publicKey"    = "string"
        "selector"     = "string"
        "verification" = "string"
      }]
      "spfs" = [{
        "txtName"      = "string"
        "txtValue"     = "string"
        "verification" = "string"
      }]
    }]
  }
  description                    = "string"
  en_destination_custom_email_id = "string"
  is_sandbox                     = false
  name                           = "string"
  verification_type              = "string"
}

    var enDestinationCustomEmailResource = new EnDestinationCustomEmail("enDestinationCustomEmailResource", EnDestinationCustomEmailArgs.builder()
    .instanceGuid("string")
    .type("string")
    .collectFailedEvents(false)
    .config(EnDestinationCustomEmailConfigArgs.builder()
        .params(EnDestinationCustomEmailConfigParamArgs.builder()
            .domain("string")
            .dkims(EnDestinationCustomEmailConfigParamDkimArgs.builder()
                .publicKey("string")
                .selector("string")
                .verification("string")
                .build())
            .spfs(EnDestinationCustomEmailConfigParamSpfArgs.builder()
                .txtName("string")
                .txtValue("string")
                .verification("string")
                .build())
            .build())
        .build())
    .description("string")
    .enDestinationCustomEmailId("string")
    .isSandbox(false)
    .name("string")
    .verificationType("string")
    .build());

    en_destination_custom_email_resource = ibm.EnDestinationCustomEmail("enDestinationCustomEmailResource",
    instance_guid="string",
    type="string",
    collect_failed_events=False,
    config={
        "params": [{
            "domain": "string",
            "dkims": [{
                "public_key": "string",
                "selector": "string",
                "verification": "string",
            }],
            "spfs": [{
                "txt_name": "string",
                "txt_value": "string",
                "verification": "string",
            }],
        }],
    },
    description="string",
    en_destination_custom_email_id="string",
    is_sandbox=False,
    name="string",
    verification_type="string")

    const enDestinationCustomEmailResource = new ibm.EnDestinationCustomEmail("enDestinationCustomEmailResource", {
    instanceGuid: "string",
    type: "string",
    collectFailedEvents: false,
    config: {
        params: [{
            domain: "string",
            dkims: [{
                publicKey: "string",
                selector: "string",
                verification: "string",
            }],
            spfs: [{
                txtName: "string",
                txtValue: "string",
                verification: "string",
            }],
        }],
    },
    description: "string",
    enDestinationCustomEmailId: "string",
    isSandbox: false,
    name: "string",
    verificationType: "string",
});

    type: ibm:EnDestinationCustomEmail
properties:
    collectFailedEvents: false
    config:
        params:
            - dkims:
                - publicKey: string
                  selector: string
                  verification: string
              domain: string
              spfs:
                - txtName: string
                  txtValue: string
                  verification: string
    description: string
    enDestinationCustomEmailId: string
    instanceGuid: string
    isSandbox: false
    name: string
    type: string
    verificationType: string

    EnDestinationCustomEmail 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 EnDestinationCustomEmail resource accepts the following input properties:

    InstanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.
    Type string
    smtp_custom.
    CollectFailedEvents bool
    Toggle switch to enable collect failed event in Cloud Object Storage bucket.
    Config EnDestinationCustomEmailConfig

    Payload describing a destination configuration.

    Nested scheme for config:

    Description string
    The Destination description.
    EnDestinationCustomEmailId string
    (String) The unique identifier of the custom_domain_en_destination.
    IsSandbox bool
    Toggle switch to enable sandbox mode. Default value is false.

    • When true: Creates a sandbox destination (smtp_custom_sandbox type) for testing without domain verification
    • When false: Creates a production destination (smtp_custom type) requiring domain verification
    • Upgrade: Can be changed from true to false to upgrade sandbox to production
    • Downgrade: Cannot be changed from false to true (production to sandbox downgrade is not supported)
    • Domain Updates:
    • Sandbox destinations: Domain can be updated at any time
    • Production destinations: Domain is immutable after creation
    Name string
    The Destintion name.
    VerificationType string
    Verification Method spf/dkim.
    InstanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.
    Type string
    smtp_custom.
    CollectFailedEvents bool
    Toggle switch to enable collect failed event in Cloud Object Storage bucket.
    Config EnDestinationCustomEmailConfigArgs

    Payload describing a destination configuration.

    Nested scheme for config:

    Description string
    The Destination description.
    EnDestinationCustomEmailId string
    (String) The unique identifier of the custom_domain_en_destination.
    IsSandbox bool
    Toggle switch to enable sandbox mode. Default value is false.

    • When true: Creates a sandbox destination (smtp_custom_sandbox type) for testing without domain verification
    • When false: Creates a production destination (smtp_custom type) requiring domain verification
    • Upgrade: Can be changed from true to false to upgrade sandbox to production
    • Downgrade: Cannot be changed from false to true (production to sandbox downgrade is not supported)
    • Domain Updates:
    • Sandbox destinations: Domain can be updated at any time
    • Production destinations: Domain is immutable after creation
    Name string
    The Destintion name.
    VerificationType string
    Verification Method spf/dkim.
    instance_guid string
    Unique identifier for IBM Cloud Event Notifications instance.
    type string
    smtp_custom.
    collect_failed_events bool
    Toggle switch to enable collect failed event in Cloud Object Storage bucket.
    config object

    Payload describing a destination configuration.

    Nested scheme for config:

    description string
    The Destination description.
    en_destination_custom_email_id string
    (String) The unique identifier of the custom_domain_en_destination.
    is_sandbox bool
    Toggle switch to enable sandbox mode. Default value is false.

    • When true: Creates a sandbox destination (smtp_custom_sandbox type) for testing without domain verification
    • When false: Creates a production destination (smtp_custom type) requiring domain verification
    • Upgrade: Can be changed from true to false to upgrade sandbox to production
    • Downgrade: Cannot be changed from false to true (production to sandbox downgrade is not supported)
    • Domain Updates:
    • Sandbox destinations: Domain can be updated at any time
    • Production destinations: Domain is immutable after creation
    name string
    The Destintion name.
    verification_type string
    Verification Method spf/dkim.
    instanceGuid String
    Unique identifier for IBM Cloud Event Notifications instance.
    type String
    smtp_custom.
    collectFailedEvents Boolean
    Toggle switch to enable collect failed event in Cloud Object Storage bucket.
    config EnDestinationCustomEmailConfig

    Payload describing a destination configuration.

    Nested scheme for config:

    description String
    The Destination description.
    enDestinationCustomEmailId String
    (String) The unique identifier of the custom_domain_en_destination.
    isSandbox Boolean
    Toggle switch to enable sandbox mode. Default value is false.

    • When true: Creates a sandbox destination (smtp_custom_sandbox type) for testing without domain verification
    • When false: Creates a production destination (smtp_custom type) requiring domain verification
    • Upgrade: Can be changed from true to false to upgrade sandbox to production
    • Downgrade: Cannot be changed from false to true (production to sandbox downgrade is not supported)
    • Domain Updates:
    • Sandbox destinations: Domain can be updated at any time
    • Production destinations: Domain is immutable after creation
    name String
    The Destintion name.
    verificationType String
    Verification Method spf/dkim.
    instanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.
    type string
    smtp_custom.
    collectFailedEvents boolean
    Toggle switch to enable collect failed event in Cloud Object Storage bucket.
    config EnDestinationCustomEmailConfig

    Payload describing a destination configuration.

    Nested scheme for config:

    description string
    The Destination description.
    enDestinationCustomEmailId string
    (String) The unique identifier of the custom_domain_en_destination.
    isSandbox boolean
    Toggle switch to enable sandbox mode. Default value is false.

    • When true: Creates a sandbox destination (smtp_custom_sandbox type) for testing without domain verification
    • When false: Creates a production destination (smtp_custom type) requiring domain verification
    • Upgrade: Can be changed from true to false to upgrade sandbox to production
    • Downgrade: Cannot be changed from false to true (production to sandbox downgrade is not supported)
    • Domain Updates:
    • Sandbox destinations: Domain can be updated at any time
    • Production destinations: Domain is immutable after creation
    name string
    The Destintion name.
    verificationType string
    Verification Method spf/dkim.
    instance_guid str
    Unique identifier for IBM Cloud Event Notifications instance.
    type str
    smtp_custom.
    collect_failed_events bool
    Toggle switch to enable collect failed event in Cloud Object Storage bucket.
    config EnDestinationCustomEmailConfigArgs

    Payload describing a destination configuration.

    Nested scheme for config:

    description str
    The Destination description.
    en_destination_custom_email_id str
    (String) The unique identifier of the custom_domain_en_destination.
    is_sandbox bool
    Toggle switch to enable sandbox mode. Default value is false.

    • When true: Creates a sandbox destination (smtp_custom_sandbox type) for testing without domain verification
    • When false: Creates a production destination (smtp_custom type) requiring domain verification
    • Upgrade: Can be changed from true to false to upgrade sandbox to production
    • Downgrade: Cannot be changed from false to true (production to sandbox downgrade is not supported)
    • Domain Updates:
    • Sandbox destinations: Domain can be updated at any time
    • Production destinations: Domain is immutable after creation
    name str
    The Destintion name.
    verification_type str
    Verification Method spf/dkim.
    instanceGuid String
    Unique identifier for IBM Cloud Event Notifications instance.
    type String
    smtp_custom.
    collectFailedEvents Boolean
    Toggle switch to enable collect failed event in Cloud Object Storage bucket.
    config Property Map

    Payload describing a destination configuration.

    Nested scheme for config:

    description String
    The Destination description.
    enDestinationCustomEmailId String
    (String) The unique identifier of the custom_domain_en_destination.
    isSandbox Boolean
    Toggle switch to enable sandbox mode. Default value is false.

    • When true: Creates a sandbox destination (smtp_custom_sandbox type) for testing without domain verification
    • When false: Creates a production destination (smtp_custom type) requiring domain verification
    • Upgrade: Can be changed from true to false to upgrade sandbox to production
    • Downgrade: Cannot be changed from false to true (production to sandbox downgrade is not supported)
    • Domain Updates:
    • Sandbox destinations: Domain can be updated at any time
    • Production destinations: Domain is immutable after creation
    name String
    The Destintion name.
    verificationType String
    Verification Method spf/dkim.

    Outputs

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

    DestinationId string
    (String) The unique identifier of the created destination.
    Id string
    The provider-assigned unique ID for this managed resource.
    SubscriptionCount double
    (Integer) Number of subscriptions.

    • Constraints: The minimum value is 0.
    SubscriptionNames List<string>
    (List) List of subscriptions.
    UpdatedAt string
    (String) Last updated time.
    DestinationId string
    (String) The unique identifier of the created destination.
    Id string
    The provider-assigned unique ID for this managed resource.
    SubscriptionCount float64
    (Integer) Number of subscriptions.

    • Constraints: The minimum value is 0.
    SubscriptionNames []string
    (List) List of subscriptions.
    UpdatedAt string
    (String) Last updated time.
    destination_id string
    (String) The unique identifier of the created destination.
    id string
    The provider-assigned unique ID for this managed resource.
    subscription_count number
    (Integer) Number of subscriptions.

    • Constraints: The minimum value is 0.
    subscription_names list(string)
    (List) List of subscriptions.
    updated_at string
    (String) Last updated time.
    destinationId String
    (String) The unique identifier of the created destination.
    id String
    The provider-assigned unique ID for this managed resource.
    subscriptionCount Double
    (Integer) Number of subscriptions.

    • Constraints: The minimum value is 0.
    subscriptionNames List<String>
    (List) List of subscriptions.
    updatedAt String
    (String) Last updated time.
    destinationId string
    (String) The unique identifier of the created destination.
    id string
    The provider-assigned unique ID for this managed resource.
    subscriptionCount number
    (Integer) Number of subscriptions.

    • Constraints: The minimum value is 0.
    subscriptionNames string[]
    (List) List of subscriptions.
    updatedAt string
    (String) Last updated time.
    destination_id str
    (String) The unique identifier of the created destination.
    id str
    The provider-assigned unique ID for this managed resource.
    subscription_count float
    (Integer) Number of subscriptions.

    • Constraints: The minimum value is 0.
    subscription_names Sequence[str]
    (List) List of subscriptions.
    updated_at str
    (String) Last updated time.
    destinationId String
    (String) The unique identifier of the created destination.
    id String
    The provider-assigned unique ID for this managed resource.
    subscriptionCount Number
    (Integer) Number of subscriptions.

    • Constraints: The minimum value is 0.
    subscriptionNames List<String>
    (List) List of subscriptions.
    updatedAt String
    (String) Last updated time.

    Look up Existing EnDestinationCustomEmail Resource

    Get an existing EnDestinationCustomEmail 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?: EnDestinationCustomEmailState, opts?: CustomResourceOptions): EnDestinationCustomEmail
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        collect_failed_events: Optional[bool] = None,
        config: Optional[EnDestinationCustomEmailConfigArgs] = None,
        description: Optional[str] = None,
        destination_id: Optional[str] = None,
        en_destination_custom_email_id: Optional[str] = None,
        instance_guid: Optional[str] = None,
        is_sandbox: Optional[bool] = None,
        name: Optional[str] = None,
        subscription_count: Optional[float] = None,
        subscription_names: Optional[Sequence[str]] = None,
        type: Optional[str] = None,
        updated_at: Optional[str] = None,
        verification_type: Optional[str] = None) -> EnDestinationCustomEmail
    func GetEnDestinationCustomEmail(ctx *Context, name string, id IDInput, state *EnDestinationCustomEmailState, opts ...ResourceOption) (*EnDestinationCustomEmail, error)
    public static EnDestinationCustomEmail Get(string name, Input<string> id, EnDestinationCustomEmailState? state, CustomResourceOptions? opts = null)
    public static EnDestinationCustomEmail get(String name, Output<String> id, EnDestinationCustomEmailState state, CustomResourceOptions options)
    resources:  _:    type: ibm:EnDestinationCustomEmail    get:      id: ${id}
    import {
  to = ibm_endestinationcustomemail.example
  id = "${id}"
}
    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:
    CollectFailedEvents bool
    Toggle switch to enable collect failed event in Cloud Object Storage bucket.
    Config EnDestinationCustomEmailConfig

    Payload describing a destination configuration.

    Nested scheme for config:

    Description string
    The Destination description.
    DestinationId string
    (String) The unique identifier of the created destination.
    EnDestinationCustomEmailId string
    (String) The unique identifier of the custom_domain_en_destination.
    InstanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.
    IsSandbox bool
    Toggle switch to enable sandbox mode. Default value is false.

    • When true: Creates a sandbox destination (smtp_custom_sandbox type) for testing without domain verification
    • When false: Creates a production destination (smtp_custom type) requiring domain verification
    • Upgrade: Can be changed from true to false to upgrade sandbox to production
    • Downgrade: Cannot be changed from false to true (production to sandbox downgrade is not supported)
    • Domain Updates:
    • Sandbox destinations: Domain can be updated at any time
    • Production destinations: Domain is immutable after creation
    Name string
    The Destintion name.
    SubscriptionCount double
    (Integer) Number of subscriptions.

    • Constraints: The minimum value is 0.
    SubscriptionNames List<string>
    (List) List of subscriptions.
    Type string
    smtp_custom.
    UpdatedAt string
    (String) Last updated time.
    VerificationType string
    Verification Method spf/dkim.
    CollectFailedEvents bool
    Toggle switch to enable collect failed event in Cloud Object Storage bucket.
    Config EnDestinationCustomEmailConfigArgs

    Payload describing a destination configuration.

    Nested scheme for config:

    Description string
    The Destination description.
    DestinationId string
    (String) The unique identifier of the created destination.
    EnDestinationCustomEmailId string
    (String) The unique identifier of the custom_domain_en_destination.
    InstanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.
    IsSandbox bool
    Toggle switch to enable sandbox mode. Default value is false.

    • When true: Creates a sandbox destination (smtp_custom_sandbox type) for testing without domain verification
    • When false: Creates a production destination (smtp_custom type) requiring domain verification
    • Upgrade: Can be changed from true to false to upgrade sandbox to production
    • Downgrade: Cannot be changed from false to true (production to sandbox downgrade is not supported)
    • Domain Updates:
    • Sandbox destinations: Domain can be updated at any time
    • Production destinations: Domain is immutable after creation
    Name string
    The Destintion name.
    SubscriptionCount float64
    (Integer) Number of subscriptions.

    • Constraints: The minimum value is 0.
    SubscriptionNames []string
    (List) List of subscriptions.
    Type string
    smtp_custom.
    UpdatedAt string
    (String) Last updated time.
    VerificationType string
    Verification Method spf/dkim.
    collect_failed_events bool
    Toggle switch to enable collect failed event in Cloud Object Storage bucket.
    config object

    Payload describing a destination configuration.

    Nested scheme for config:

    description string
    The Destination description.
    destination_id string
    (String) The unique identifier of the created destination.
    en_destination_custom_email_id string
    (String) The unique identifier of the custom_domain_en_destination.
    instance_guid string
    Unique identifier for IBM Cloud Event Notifications instance.
    is_sandbox bool
    Toggle switch to enable sandbox mode. Default value is false.

    • When true: Creates a sandbox destination (smtp_custom_sandbox type) for testing without domain verification
    • When false: Creates a production destination (smtp_custom type) requiring domain verification
    • Upgrade: Can be changed from true to false to upgrade sandbox to production
    • Downgrade: Cannot be changed from false to true (production to sandbox downgrade is not supported)
    • Domain Updates:
    • Sandbox destinations: Domain can be updated at any time
    • Production destinations: Domain is immutable after creation
    name string
    The Destintion name.
    subscription_count number
    (Integer) Number of subscriptions.

    • Constraints: The minimum value is 0.
    subscription_names list(string)
    (List) List of subscriptions.
    type string
    smtp_custom.
    updated_at string
    (String) Last updated time.
    verification_type string
    Verification Method spf/dkim.
    collectFailedEvents Boolean
    Toggle switch to enable collect failed event in Cloud Object Storage bucket.
    config EnDestinationCustomEmailConfig

    Payload describing a destination configuration.

    Nested scheme for config:

    description String
    The Destination description.
    destinationId String
    (String) The unique identifier of the created destination.
    enDestinationCustomEmailId String
    (String) The unique identifier of the custom_domain_en_destination.
    instanceGuid String
    Unique identifier for IBM Cloud Event Notifications instance.
    isSandbox Boolean
    Toggle switch to enable sandbox mode. Default value is false.

    • When true: Creates a sandbox destination (smtp_custom_sandbox type) for testing without domain verification
    • When false: Creates a production destination (smtp_custom type) requiring domain verification
    • Upgrade: Can be changed from true to false to upgrade sandbox to production
    • Downgrade: Cannot be changed from false to true (production to sandbox downgrade is not supported)
    • Domain Updates:
    • Sandbox destinations: Domain can be updated at any time
    • Production destinations: Domain is immutable after creation
    name String
    The Destintion name.
    subscriptionCount Double
    (Integer) Number of subscriptions.

    • Constraints: The minimum value is 0.
    subscriptionNames List<String>
    (List) List of subscriptions.
    type String
    smtp_custom.
    updatedAt String
    (String) Last updated time.
    verificationType String
    Verification Method spf/dkim.
    collectFailedEvents boolean
    Toggle switch to enable collect failed event in Cloud Object Storage bucket.
    config EnDestinationCustomEmailConfig

    Payload describing a destination configuration.

    Nested scheme for config:

    description string
    The Destination description.
    destinationId string
    (String) The unique identifier of the created destination.
    enDestinationCustomEmailId string
    (String) The unique identifier of the custom_domain_en_destination.
    instanceGuid string
    Unique identifier for IBM Cloud Event Notifications instance.
    isSandbox boolean
    Toggle switch to enable sandbox mode. Default value is false.

    • When true: Creates a sandbox destination (smtp_custom_sandbox type) for testing without domain verification
    • When false: Creates a production destination (smtp_custom type) requiring domain verification
    • Upgrade: Can be changed from true to false to upgrade sandbox to production
    • Downgrade: Cannot be changed from false to true (production to sandbox downgrade is not supported)
    • Domain Updates:
    • Sandbox destinations: Domain can be updated at any time
    • Production destinations: Domain is immutable after creation
    name string
    The Destintion name.
    subscriptionCount number
    (Integer) Number of subscriptions.

    • Constraints: The minimum value is 0.
    subscriptionNames string[]
    (List) List of subscriptions.
    type string
    smtp_custom.
    updatedAt string
    (String) Last updated time.
    verificationType string
    Verification Method spf/dkim.
    collect_failed_events bool
    Toggle switch to enable collect failed event in Cloud Object Storage bucket.
    config EnDestinationCustomEmailConfigArgs

    Payload describing a destination configuration.

    Nested scheme for config:

    description str
    The Destination description.
    destination_id str
    (String) The unique identifier of the created destination.
    en_destination_custom_email_id str
    (String) The unique identifier of the custom_domain_en_destination.
    instance_guid str
    Unique identifier for IBM Cloud Event Notifications instance.
    is_sandbox bool
    Toggle switch to enable sandbox mode. Default value is false.

    • When true: Creates a sandbox destination (smtp_custom_sandbox type) for testing without domain verification
    • When false: Creates a production destination (smtp_custom type) requiring domain verification
    • Upgrade: Can be changed from true to false to upgrade sandbox to production
    • Downgrade: Cannot be changed from false to true (production to sandbox downgrade is not supported)
    • Domain Updates:
    • Sandbox destinations: Domain can be updated at any time
    • Production destinations: Domain is immutable after creation
    name str
    The Destintion name.
    subscription_count float
    (Integer) Number of subscriptions.

    • Constraints: The minimum value is 0.
    subscription_names Sequence[str]
    (List) List of subscriptions.
    type str
    smtp_custom.
    updated_at str
    (String) Last updated time.
    verification_type str
    Verification Method spf/dkim.
    collectFailedEvents Boolean
    Toggle switch to enable collect failed event in Cloud Object Storage bucket.
    config Property Map

    Payload describing a destination configuration.

    Nested scheme for config:

    description String
    The Destination description.
    destinationId String
    (String) The unique identifier of the created destination.
    enDestinationCustomEmailId String
    (String) The unique identifier of the custom_domain_en_destination.
    instanceGuid String
    Unique identifier for IBM Cloud Event Notifications instance.
    isSandbox Boolean
    Toggle switch to enable sandbox mode. Default value is false.

    • When true: Creates a sandbox destination (smtp_custom_sandbox type) for testing without domain verification
    • When false: Creates a production destination (smtp_custom type) requiring domain verification
    • Upgrade: Can be changed from true to false to upgrade sandbox to production
    • Downgrade: Cannot be changed from false to true (production to sandbox downgrade is not supported)
    • Domain Updates:
    • Sandbox destinations: Domain can be updated at any time
    • Production destinations: Domain is immutable after creation
    name String
    The Destintion name.
    subscriptionCount Number
    (Integer) Number of subscriptions.

    • Constraints: The minimum value is 0.
    subscriptionNames List<String>
    (List) List of subscriptions.
    type String
    smtp_custom.
    updatedAt String
    (String) Last updated time.
    verificationType String
    Verification Method spf/dkim.

    Supporting Types

    EnDestinationCustomEmailConfig, EnDestinationCustomEmailConfigArgs

    params list(object)
    Nested scheme for params:
    params List<Property Map>
    Nested scheme for params:

    EnDestinationCustomEmailConfigParam, EnDestinationCustomEmailConfigParamArgs

    Domain string
    Domain for the Custom Domain Email Destination
    Dkims List<EnDestinationCustomEmailConfigParamDkim>
    The DKIM attributes.
    Spfs List<EnDestinationCustomEmailConfigParamSpf>
    The SPF attributes.
    Domain string
    Domain for the Custom Domain Email Destination
    Dkims []EnDestinationCustomEmailConfigParamDkim
    The DKIM attributes.
    Spfs []EnDestinationCustomEmailConfigParamSpf
    The SPF attributes.
    domain string
    Domain for the Custom Domain Email Destination
    dkims list(object)
    The DKIM attributes.
    spfs list(object)
    The SPF attributes.
    domain String
    Domain for the Custom Domain Email Destination
    dkims List<EnDestinationCustomEmailConfigParamDkim>
    The DKIM attributes.
    spfs List<EnDestinationCustomEmailConfigParamSpf>
    The SPF attributes.
    domain string
    Domain for the Custom Domain Email Destination
    dkims EnDestinationCustomEmailConfigParamDkim[]
    The DKIM attributes.
    spfs EnDestinationCustomEmailConfigParamSpf[]
    The SPF attributes.
    domain str
    Domain for the Custom Domain Email Destination
    dkims Sequence[EnDestinationCustomEmailConfigParamDkim]
    The DKIM attributes.
    spfs Sequence[EnDestinationCustomEmailConfigParamSpf]
    The SPF attributes.
    domain String
    Domain for the Custom Domain Email Destination
    dkims List<Property Map>
    The DKIM attributes.
    spfs List<Property Map>
    The SPF attributes.

    EnDestinationCustomEmailConfigParamDkim, EnDestinationCustomEmailConfigParamDkimArgs

    PublicKey string
    dkim public key.

    • Constraints: The maximum length is 500 characters. The minimum length is 1 character. The value must match regular expression /.*/.
    Selector string
    dkim selector.

    • Constraints: The maximum length is 500 characters. The minimum length is 1 character. The value must match regular expression /.*/.
    Verification string
    PublicKey string
    dkim public key.

    • Constraints: The maximum length is 500 characters. The minimum length is 1 character. The value must match regular expression /.*/.
    Selector string
    dkim selector.

    • Constraints: The maximum length is 500 characters. The minimum length is 1 character. The value must match regular expression /.*/.
    Verification string
    public_key string
    dkim public key.

    • Constraints: The maximum length is 500 characters. The minimum length is 1 character. The value must match regular expression /.*/.
    selector string
    dkim selector.

    • Constraints: The maximum length is 500 characters. The minimum length is 1 character. The value must match regular expression /.*/.
    verification string
    publicKey String
    dkim public key.

    • Constraints: The maximum length is 500 characters. The minimum length is 1 character. The value must match regular expression /.*/.
    selector String
    dkim selector.

    • Constraints: The maximum length is 500 characters. The minimum length is 1 character. The value must match regular expression /.*/.
    verification String
    publicKey string
    dkim public key.

    • Constraints: The maximum length is 500 characters. The minimum length is 1 character. The value must match regular expression /.*/.
    selector string
    dkim selector.

    • Constraints: The maximum length is 500 characters. The minimum length is 1 character. The value must match regular expression /.*/.
    verification string
    public_key str
    dkim public key.

    • Constraints: The maximum length is 500 characters. The minimum length is 1 character. The value must match regular expression /.*/.
    selector str
    dkim selector.

    • Constraints: The maximum length is 500 characters. The minimum length is 1 character. The value must match regular expression /.*/.
    verification str
    publicKey String
    dkim public key.

    • Constraints: The maximum length is 500 characters. The minimum length is 1 character. The value must match regular expression /.*/.
    selector String
    dkim selector.

    • Constraints: The maximum length is 500 characters. The minimum length is 1 character. The value must match regular expression /.*/.
    verification String

    EnDestinationCustomEmailConfigParamSpf, EnDestinationCustomEmailConfigParamSpfArgs

    TxtName string
    spf text name.

    • Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /.*/.
    TxtValue string
    spf text value.

    • Constraints: The maximum length is 500 characters. The minimum length is 1 character. The value must match regular expression /.*/.
    Verification string
    TxtName string
    spf text name.

    • Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /.*/.
    TxtValue string
    spf text value.

    • Constraints: The maximum length is 500 characters. The minimum length is 1 character. The value must match regular expression /.*/.
    Verification string
    txt_name string
    spf text name.

    • Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /.*/.
    txt_value string
    spf text value.

    • Constraints: The maximum length is 500 characters. The minimum length is 1 character. The value must match regular expression /.*/.
    verification string
    txtName String
    spf text name.

    • Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /.*/.
    txtValue String
    spf text value.

    • Constraints: The maximum length is 500 characters. The minimum length is 1 character. The value must match regular expression /.*/.
    verification String
    txtName string
    spf text name.

    • Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /.*/.
    txtValue string
    spf text value.

    • Constraints: The maximum length is 500 characters. The minimum length is 1 character. The value must match regular expression /.*/.
    verification string
    txt_name str
    spf text name.

    • Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /.*/.
    txt_value str
    spf text value.

    • Constraints: The maximum length is 500 characters. The minimum length is 1 character. The value must match regular expression /.*/.
    verification str
    txtName String
    spf text name.

    • Constraints: The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /.*/.
    txtValue String
    spf text value.

    • Constraints: The maximum length is 500 characters. The minimum length is 1 character. The value must match regular expression /.*/.
    verification String

    Import

    You can import the ibm_en_destination_custom_email resource by using id.

    The id property can be formed from instance_guid, and destination_id in the following format:

    <instance_guid>/<destination_id>

    • instance_guid: A string. Unique identifier for IBM Cloud Event Notifications instance.

    • destination_id: A string. Unique identifier for Destination.

    Example

    $ pulumi import ibm:index/enDestinationCustomEmail:EnDestinationCustomEmail custom_domain_email_en_destination <instance_guid>/<destination_id>

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

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    Viewing docs for ibm 2.3.0-beta0
    published on Monday, Jun 15, 2026 by ibm-cloud
    Schema (JSON)
    ibm-cloud/terraform-provider-ibm

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial