Class 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,
    });
}

}
Inheritance
System.Object
Pulumi.Resource
Pulumi.CustomResource
Email
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 Email : CustomResource

Constructors

View Source

Email(String, EmailArgs, CustomResourceOptions)

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

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

The unique name of the resource
EmailArgs 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

Credentials

List(Resource). Configuration settings for the credentials for the email provider. For details, see Credentials.

Declaration
public Output<EmailCredentials> Credentials { get; }
Property Value
Type Description
Pulumi.Output<EmailCredentials>
View Source

DefaultFromAddress

String. Email address to use as the sender when no other "from" address is specified.

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

Enabled

Boolean. Indicates whether or not the email provider is enabled.

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

Name

String. Name of the email provider. Options include mailgun, mandrill, sendgrid, ses, smtp, and sparkpost.

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

Methods

View Source

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

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

Declaration
public static Email Get(string name, Input<string> id, EmailState 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.
EmailState state

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

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