Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Okta Provider
  3. API Docs
  4. EmailSmtpServer
Okta v5.2.0 published on Thursday, Sep 4, 2025 by Pulumi
pulumi/pulumi-okta

okta.EmailSmtpServer

Explore with Pulumi AI

okta logo
Okta v5.2.0 published on Thursday, Sep 4, 2025 by Pulumi
pulumi/pulumi-okta

    Create and configure SMTP email server configuration for your org.

    Example Usage

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

const example = new okta.EmailSmtpServer("example", {
    alias: "CustomServer",
    host: "192.168.160.1",
    port: 8086,
    username: "abcd",
    enabled: false,
    password: "pwd",
});

    import pulumi
import pulumi_okta as okta

example = okta.EmailSmtpServer("example",
    alias="CustomServer",
    host="192.168.160.1",
    port=8086,
    username="abcd",
    enabled=False,
    password="pwd")

    package main

import (
	"github.com/pulumi/pulumi-okta/sdk/v5/go/okta"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := okta.NewEmailSmtpServer(ctx, "example", &okta.EmailSmtpServerArgs{
			Alias:    pulumi.String("CustomServer"),
			Host:     pulumi.String("192.168.160.1"),
			Port:     pulumi.Int(8086),
			Username: pulumi.String("abcd"),
			Enabled:  pulumi.Bool(false),
			Password: pulumi.String("pwd"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Okta.EmailSmtpServer("example", new()
    {
        Alias = "CustomServer",
        Host = "192.168.160.1",
        Port = 8086,
        Username = "abcd",
        Enabled = false,
        Password = "pwd",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.EmailSmtpServer;
import com.pulumi.okta.EmailSmtpServerArgs;
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 example = new EmailSmtpServer("example", EmailSmtpServerArgs.builder()
            .alias("CustomServer")
            .host("192.168.160.1")
            .port(8086)
            .username("abcd")
            .enabled(false)
            .password("pwd")
            .build());

    }
}

    resources:
  example:
    type: okta:EmailSmtpServer
    properties:
      alias: CustomServer
      host: 192.168.160.1
      port: 8086
      username: abcd
      enabled: false
      password: pwd

    Create EmailSmtpServer Resource

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

    Constructor syntax

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

@overload
def EmailSmtpServer(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    alias: Optional[str] = None,
                    host: Optional[str] = None,
                    password: Optional[str] = None,
                    port: Optional[int] = None,
                    username: Optional[str] = None,
                    enabled: Optional[bool] = None)
    func NewEmailSmtpServer(ctx *Context, name string, args EmailSmtpServerArgs, opts ...ResourceOption) (*EmailSmtpServer, error)
    public EmailSmtpServer(string name, EmailSmtpServerArgs args, CustomResourceOptions? opts = null)
    public EmailSmtpServer(String name, EmailSmtpServerArgs args)
public EmailSmtpServer(String name, EmailSmtpServerArgs args, CustomResourceOptions options)

    type: okta:EmailSmtpServer
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 EmailSmtpServerArgs
    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 EmailSmtpServerArgs
    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 EmailSmtpServerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EmailSmtpServerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EmailSmtpServerArgs
    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 emailSmtpServerResource = new Okta.EmailSmtpServer("emailSmtpServerResource", new()
{
    Alias = "string",
    Host = "string",
    Password = "string",
    Port = 0,
    Username = "string",
    Enabled = false,
});

    example, err := okta.NewEmailSmtpServer(ctx, "emailSmtpServerResource", &okta.EmailSmtpServerArgs{
	Alias:    pulumi.String("string"),
	Host:     pulumi.String("string"),
	Password: pulumi.String("string"),
	Port:     pulumi.Int(0),
	Username: pulumi.String("string"),
	Enabled:  pulumi.Bool(false),
})

    var emailSmtpServerResource = new EmailSmtpServer("emailSmtpServerResource", EmailSmtpServerArgs.builder()
    .alias("string")
    .host("string")
    .password("string")
    .port(0)
    .username("string")
    .enabled(false)
    .build());

    email_smtp_server_resource = okta.EmailSmtpServer("emailSmtpServerResource",
    alias="string",
    host="string",
    password="string",
    port=0,
    username="string",
    enabled=False)

    const emailSmtpServerResource = new okta.EmailSmtpServer("emailSmtpServerResource", {
    alias: "string",
    host: "string",
    password: "string",
    port: 0,
    username: "string",
    enabled: false,
});

    type: okta:EmailSmtpServer
properties:
    alias: string
    enabled: false
    host: string
    password: string
    port: 0
    username: string

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

    Alias string
    Human-readable name for your SMTP server
    Host string
    Hostname or IP address of your SMTP server
    Password string
    Password used to access your SMTP server
    Port int
    Port number of your SMTP server
    Username string
    Username used to access your SMTP server
    Enabled bool
    If true, routes all email traffic through your SMTP server.Default: false
    Alias string
    Human-readable name for your SMTP server
    Host string
    Hostname or IP address of your SMTP server
    Password string
    Password used to access your SMTP server
    Port int
    Port number of your SMTP server
    Username string
    Username used to access your SMTP server
    Enabled bool
    If true, routes all email traffic through your SMTP server.Default: false
    alias String
    Human-readable name for your SMTP server
    host String
    Hostname or IP address of your SMTP server
    password String
    Password used to access your SMTP server
    port Integer
    Port number of your SMTP server
    username String
    Username used to access your SMTP server
    enabled Boolean
    If true, routes all email traffic through your SMTP server.Default: false
    alias string
    Human-readable name for your SMTP server
    host string
    Hostname or IP address of your SMTP server
    password string
    Password used to access your SMTP server
    port number
    Port number of your SMTP server
    username string
    Username used to access your SMTP server
    enabled boolean
    If true, routes all email traffic through your SMTP server.Default: false
    alias str
    Human-readable name for your SMTP server
    host str
    Hostname or IP address of your SMTP server
    password str
    Password used to access your SMTP server
    port int
    Port number of your SMTP server
    username str
    Username used to access your SMTP server
    enabled bool
    If true, routes all email traffic through your SMTP server.Default: false
    alias String
    Human-readable name for your SMTP server
    host String
    Hostname or IP address of your SMTP server
    password String
    Password used to access your SMTP server
    port Number
    Port number of your SMTP server
    username String
    Username used to access your SMTP server
    enabled Boolean
    If true, routes all email traffic through your SMTP server.Default: false

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing EmailSmtpServer Resource

    Get an existing EmailSmtpServer 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?: EmailSmtpServerState, opts?: CustomResourceOptions): EmailSmtpServer
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        alias: Optional[str] = None,
        enabled: Optional[bool] = None,
        host: Optional[str] = None,
        password: Optional[str] = None,
        port: Optional[int] = None,
        username: Optional[str] = None) -> EmailSmtpServer
    func GetEmailSmtpServer(ctx *Context, name string, id IDInput, state *EmailSmtpServerState, opts ...ResourceOption) (*EmailSmtpServer, error)
    public static EmailSmtpServer Get(string name, Input<string> id, EmailSmtpServerState? state, CustomResourceOptions? opts = null)
    public static EmailSmtpServer get(String name, Output<String> id, EmailSmtpServerState state, CustomResourceOptions options)
    resources:  _:    type: okta:EmailSmtpServer    get:      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:
    Alias string
    Human-readable name for your SMTP server
    Enabled bool
    If true, routes all email traffic through your SMTP server.Default: false
    Host string
    Hostname or IP address of your SMTP server
    Password string
    Password used to access your SMTP server
    Port int
    Port number of your SMTP server
    Username string
    Username used to access your SMTP server
    Alias string
    Human-readable name for your SMTP server
    Enabled bool
    If true, routes all email traffic through your SMTP server.Default: false
    Host string
    Hostname or IP address of your SMTP server
    Password string
    Password used to access your SMTP server
    Port int
    Port number of your SMTP server
    Username string
    Username used to access your SMTP server
    alias String
    Human-readable name for your SMTP server
    enabled Boolean
    If true, routes all email traffic through your SMTP server.Default: false
    host String
    Hostname or IP address of your SMTP server
    password String
    Password used to access your SMTP server
    port Integer
    Port number of your SMTP server
    username String
    Username used to access your SMTP server
    alias string
    Human-readable name for your SMTP server
    enabled boolean
    If true, routes all email traffic through your SMTP server.Default: false
    host string
    Hostname or IP address of your SMTP server
    password string
    Password used to access your SMTP server
    port number
    Port number of your SMTP server
    username string
    Username used to access your SMTP server
    alias str
    Human-readable name for your SMTP server
    enabled bool
    If true, routes all email traffic through your SMTP server.Default: false
    host str
    Hostname or IP address of your SMTP server
    password str
    Password used to access your SMTP server
    port int
    Port number of your SMTP server
    username str
    Username used to access your SMTP server
    alias String
    Human-readable name for your SMTP server
    enabled Boolean
    If true, routes all email traffic through your SMTP server.Default: false
    host String
    Hostname or IP address of your SMTP server
    password String
    Password used to access your SMTP server
    port Number
    Port number of your SMTP server
    username String
    Username used to access your SMTP server

    Package Details

    Repository
    Okta pulumi/pulumi-okta
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the okta Terraform Provider.
    okta logo
    Okta v5.2.0 published on Thursday, Sep 4, 2025 by Pulumi
    pulumi/pulumi-okta