Email

With Auth0, you can have standard welcome, password reset, and account verification email-based workflows built right into Auth0. This resource allows you to configure email providers so you can route all emails that are part of Auth0’s authentication workflows through the supported high-volume email service of your choice.

Example Usage

using Pulumi;
using Auth0 = Pulumi.Auth0;

class MyStack : Stack
{
    public MyStack()
    {
        var myEmailProvider = new Auth0.Email("myEmailProvider", new Auth0.EmailArgs
        {
            Credentials = new Auth0.Inputs.EmailCredentialsArgs
            {
                AccessKeyId = "AKIAXXXXXXXXXXXXXXXX",
                Region = "us-east-1",
                SecretAccessKey = "7e8c2148xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
            },
            DefaultFromAddress = "accounts@example.com",
            Enabled = true,
        });
    }

}

Coming soon!

import pulumi
import pulumi_auth0 as auth0

my_email_provider = auth0.Email("myEmailProvider",
    credentials={
        "accessKeyId": "AKIAXXXXXXXXXXXXXXXX",
        "region": "us-east-1",
        "secretAccessKey": "7e8c2148xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    },
    default_from_address="accounts@example.com",
    enabled=True)

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

const myEmailProvider = new auth0.Email("my_email_provider", {
    credentials: {
        accessKeyId: "AKIAXXXXXXXXXXXXXXXX",
        region: "us-east-1",
        secretAccessKey: "7e8c2148xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    },
    defaultFromAddress: "accounts@example.com",
    enabled: true,
});

Create a Email Resource

new Email(name: string, args: EmailArgs, opts?: CustomResourceOptions);

def Email(resource_name, opts=None, credentials=None, default_from_address=None, enabled=None, name=None, __props__=None);

func NewEmail(ctx *Context, name string, args EmailArgs, opts ...ResourceOption) (*Email, error)

public Email(string name, EmailArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args EmailArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args EmailArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args EmailArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Email Resource Properties

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

Inputs

The Email resource accepts the following input properties:

Credentials EmailCredentialsArgs: List(Resource). Configuration settings for the credentials for the email provider. For details, see Credentials.
DefaultFromAddress string: String. Email address to use as the sender when no other “from” address is specified.
Enabled bool: Boolean. Indicates whether or not the email provider is enabled.
Name string: String. Name of the email provider. Options include mailgun, mandrill, sendgrid, ses, smtp, and sparkpost.

Credentials EmailCredentials: List(Resource). Configuration settings for the credentials for the email provider. For details, see Credentials.
DefaultFromAddress string: String. Email address to use as the sender when no other “from” address is specified.
Enabled bool: Boolean. Indicates whether or not the email provider is enabled.
Name string: String. Name of the email provider. Options include mailgun, mandrill, sendgrid, ses, smtp, and sparkpost.

credentials EmailCredentials: List(Resource). Configuration settings for the credentials for the email provider. For details, see Credentials.
defaultFromAddress string: String. Email address to use as the sender when no other “from” address is specified.
enabled boolean: Boolean. Indicates whether or not the email provider is enabled.
name string: String. Name of the email provider. Options include mailgun, mandrill, sendgrid, ses, smtp, and sparkpost.

credentials Dict[EmailCredentials]: List(Resource). Configuration settings for the credentials for the email provider. For details, see Credentials.
default_from_address str: String. Email address to use as the sender when no other “from” address is specified.
enabled bool: Boolean. Indicates whether or not the email provider is enabled.
name str: String. Name of the email provider. Options include mailgun, mandrill, sendgrid, ses, smtp, and sparkpost.

Outputs

All input properties are implicitly available as output properties. Additionally, the Email 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 str: The provider-assigned unique ID for this managed resource.

Look up an Existing Email Resource

Get an existing Email 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?: EmailState, opts?: CustomResourceOptions): Email

static get(resource_name, id, opts=None, credentials=None, default_from_address=None, enabled=None, name=None, __props__=None);

func GetEmail(ctx *Context, name string, id IDInput, state *EmailState, opts ...ResourceOption) (*Email, error)

public static Email Get(string name, Input<string> id, EmailState? state, CustomResourceOptions? opts = null)

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.

The following state arguments are supported:

Credentials EmailCredentialsArgs: List(Resource). Configuration settings for the credentials for the email provider. For details, see Credentials.
DefaultFromAddress string: String. Email address to use as the sender when no other “from” address is specified.
Enabled bool: Boolean. Indicates whether or not the email provider is enabled.
Name string: String. Name of the email provider. Options include mailgun, mandrill, sendgrid, ses, smtp, and sparkpost.

Credentials EmailCredentials: List(Resource). Configuration settings for the credentials for the email provider. For details, see Credentials.
DefaultFromAddress string: String. Email address to use as the sender when no other “from” address is specified.
Enabled bool: Boolean. Indicates whether or not the email provider is enabled.
Name string: String. Name of the email provider. Options include mailgun, mandrill, sendgrid, ses, smtp, and sparkpost.

credentials EmailCredentials: List(Resource). Configuration settings for the credentials for the email provider. For details, see Credentials.
defaultFromAddress string: String. Email address to use as the sender when no other “from” address is specified.
enabled boolean: Boolean. Indicates whether or not the email provider is enabled.
name string: String. Name of the email provider. Options include mailgun, mandrill, sendgrid, ses, smtp, and sparkpost.

credentials Dict[EmailCredentials]: List(Resource). Configuration settings for the credentials for the email provider. For details, see Credentials.
default_from_address str: String. Email address to use as the sender when no other “from” address is specified.
enabled bool: Boolean. Indicates whether or not the email provider is enabled.
name str: String. Name of the email provider. Options include mailgun, mandrill, sendgrid, ses, smtp, and sparkpost.

Supporting Types

EmailCredentials

See the input and output API doc for this type.

AccessKeyId string: String, Case-sensitive. AWS Access Key ID. Used only for AWS.
ApiKey string: String, Case-sensitive. API Key for your email service. Will always be encrypted in our database.
ApiUser string: String. API User for your email service.
Domain string
Region string: String. Default region. Used only for AWS, Mailgun, and SparkPost.
SecretAccessKey string: String, Case-sensitive. AWS Secret Key. Will always be encrypted in our database. Used only for AWS.
SmtpHost string: String. Hostname or IP address of your SMTP server. Used only for SMTP.
SmtpPass string: String, Case-sensitive. SMTP password. Used only for SMTP.
SmtpPort int: Integer. Port used by your SMTP server. Please avoid using port 25 if possible because many providers have limitations on this port. Used only for SMTP.
SmtpUser string: String. SMTP username. Used only for SMTP.

AccessKeyId string: String, Case-sensitive. AWS Access Key ID. Used only for AWS.
ApiKey string: String, Case-sensitive. API Key for your email service. Will always be encrypted in our database.
ApiUser string: String. API User for your email service.
Domain string
Region string: String. Default region. Used only for AWS, Mailgun, and SparkPost.
SecretAccessKey string: String, Case-sensitive. AWS Secret Key. Will always be encrypted in our database. Used only for AWS.
SmtpHost string: String. Hostname or IP address of your SMTP server. Used only for SMTP.
SmtpPass string: String, Case-sensitive. SMTP password. Used only for SMTP.
SmtpPort int: Integer. Port used by your SMTP server. Please avoid using port 25 if possible because many providers have limitations on this port. Used only for SMTP.
SmtpUser string: String. SMTP username. Used only for SMTP.

accessKeyId string: String, Case-sensitive. AWS Access Key ID. Used only for AWS.
apiKey string: String, Case-sensitive. API Key for your email service. Will always be encrypted in our database.
apiUser string: String. API User for your email service.
domain string
region string: String. Default region. Used only for AWS, Mailgun, and SparkPost.
secretAccessKey string: String, Case-sensitive. AWS Secret Key. Will always be encrypted in our database. Used only for AWS.
smtpHost string: String. Hostname or IP address of your SMTP server. Used only for SMTP.
smtpPass string: String, Case-sensitive. SMTP password. Used only for SMTP.
smtpPort number: Integer. Port used by your SMTP server. Please avoid using port 25 if possible because many providers have limitations on this port. Used only for SMTP.
smtpUser string: String. SMTP username. Used only for SMTP.

accessKeyId str: String, Case-sensitive. AWS Access Key ID. Used only for AWS.
apiKey str: String, Case-sensitive. API Key for your email service. Will always be encrypted in our database.
apiUser str: String. API User for your email service.
domain str
region str: String. Default region. Used only for AWS, Mailgun, and SparkPost.
secretAccessKey str: String, Case-sensitive. AWS Secret Key. Will always be encrypted in our database. Used only for AWS.
smtpHost str: String. Hostname or IP address of your SMTP server. Used only for SMTP.
smtpPass str: String, Case-sensitive. SMTP password. Used only for SMTP.
smtpPort float: Integer. Port used by your SMTP server. Please avoid using port 25 if possible because many providers have limitations on this port. Used only for SMTP.
smtpUser str: String. SMTP username. Used only for SMTP.

Package Details

Repository: https://github.com/pulumi/pulumi-auth0
License: Apache-2.0
Notes: This Pulumi package is based on the auth0 Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud