Class EmailTemplate

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 templates to customize the look, feel, and sender identities of emails sent by Auth0. Used in conjunction with configured email providers.

Example Usage

using Pulumi;
using Auth0 = Pulumi.Auth0;

class MyStack : Stack
{
public MyStack()
{
    var myEmailProvider = new Auth0.Email("myEmailProvider", new Auth0.EmailArgs
    {
        Enabled = true,
        DefaultFromAddress = "accounts@example.com",
        Credentials = new Auth0.Inputs.EmailCredentialsArgs
        {
            AccessKeyId = "AKIAXXXXXXXXXXXXXXXX",
            SecretAccessKey = "7e8c2148xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
            Region = "us-east-1",
        },
    });
    var myEmailTemplate = new Auth0.EmailTemplate("myEmailTemplate", new Auth0.EmailTemplateArgs
    {
        Template = "welcome_email",
        Body = "<html><body><h1>Welcome!</h1></body></html>",
        From = "welcome@example.com",
        ResultUrl = "https://example.com/welcome",
        Subject = "Welcome",
        Syntax = "liquid",
        UrlLifetimeInSeconds = 3600,
        Enabled = true,
    });
}

}
Inheritance
System.Object
Pulumi.Resource
Pulumi.CustomResource
EmailTemplate
Inherited Members
Pulumi.CustomResource.Id
Pulumi.Resource.GetResourceType()
Pulumi.Resource.GetResourceName()
Pulumi.Resource.Urn
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Pulumi.Auth0
Assembly: Pulumi.Auth0.dll
Syntax
public class EmailTemplate : CustomResource

Constructors

View Source

EmailTemplate(String, EmailTemplateArgs, CustomResourceOptions)

Create a EmailTemplate resource with the given unique name, arguments, and options.

Declaration
public EmailTemplate(string name, EmailTemplateArgs args, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resource
EmailTemplateArgs args

The arguments used to populate this resource's properties
Pulumi.CustomResourceOptions options

A bag of options that control this resource's behavior

Properties

View Source

Body

String. Body of the email template. You can include common variables.

Declaration
public Output<string> Body { get; }
Property Value
Type Description
Pulumi.Output<System.String>
View Source

Enabled

Boolean. Indicates whether or not the template is enabled.

Declaration
public Output<bool> Enabled { get; }
Property Value
Type Description
Pulumi.Output<System.Boolean>
View Source

From

String. Email address to use as the sender. You can include common variables.

Declaration
public Output<string> From { get; }
Property Value
Type Description
Pulumi.Output<System.String>
View Source

ResultUrl

String. URL to redirect the user to after a successful action. Learn more.

Declaration
public Output<string> ResultUrl { get; }
Property Value
Type Description
Pulumi.Output<System.String>
View Source

Subject

String. Subject line of the email. You can include common variables.

Declaration
public Output<string> Subject { get; }
Property Value
Type Description
Pulumi.Output<System.String>
View Source

Syntax

String. Syntax of the template body. You can use either text or HTML + Liquid syntax.

Declaration
public Output<string> Syntax { get; }
Property Value
Type Description
Pulumi.Output<System.String>
View Source

Template

String. Template name. Options include verify_email, reset_email, welcome_email, blocked_account, stolen_credentials, enrollment_email, mfa_oob_code, change_password (legacy), and password_reset (legacy).

Declaration
public Output<string> Template { get; }
Property Value
Type Description
Pulumi.Output<System.String>
View Source

UrlLifetimeInSeconds

Integer. Number of seconds during which the link within the email will be valid.

Declaration
public Output<int?> UrlLifetimeInSeconds { get; }
Property Value
Type Description
Pulumi.Output<System.Nullable<System.Int32>>

Methods

View Source

Get(String, Input<String>, EmailTemplateState, CustomResourceOptions)

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

Declaration
public static EmailTemplate Get(string name, Input<string> id, EmailTemplateState state = null, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resulting resource.
Pulumi.Input<System.String> id

The unique provider ID of the resource to lookup.
EmailTemplateState state

Any extra arguments used during the lookup.
Pulumi.CustomResourceOptions options

A bag of options that control this resource's behavior
Returns
Type Description
EmailTemplate