1. Packages
  2. FusionAuth
  3. API Docs
  4. FusionAuthEMail
FusionAuth v5.1.0 published on Tuesday, Oct 22, 2024 by Theo Gravity

fusionauth.FusionAuthEMail

Explore with Pulumi AI

fusionauth logo
FusionAuth v5.1.0 published on Tuesday, Oct 22, 2024 by Theo Gravity

    # Email Resource

    This resource contains the APIs for managing Email Templates.

    Emails API

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as fs from "fs";
    import * as fusionauth from "pulumi-fusionauth";
    
    const helloWorld = new fusionauth.FusionAuthEMail("helloWorld", {
        defaultFromName: "Welcome Team",
        defaultHtmlTemplate: fs.readFileSync(`${path.module}/email_templates/HelloWorld.html.ftl`, "utf8"),
        defaultSubject: "Hello",
        defaultTextTemplate: fs.readFileSync(`${path.module}/email_templates/HelloWorld.txt.ftl`, "utf8"),
        fromEmail: "welcome@example.com.com",
    });
    
    import pulumi
    import theogravity_pulumi_fusionauth as fusionauth
    
    hello_world = fusionauth.FusionAuthEMail("helloWorld",
        default_from_name="Welcome Team",
        default_html_template=(lambda path: open(path).read())(f"{path['module']}/email_templates/HelloWorld.html.ftl"),
        default_subject="Hello",
        default_text_template=(lambda path: open(path).read())(f"{path['module']}/email_templates/HelloWorld.txt.ftl"),
        from_email="welcome@example.com.com")
    
    package main
    
    import (
    	"fmt"
    	"os"
    
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/theogravity/pulumi-fusionauth/sdk/go/fusionauth"
    )
    
    func readFileOrPanic(path string) pulumi.StringPtrInput {
    	data, err := os.ReadFile(path)
    	if err != nil {
    		panic(err.Error())
    	}
    	return pulumi.String(string(data))
    }
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := fusionauth.NewFusionAuthEMail(ctx, "helloWorld", &fusionauth.FusionAuthEMailArgs{
    			DefaultFromName:     pulumi.String("Welcome Team"),
    			DefaultHtmlTemplate: readFileOrPanic(fmt.Sprintf("%v/email_templates/HelloWorld.html.ftl", path.Module)),
    			DefaultSubject:      pulumi.String("Hello"),
    			DefaultTextTemplate: readFileOrPanic(fmt.Sprintf("%v/email_templates/HelloWorld.txt.ftl", path.Module)),
    			FromEmail:           pulumi.String("welcome@example.com.com"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.IO;
    using System.Linq;
    using Pulumi;
    using Fusionauth = theogravity.Fusionauth;
    
    return await Deployment.RunAsync(() => 
    {
        var helloWorld = new Fusionauth.FusionAuthEMail("helloWorld", new()
        {
            DefaultFromName = "Welcome Team",
            DefaultHtmlTemplate = File.ReadAllText($"{path.Module}/email_templates/HelloWorld.html.ftl"),
            DefaultSubject = "Hello",
            DefaultTextTemplate = File.ReadAllText($"{path.Module}/email_templates/HelloWorld.txt.ftl"),
            FromEmail = "welcome@example.com.com",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.fusionauth.FusionAuthEMail;
    import com.pulumi.fusionauth.FusionAuthEMailArgs;
    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 helloWorld = new FusionAuthEMail("helloWorld", FusionAuthEMailArgs.builder()
                .defaultFromName("Welcome Team")
                .defaultHtmlTemplate(Files.readString(Paths.get(String.format("%s/email_templates/HelloWorld.html.ftl", path.module()))))
                .defaultSubject("Hello")
                .defaultTextTemplate(Files.readString(Paths.get(String.format("%s/email_templates/HelloWorld.txt.ftl", path.module()))))
                .fromEmail("welcome@example.com.com")
                .build());
    
        }
    }
    
    resources:
      helloWorld:
        type: fusionauth:FusionAuthEMail
        properties:
          defaultFromName: Welcome Team
          defaultHtmlTemplate:
            fn::readFile: ${path.module}/email_templates/HelloWorld.html.ftl
          defaultSubject: Hello
          defaultTextTemplate:
            fn::readFile: ${path.module}/email_templates/HelloWorld.txt.ftl
          fromEmail: welcome@example.com.com
    

    Create FusionAuthEMail Resource

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

    Constructor syntax

    new FusionAuthEMail(name: string, args: FusionAuthEMailArgs, opts?: CustomResourceOptions);
    @overload
    def FusionAuthEMail(resource_name: str,
                        args: FusionAuthEMailArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def FusionAuthEMail(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        default_html_template: Optional[str] = None,
                        default_subject: Optional[str] = None,
                        default_text_template: Optional[str] = None,
                        default_from_name: Optional[str] = None,
                        email_id: Optional[str] = None,
                        from_email: Optional[str] = None,
                        localized_from_names: Optional[Mapping[str, Any]] = None,
                        localized_html_templates: Optional[Mapping[str, Any]] = None,
                        localized_subjects: Optional[Mapping[str, Any]] = None,
                        localized_text_templates: Optional[Mapping[str, Any]] = None,
                        name: Optional[str] = None)
    func NewFusionAuthEMail(ctx *Context, name string, args FusionAuthEMailArgs, opts ...ResourceOption) (*FusionAuthEMail, error)
    public FusionAuthEMail(string name, FusionAuthEMailArgs args, CustomResourceOptions? opts = null)
    public FusionAuthEMail(String name, FusionAuthEMailArgs args)
    public FusionAuthEMail(String name, FusionAuthEMailArgs args, CustomResourceOptions options)
    
    type: fusionauth:FusionAuthEMail
    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 FusionAuthEMailArgs
    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 FusionAuthEMailArgs
    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 FusionAuthEMailArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FusionAuthEMailArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FusionAuthEMailArgs
    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 fusionAuthEMailResource = new Fusionauth.FusionAuthEMail("fusionAuthEMailResource", new()
    {
        DefaultHtmlTemplate = "string",
        DefaultSubject = "string",
        DefaultTextTemplate = "string",
        DefaultFromName = "string",
        EmailId = "string",
        FromEmail = "string",
        LocalizedFromNames = 
        {
            { "string", "any" },
        },
        LocalizedHtmlTemplates = 
        {
            { "string", "any" },
        },
        LocalizedSubjects = 
        {
            { "string", "any" },
        },
        LocalizedTextTemplates = 
        {
            { "string", "any" },
        },
        Name = "string",
    });
    
    example, err := fusionauth.NewFusionAuthEMail(ctx, "fusionAuthEMailResource", &fusionauth.FusionAuthEMailArgs{
    	DefaultHtmlTemplate: pulumi.String("string"),
    	DefaultSubject:      pulumi.String("string"),
    	DefaultTextTemplate: pulumi.String("string"),
    	DefaultFromName:     pulumi.String("string"),
    	EmailId:             pulumi.String("string"),
    	FromEmail:           pulumi.String("string"),
    	LocalizedFromNames: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	LocalizedHtmlTemplates: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	LocalizedSubjects: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	LocalizedTextTemplates: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	Name: pulumi.String("string"),
    })
    
    var fusionAuthEMailResource = new FusionAuthEMail("fusionAuthEMailResource", FusionAuthEMailArgs.builder()
        .defaultHtmlTemplate("string")
        .defaultSubject("string")
        .defaultTextTemplate("string")
        .defaultFromName("string")
        .emailId("string")
        .fromEmail("string")
        .localizedFromNames(Map.of("string", "any"))
        .localizedHtmlTemplates(Map.of("string", "any"))
        .localizedSubjects(Map.of("string", "any"))
        .localizedTextTemplates(Map.of("string", "any"))
        .name("string")
        .build());
    
    fusion_auth_e_mail_resource = fusionauth.FusionAuthEMail("fusionAuthEMailResource",
        default_html_template="string",
        default_subject="string",
        default_text_template="string",
        default_from_name="string",
        email_id="string",
        from_email="string",
        localized_from_names={
            "string": "any",
        },
        localized_html_templates={
            "string": "any",
        },
        localized_subjects={
            "string": "any",
        },
        localized_text_templates={
            "string": "any",
        },
        name="string")
    
    const fusionAuthEMailResource = new fusionauth.FusionAuthEMail("fusionAuthEMailResource", {
        defaultHtmlTemplate: "string",
        defaultSubject: "string",
        defaultTextTemplate: "string",
        defaultFromName: "string",
        emailId: "string",
        fromEmail: "string",
        localizedFromNames: {
            string: "any",
        },
        localizedHtmlTemplates: {
            string: "any",
        },
        localizedSubjects: {
            string: "any",
        },
        localizedTextTemplates: {
            string: "any",
        },
        name: "string",
    });
    
    type: fusionauth:FusionAuthEMail
    properties:
        defaultFromName: string
        defaultHtmlTemplate: string
        defaultSubject: string
        defaultTextTemplate: string
        emailId: string
        fromEmail: string
        localizedFromNames:
            string: any
        localizedHtmlTemplates:
            string: any
        localizedSubjects:
            string: any
        localizedTextTemplates:
            string: any
        name: string
    

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

    DefaultHtmlTemplate string
    The default HTML Email Template.
    DefaultSubject string
    The default Subject used when sending emails.
    DefaultTextTemplate string
    The default Text Email Template.
    DefaultFromName string
    The default From Name used when sending emails. If not provided, and a localized value cannot be determined, the default value for the tenant will be used. This is the display name part of the email address ( i.e. Jared Dunn jared@piedpiper.com).
    EmailId string
    The Id to use for the new Email Template. If not specified a secure random UUID will be generated.
    FromEmail string
    The email address that this email will be sent from. If not provided, the default value for the tenant will be used. This is the address part email address (i.e. Jared Dunn jared@piedpiper.com).
    LocalizedFromNames Dictionary<string, object>
    The From Name used when sending emails to users who speak other languages. This overrides the default From Name based on the user’s list of preferred languages.
    LocalizedHtmlTemplates Dictionary<string, object>
    The HTML Email Template used when sending emails to users who speak other languages. This overrides the default HTML Email Template based on the user’s list of preferred languages.
    LocalizedSubjects Dictionary<string, object>
    The Subject used when sending emails to users who speak other languages. This overrides the default Subject based on the user’s list of preferred languages.
    LocalizedTextTemplates Dictionary<string, object>
    The Text Email Template used when sending emails to users who speak other languages. This overrides the default Text Email Template based on the user’s list of preferred languages.
    Name string
    A descriptive name for the email template (i.e. "April 2016 Coupon Email")
    DefaultHtmlTemplate string
    The default HTML Email Template.
    DefaultSubject string
    The default Subject used when sending emails.
    DefaultTextTemplate string
    The default Text Email Template.
    DefaultFromName string
    The default From Name used when sending emails. If not provided, and a localized value cannot be determined, the default value for the tenant will be used. This is the display name part of the email address ( i.e. Jared Dunn jared@piedpiper.com).
    EmailId string
    The Id to use for the new Email Template. If not specified a secure random UUID will be generated.
    FromEmail string
    The email address that this email will be sent from. If not provided, the default value for the tenant will be used. This is the address part email address (i.e. Jared Dunn jared@piedpiper.com).
    LocalizedFromNames map[string]interface{}
    The From Name used when sending emails to users who speak other languages. This overrides the default From Name based on the user’s list of preferred languages.
    LocalizedHtmlTemplates map[string]interface{}
    The HTML Email Template used when sending emails to users who speak other languages. This overrides the default HTML Email Template based on the user’s list of preferred languages.
    LocalizedSubjects map[string]interface{}
    The Subject used when sending emails to users who speak other languages. This overrides the default Subject based on the user’s list of preferred languages.
    LocalizedTextTemplates map[string]interface{}
    The Text Email Template used when sending emails to users who speak other languages. This overrides the default Text Email Template based on the user’s list of preferred languages.
    Name string
    A descriptive name for the email template (i.e. "April 2016 Coupon Email")
    defaultHtmlTemplate String
    The default HTML Email Template.
    defaultSubject String
    The default Subject used when sending emails.
    defaultTextTemplate String
    The default Text Email Template.
    defaultFromName String
    The default From Name used when sending emails. If not provided, and a localized value cannot be determined, the default value for the tenant will be used. This is the display name part of the email address ( i.e. Jared Dunn jared@piedpiper.com).
    emailId String
    The Id to use for the new Email Template. If not specified a secure random UUID will be generated.
    fromEmail String
    The email address that this email will be sent from. If not provided, the default value for the tenant will be used. This is the address part email address (i.e. Jared Dunn jared@piedpiper.com).
    localizedFromNames Map<String,Object>
    The From Name used when sending emails to users who speak other languages. This overrides the default From Name based on the user’s list of preferred languages.
    localizedHtmlTemplates Map<String,Object>
    The HTML Email Template used when sending emails to users who speak other languages. This overrides the default HTML Email Template based on the user’s list of preferred languages.
    localizedSubjects Map<String,Object>
    The Subject used when sending emails to users who speak other languages. This overrides the default Subject based on the user’s list of preferred languages.
    localizedTextTemplates Map<String,Object>
    The Text Email Template used when sending emails to users who speak other languages. This overrides the default Text Email Template based on the user’s list of preferred languages.
    name String
    A descriptive name for the email template (i.e. "April 2016 Coupon Email")
    defaultHtmlTemplate string
    The default HTML Email Template.
    defaultSubject string
    The default Subject used when sending emails.
    defaultTextTemplate string
    The default Text Email Template.
    defaultFromName string
    The default From Name used when sending emails. If not provided, and a localized value cannot be determined, the default value for the tenant will be used. This is the display name part of the email address ( i.e. Jared Dunn jared@piedpiper.com).
    emailId string
    The Id to use for the new Email Template. If not specified a secure random UUID will be generated.
    fromEmail string
    The email address that this email will be sent from. If not provided, the default value for the tenant will be used. This is the address part email address (i.e. Jared Dunn jared@piedpiper.com).
    localizedFromNames {[key: string]: any}
    The From Name used when sending emails to users who speak other languages. This overrides the default From Name based on the user’s list of preferred languages.
    localizedHtmlTemplates {[key: string]: any}
    The HTML Email Template used when sending emails to users who speak other languages. This overrides the default HTML Email Template based on the user’s list of preferred languages.
    localizedSubjects {[key: string]: any}
    The Subject used when sending emails to users who speak other languages. This overrides the default Subject based on the user’s list of preferred languages.
    localizedTextTemplates {[key: string]: any}
    The Text Email Template used when sending emails to users who speak other languages. This overrides the default Text Email Template based on the user’s list of preferred languages.
    name string
    A descriptive name for the email template (i.e. "April 2016 Coupon Email")
    default_html_template str
    The default HTML Email Template.
    default_subject str
    The default Subject used when sending emails.
    default_text_template str
    The default Text Email Template.
    default_from_name str
    The default From Name used when sending emails. If not provided, and a localized value cannot be determined, the default value for the tenant will be used. This is the display name part of the email address ( i.e. Jared Dunn jared@piedpiper.com).
    email_id str
    The Id to use for the new Email Template. If not specified a secure random UUID will be generated.
    from_email str
    The email address that this email will be sent from. If not provided, the default value for the tenant will be used. This is the address part email address (i.e. Jared Dunn jared@piedpiper.com).
    localized_from_names Mapping[str, Any]
    The From Name used when sending emails to users who speak other languages. This overrides the default From Name based on the user’s list of preferred languages.
    localized_html_templates Mapping[str, Any]
    The HTML Email Template used when sending emails to users who speak other languages. This overrides the default HTML Email Template based on the user’s list of preferred languages.
    localized_subjects Mapping[str, Any]
    The Subject used when sending emails to users who speak other languages. This overrides the default Subject based on the user’s list of preferred languages.
    localized_text_templates Mapping[str, Any]
    The Text Email Template used when sending emails to users who speak other languages. This overrides the default Text Email Template based on the user’s list of preferred languages.
    name str
    A descriptive name for the email template (i.e. "April 2016 Coupon Email")
    defaultHtmlTemplate String
    The default HTML Email Template.
    defaultSubject String
    The default Subject used when sending emails.
    defaultTextTemplate String
    The default Text Email Template.
    defaultFromName String
    The default From Name used when sending emails. If not provided, and a localized value cannot be determined, the default value for the tenant will be used. This is the display name part of the email address ( i.e. Jared Dunn jared@piedpiper.com).
    emailId String
    The Id to use for the new Email Template. If not specified a secure random UUID will be generated.
    fromEmail String
    The email address that this email will be sent from. If not provided, the default value for the tenant will be used. This is the address part email address (i.e. Jared Dunn jared@piedpiper.com).
    localizedFromNames Map<Any>
    The From Name used when sending emails to users who speak other languages. This overrides the default From Name based on the user’s list of preferred languages.
    localizedHtmlTemplates Map<Any>
    The HTML Email Template used when sending emails to users who speak other languages. This overrides the default HTML Email Template based on the user’s list of preferred languages.
    localizedSubjects Map<Any>
    The Subject used when sending emails to users who speak other languages. This overrides the default Subject based on the user’s list of preferred languages.
    localizedTextTemplates Map<Any>
    The Text Email Template used when sending emails to users who speak other languages. This overrides the default Text Email Template based on the user’s list of preferred languages.
    name String
    A descriptive name for the email template (i.e. "April 2016 Coupon Email")

    Outputs

    All input properties are implicitly available as output properties. Additionally, the FusionAuthEMail 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 FusionAuthEMail Resource

    Get an existing FusionAuthEMail 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?: FusionAuthEMailState, opts?: CustomResourceOptions): FusionAuthEMail
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            default_from_name: Optional[str] = None,
            default_html_template: Optional[str] = None,
            default_subject: Optional[str] = None,
            default_text_template: Optional[str] = None,
            email_id: Optional[str] = None,
            from_email: Optional[str] = None,
            localized_from_names: Optional[Mapping[str, Any]] = None,
            localized_html_templates: Optional[Mapping[str, Any]] = None,
            localized_subjects: Optional[Mapping[str, Any]] = None,
            localized_text_templates: Optional[Mapping[str, Any]] = None,
            name: Optional[str] = None) -> FusionAuthEMail
    func GetFusionAuthEMail(ctx *Context, name string, id IDInput, state *FusionAuthEMailState, opts ...ResourceOption) (*FusionAuthEMail, error)
    public static FusionAuthEMail Get(string name, Input<string> id, FusionAuthEMailState? state, CustomResourceOptions? opts = null)
    public static FusionAuthEMail get(String name, Output<String> id, FusionAuthEMailState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    DefaultFromName string
    The default From Name used when sending emails. If not provided, and a localized value cannot be determined, the default value for the tenant will be used. This is the display name part of the email address ( i.e. Jared Dunn jared@piedpiper.com).
    DefaultHtmlTemplate string
    The default HTML Email Template.
    DefaultSubject string
    The default Subject used when sending emails.
    DefaultTextTemplate string
    The default Text Email Template.
    EmailId string
    The Id to use for the new Email Template. If not specified a secure random UUID will be generated.
    FromEmail string
    The email address that this email will be sent from. If not provided, the default value for the tenant will be used. This is the address part email address (i.e. Jared Dunn jared@piedpiper.com).
    LocalizedFromNames Dictionary<string, object>
    The From Name used when sending emails to users who speak other languages. This overrides the default From Name based on the user’s list of preferred languages.
    LocalizedHtmlTemplates Dictionary<string, object>
    The HTML Email Template used when sending emails to users who speak other languages. This overrides the default HTML Email Template based on the user’s list of preferred languages.
    LocalizedSubjects Dictionary<string, object>
    The Subject used when sending emails to users who speak other languages. This overrides the default Subject based on the user’s list of preferred languages.
    LocalizedTextTemplates Dictionary<string, object>
    The Text Email Template used when sending emails to users who speak other languages. This overrides the default Text Email Template based on the user’s list of preferred languages.
    Name string
    A descriptive name for the email template (i.e. "April 2016 Coupon Email")
    DefaultFromName string
    The default From Name used when sending emails. If not provided, and a localized value cannot be determined, the default value for the tenant will be used. This is the display name part of the email address ( i.e. Jared Dunn jared@piedpiper.com).
    DefaultHtmlTemplate string
    The default HTML Email Template.
    DefaultSubject string
    The default Subject used when sending emails.
    DefaultTextTemplate string
    The default Text Email Template.
    EmailId string
    The Id to use for the new Email Template. If not specified a secure random UUID will be generated.
    FromEmail string
    The email address that this email will be sent from. If not provided, the default value for the tenant will be used. This is the address part email address (i.e. Jared Dunn jared@piedpiper.com).
    LocalizedFromNames map[string]interface{}
    The From Name used when sending emails to users who speak other languages. This overrides the default From Name based on the user’s list of preferred languages.
    LocalizedHtmlTemplates map[string]interface{}
    The HTML Email Template used when sending emails to users who speak other languages. This overrides the default HTML Email Template based on the user’s list of preferred languages.
    LocalizedSubjects map[string]interface{}
    The Subject used when sending emails to users who speak other languages. This overrides the default Subject based on the user’s list of preferred languages.
    LocalizedTextTemplates map[string]interface{}
    The Text Email Template used when sending emails to users who speak other languages. This overrides the default Text Email Template based on the user’s list of preferred languages.
    Name string
    A descriptive name for the email template (i.e. "April 2016 Coupon Email")
    defaultFromName String
    The default From Name used when sending emails. If not provided, and a localized value cannot be determined, the default value for the tenant will be used. This is the display name part of the email address ( i.e. Jared Dunn jared@piedpiper.com).
    defaultHtmlTemplate String
    The default HTML Email Template.
    defaultSubject String
    The default Subject used when sending emails.
    defaultTextTemplate String
    The default Text Email Template.
    emailId String
    The Id to use for the new Email Template. If not specified a secure random UUID will be generated.
    fromEmail String
    The email address that this email will be sent from. If not provided, the default value for the tenant will be used. This is the address part email address (i.e. Jared Dunn jared@piedpiper.com).
    localizedFromNames Map<String,Object>
    The From Name used when sending emails to users who speak other languages. This overrides the default From Name based on the user’s list of preferred languages.
    localizedHtmlTemplates Map<String,Object>
    The HTML Email Template used when sending emails to users who speak other languages. This overrides the default HTML Email Template based on the user’s list of preferred languages.
    localizedSubjects Map<String,Object>
    The Subject used when sending emails to users who speak other languages. This overrides the default Subject based on the user’s list of preferred languages.
    localizedTextTemplates Map<String,Object>
    The Text Email Template used when sending emails to users who speak other languages. This overrides the default Text Email Template based on the user’s list of preferred languages.
    name String
    A descriptive name for the email template (i.e. "April 2016 Coupon Email")
    defaultFromName string
    The default From Name used when sending emails. If not provided, and a localized value cannot be determined, the default value for the tenant will be used. This is the display name part of the email address ( i.e. Jared Dunn jared@piedpiper.com).
    defaultHtmlTemplate string
    The default HTML Email Template.
    defaultSubject string
    The default Subject used when sending emails.
    defaultTextTemplate string
    The default Text Email Template.
    emailId string
    The Id to use for the new Email Template. If not specified a secure random UUID will be generated.
    fromEmail string
    The email address that this email will be sent from. If not provided, the default value for the tenant will be used. This is the address part email address (i.e. Jared Dunn jared@piedpiper.com).
    localizedFromNames {[key: string]: any}
    The From Name used when sending emails to users who speak other languages. This overrides the default From Name based on the user’s list of preferred languages.
    localizedHtmlTemplates {[key: string]: any}
    The HTML Email Template used when sending emails to users who speak other languages. This overrides the default HTML Email Template based on the user’s list of preferred languages.
    localizedSubjects {[key: string]: any}
    The Subject used when sending emails to users who speak other languages. This overrides the default Subject based on the user’s list of preferred languages.
    localizedTextTemplates {[key: string]: any}
    The Text Email Template used when sending emails to users who speak other languages. This overrides the default Text Email Template based on the user’s list of preferred languages.
    name string
    A descriptive name for the email template (i.e. "April 2016 Coupon Email")
    default_from_name str
    The default From Name used when sending emails. If not provided, and a localized value cannot be determined, the default value for the tenant will be used. This is the display name part of the email address ( i.e. Jared Dunn jared@piedpiper.com).
    default_html_template str
    The default HTML Email Template.
    default_subject str
    The default Subject used when sending emails.
    default_text_template str
    The default Text Email Template.
    email_id str
    The Id to use for the new Email Template. If not specified a secure random UUID will be generated.
    from_email str
    The email address that this email will be sent from. If not provided, the default value for the tenant will be used. This is the address part email address (i.e. Jared Dunn jared@piedpiper.com).
    localized_from_names Mapping[str, Any]
    The From Name used when sending emails to users who speak other languages. This overrides the default From Name based on the user’s list of preferred languages.
    localized_html_templates Mapping[str, Any]
    The HTML Email Template used when sending emails to users who speak other languages. This overrides the default HTML Email Template based on the user’s list of preferred languages.
    localized_subjects Mapping[str, Any]
    The Subject used when sending emails to users who speak other languages. This overrides the default Subject based on the user’s list of preferred languages.
    localized_text_templates Mapping[str, Any]
    The Text Email Template used when sending emails to users who speak other languages. This overrides the default Text Email Template based on the user’s list of preferred languages.
    name str
    A descriptive name for the email template (i.e. "April 2016 Coupon Email")
    defaultFromName String
    The default From Name used when sending emails. If not provided, and a localized value cannot be determined, the default value for the tenant will be used. This is the display name part of the email address ( i.e. Jared Dunn jared@piedpiper.com).
    defaultHtmlTemplate String
    The default HTML Email Template.
    defaultSubject String
    The default Subject used when sending emails.
    defaultTextTemplate String
    The default Text Email Template.
    emailId String
    The Id to use for the new Email Template. If not specified a secure random UUID will be generated.
    fromEmail String
    The email address that this email will be sent from. If not provided, the default value for the tenant will be used. This is the address part email address (i.e. Jared Dunn jared@piedpiper.com).
    localizedFromNames Map<Any>
    The From Name used when sending emails to users who speak other languages. This overrides the default From Name based on the user’s list of preferred languages.
    localizedHtmlTemplates Map<Any>
    The HTML Email Template used when sending emails to users who speak other languages. This overrides the default HTML Email Template based on the user’s list of preferred languages.
    localizedSubjects Map<Any>
    The Subject used when sending emails to users who speak other languages. This overrides the default Subject based on the user’s list of preferred languages.
    localizedTextTemplates Map<Any>
    The Text Email Template used when sending emails to users who speak other languages. This overrides the default Text Email Template based on the user’s list of preferred languages.
    name String
    A descriptive name for the email template (i.e. "April 2016 Coupon Email")

    Package Details

    Repository
    fusionauth theogravity/pulumi-fusionauth
    License
    MIT
    Notes
    This Pulumi package is based on the fusionauth Terraform Provider.
    fusionauth logo
    FusionAuth v5.1.0 published on Tuesday, Oct 22, 2024 by Theo Gravity