published on Sunday, Oct 11, 2026 by Descope
published on Sunday, Oct 11, 2026 by Descope
Manages a SMTP connector and its configuration in a Descope project. A general purpose SMTP connector for sending emails through your own mail server.
Create SmtpConnector Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SmtpConnector(name: string, args: SmtpConnectorArgs, opts?: CustomResourceOptions);@overload
def SmtpConnector(resource_name: str,
args: SmtpConnectorArgs,
opts: Optional[ResourceOptions] = None)
@overload
def SmtpConnector(resource_name: str,
opts: Optional[ResourceOptions] = None,
host: Optional[str] = None,
password: Optional[str] = None,
project_id: Optional[str] = None,
sender_email: Optional[str] = None,
username: Optional[str] = None,
auth_method: Optional[str] = None,
description: Optional[str] = None,
name: Optional[str] = None,
port: Optional[float] = None,
sender_name: Optional[str] = None,
use_static_ips: Optional[bool] = None)func NewSmtpConnector(ctx *Context, name string, args SmtpConnectorArgs, opts ...ResourceOption) (*SmtpConnector, error)public SmtpConnector(string name, SmtpConnectorArgs args, CustomResourceOptions? opts = null)
public SmtpConnector(String name, SmtpConnectorArgs args)
public SmtpConnector(String name, SmtpConnectorArgs args, CustomResourceOptions options)
type: descope:SmtpConnector
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "descope_smtp_connector" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args SmtpConnectorArgs
- 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 SmtpConnectorArgs
- 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 SmtpConnectorArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SmtpConnectorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SmtpConnectorArgs
- 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 smtpConnectorResource = new Descope.SmtpConnector("smtpConnectorResource", new()
{
Host = "string",
Password = "string",
ProjectId = "string",
SenderEmail = "string",
Username = "string",
AuthMethod = "string",
Description = "string",
Name = "string",
Port = 0.0,
SenderName = "string",
UseStaticIps = false,
});
example, err := descope.NewSmtpConnector(ctx, "smtpConnectorResource", &descope.SmtpConnectorArgs{
Host: pulumi.String("string"),
Password: pulumi.String("string"),
ProjectId: pulumi.String("string"),
SenderEmail: pulumi.String("string"),
Username: pulumi.String("string"),
AuthMethod: pulumi.String("string"),
Description: pulumi.String("string"),
Name: pulumi.String("string"),
Port: pulumi.Float64(0),
SenderName: pulumi.String("string"),
UseStaticIps: pulumi.Bool(false),
})
resource "descope_smtp_connector" "smtpConnectorResource" {
lifecycle {
create_before_destroy = true
}
host = "string"
password = "string"
project_id = "string"
sender_email = "string"
username = "string"
auth_method = "string"
description = "string"
name = "string"
port = 0
sender_name = "string"
use_static_ips = false
}
var smtpConnectorResource = new SmtpConnector("smtpConnectorResource", SmtpConnectorArgs.builder()
.host("string")
.password("string")
.projectId("string")
.senderEmail("string")
.username("string")
.authMethod("string")
.description("string")
.name("string")
.port(0.0)
.senderName("string")
.useStaticIps(false)
.build());
smtp_connector_resource = descope.SmtpConnector("smtpConnectorResource",
host="string",
password="string",
project_id="string",
sender_email="string",
username="string",
auth_method="string",
description="string",
name="string",
port=float(0),
sender_name="string",
use_static_ips=False)
const smtpConnectorResource = new descope.SmtpConnector("smtpConnectorResource", {
host: "string",
password: "string",
projectId: "string",
senderEmail: "string",
username: "string",
authMethod: "string",
description: "string",
name: "string",
port: 0,
senderName: "string",
useStaticIps: false,
});
type: descope:SmtpConnector
properties:
authMethod: string
description: string
host: string
name: string
password: string
port: 0
projectId: string
senderEmail: string
senderName: string
useStaticIps: false
username: string
SmtpConnector 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 SmtpConnector resource accepts the following input properties:
- Host string
- The hostname or IP address of the SMTP server.
- Password string
- The password used to authenticate with the SMTP server.
- Project
Id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- Sender
Email string - The email address that emails are sent from. Make sure it is properly registered with your server.
- Username string
- The username used to authenticate with the SMTP server.
- Auth
Method string - The authentication method to use when connecting to the SMTP server.
- Description string
- A description of what your connector is used for.
- Name string
- A custom name for your connector.
- Port double
- The port the SMTP server listens on.
- Sender
Name string - The name shown as the sender of the emails.
- Use
Static boolIps - Whether the connector should send all requests from specific static IPs.
- Host string
- The hostname or IP address of the SMTP server.
- Password string
- The password used to authenticate with the SMTP server.
- Project
Id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- Sender
Email string - The email address that emails are sent from. Make sure it is properly registered with your server.
- Username string
- The username used to authenticate with the SMTP server.
- Auth
Method string - The authentication method to use when connecting to the SMTP server.
- Description string
- A description of what your connector is used for.
- Name string
- A custom name for your connector.
- Port float64
- The port the SMTP server listens on.
- Sender
Name string - The name shown as the sender of the emails.
- Use
Static boolIps - Whether the connector should send all requests from specific static IPs.
- host string
- The hostname or IP address of the SMTP server.
- password string
- The password used to authenticate with the SMTP server.
- project_
id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- sender_
email string - The email address that emails are sent from. Make sure it is properly registered with your server.
- username string
- The username used to authenticate with the SMTP server.
- auth_
method string - The authentication method to use when connecting to the SMTP server.
- description string
- A description of what your connector is used for.
- name string
- A custom name for your connector.
- port number
- The port the SMTP server listens on.
- sender_
name string - The name shown as the sender of the emails.
- use_
static_ boolips - Whether the connector should send all requests from specific static IPs.
- host String
- The hostname or IP address of the SMTP server.
- password String
- The password used to authenticate with the SMTP server.
- project
Id String - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- sender
Email String - The email address that emails are sent from. Make sure it is properly registered with your server.
- username String
- The username used to authenticate with the SMTP server.
- auth
Method String - The authentication method to use when connecting to the SMTP server.
- description String
- A description of what your connector is used for.
- name String
- A custom name for your connector.
- port Double
- The port the SMTP server listens on.
- sender
Name String - The name shown as the sender of the emails.
- use
Static BooleanIps - Whether the connector should send all requests from specific static IPs.
- host string
- The hostname or IP address of the SMTP server.
- password string
- The password used to authenticate with the SMTP server.
- project
Id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- sender
Email string - The email address that emails are sent from. Make sure it is properly registered with your server.
- username string
- The username used to authenticate with the SMTP server.
- auth
Method string - The authentication method to use when connecting to the SMTP server.
- description string
- A description of what your connector is used for.
- name string
- A custom name for your connector.
- port number
- The port the SMTP server listens on.
- sender
Name string - The name shown as the sender of the emails.
- use
Static booleanIps - Whether the connector should send all requests from specific static IPs.
- host str
- The hostname or IP address of the SMTP server.
- password str
- The password used to authenticate with the SMTP server.
- project_
id str - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- sender_
email str - The email address that emails are sent from. Make sure it is properly registered with your server.
- username str
- The username used to authenticate with the SMTP server.
- auth_
method str - The authentication method to use when connecting to the SMTP server.
- description str
- A description of what your connector is used for.
- name str
- A custom name for your connector.
- port float
- The port the SMTP server listens on.
- sender_
name str - The name shown as the sender of the emails.
- use_
static_ boolips - Whether the connector should send all requests from specific static IPs.
- host String
- The hostname or IP address of the SMTP server.
- password String
- The password used to authenticate with the SMTP server.
- project
Id String - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- sender
Email String - The email address that emails are sent from. Make sure it is properly registered with your server.
- username String
- The username used to authenticate with the SMTP server.
- auth
Method String - The authentication method to use when connecting to the SMTP server.
- description String
- A description of what your connector is used for.
- name String
- A custom name for your connector.
- port Number
- The port the SMTP server listens on.
- sender
Name String - The name shown as the sender of the emails.
- use
Static BooleanIps - Whether the connector should send all requests from specific static IPs.
Outputs
All input properties are implicitly available as output properties. Additionally, the SmtpConnector 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 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 SmtpConnector Resource
Get an existing SmtpConnector 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?: SmtpConnectorState, opts?: CustomResourceOptions): SmtpConnector@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
auth_method: Optional[str] = None,
description: Optional[str] = None,
host: Optional[str] = None,
name: Optional[str] = None,
password: Optional[str] = None,
port: Optional[float] = None,
project_id: Optional[str] = None,
sender_email: Optional[str] = None,
sender_name: Optional[str] = None,
use_static_ips: Optional[bool] = None,
username: Optional[str] = None) -> SmtpConnectorfunc GetSmtpConnector(ctx *Context, name string, id IDInput, state *SmtpConnectorState, opts ...ResourceOption) (*SmtpConnector, error)public static SmtpConnector Get(string name, Input<string> id, SmtpConnectorState? state, CustomResourceOptions? opts = null)public static SmtpConnector get(String name, Output<String> id, SmtpConnectorState state, CustomResourceOptions options)resources: existingSmtpConnector: type: descope:SmtpConnector get: id: ${id}import {
to = descope_smtp_connector.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- state SmtpConnectorState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- 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 resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state SmtpConnectorState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- state SmtpConnectorState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- state SmtpConnectorState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
- Auth
Method string - The authentication method to use when connecting to the SMTP server.
- Description string
- A description of what your connector is used for.
- Host string
- The hostname or IP address of the SMTP server.
- Name string
- A custom name for your connector.
- Password string
- The password used to authenticate with the SMTP server.
- Port double
- The port the SMTP server listens on.
- Project
Id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- Sender
Email string - The email address that emails are sent from. Make sure it is properly registered with your server.
- Sender
Name string - The name shown as the sender of the emails.
- Use
Static boolIps - Whether the connector should send all requests from specific static IPs.
- Username string
- The username used to authenticate with the SMTP server.
- Auth
Method string - The authentication method to use when connecting to the SMTP server.
- Description string
- A description of what your connector is used for.
- Host string
- The hostname or IP address of the SMTP server.
- Name string
- A custom name for your connector.
- Password string
- The password used to authenticate with the SMTP server.
- Port float64
- The port the SMTP server listens on.
- Project
Id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- Sender
Email string - The email address that emails are sent from. Make sure it is properly registered with your server.
- Sender
Name string - The name shown as the sender of the emails.
- Use
Static boolIps - Whether the connector should send all requests from specific static IPs.
- Username string
- The username used to authenticate with the SMTP server.
- auth_
method string - The authentication method to use when connecting to the SMTP server.
- description string
- A description of what your connector is used for.
- host string
- The hostname or IP address of the SMTP server.
- name string
- A custom name for your connector.
- password string
- The password used to authenticate with the SMTP server.
- port number
- The port the SMTP server listens on.
- project_
id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- sender_
email string - The email address that emails are sent from. Make sure it is properly registered with your server.
- sender_
name string - The name shown as the sender of the emails.
- use_
static_ boolips - Whether the connector should send all requests from specific static IPs.
- username string
- The username used to authenticate with the SMTP server.
- auth
Method String - The authentication method to use when connecting to the SMTP server.
- description String
- A description of what your connector is used for.
- host String
- The hostname or IP address of the SMTP server.
- name String
- A custom name for your connector.
- password String
- The password used to authenticate with the SMTP server.
- port Double
- The port the SMTP server listens on.
- project
Id String - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- sender
Email String - The email address that emails are sent from. Make sure it is properly registered with your server.
- sender
Name String - The name shown as the sender of the emails.
- use
Static BooleanIps - Whether the connector should send all requests from specific static IPs.
- username String
- The username used to authenticate with the SMTP server.
- auth
Method string - The authentication method to use when connecting to the SMTP server.
- description string
- A description of what your connector is used for.
- host string
- The hostname or IP address of the SMTP server.
- name string
- A custom name for your connector.
- password string
- The password used to authenticate with the SMTP server.
- port number
- The port the SMTP server listens on.
- project
Id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- sender
Email string - The email address that emails are sent from. Make sure it is properly registered with your server.
- sender
Name string - The name shown as the sender of the emails.
- use
Static booleanIps - Whether the connector should send all requests from specific static IPs.
- username string
- The username used to authenticate with the SMTP server.
- auth_
method str - The authentication method to use when connecting to the SMTP server.
- description str
- A description of what your connector is used for.
- host str
- The hostname or IP address of the SMTP server.
- name str
- A custom name for your connector.
- password str
- The password used to authenticate with the SMTP server.
- port float
- The port the SMTP server listens on.
- project_
id str - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- sender_
email str - The email address that emails are sent from. Make sure it is properly registered with your server.
- sender_
name str - The name shown as the sender of the emails.
- use_
static_ boolips - Whether the connector should send all requests from specific static IPs.
- username str
- The username used to authenticate with the SMTP server.
- auth
Method String - The authentication method to use when connecting to the SMTP server.
- description String
- A description of what your connector is used for.
- host String
- The hostname or IP address of the SMTP server.
- name String
- A custom name for your connector.
- password String
- The password used to authenticate with the SMTP server.
- port Number
- The port the SMTP server listens on.
- project
Id String - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- sender
Email String - The email address that emails are sent from. Make sure it is properly registered with your server.
- sender
Name String - The name shown as the sender of the emails.
- use
Static BooleanIps - Whether the connector should send all requests from specific static IPs.
- username String
- The username used to authenticate with the SMTP server.
Package Details
- Repository
- descope descope/pulumi-descope
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
descopeTerraform Provider.
published on Sunday, Oct 11, 2026 by Descope