Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. FusionAuth
  3. API Docs
  4. getEMail
FusionAuth v5.1.0 published on Tuesday, Oct 22, 2024 by Theo Gravity
theogravity/pulumi-fusionauth

fusionauth.getEMail

Explore with Pulumi AI

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

    # Email Resource

    This data source is used to fetch information about a specific Email Template.

    Emails API

    Example Usage

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

const defaultBreachedPassword = fusionauth.getEMail({
    name: "[FusionAuth Default] Breached Password Notification",
});

    import pulumi
import pulumi_fusionauth as fusionauth

default_breached_password = fusionauth.get_e_mail(name="[FusionAuth Default] Breached Password Notification")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/theogravity/pulumi-fusionauth/sdk/go/fusionauth"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fusionauth.GetEMail(ctx, &fusionauth.GetEMailArgs{
			Name: "[FusionAuth Default] Breached Password Notification",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fusionauth = Pulumi.Fusionauth;

return await Deployment.RunAsync(() => 
{
    var defaultBreachedPassword = Fusionauth.GetEMail.Invoke(new()
    {
        Name = "[FusionAuth Default] Breached Password Notification",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fusionauth.FusionauthFunctions;
import com.pulumi.fusionauth.inputs.GetEMailArgs;
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) {
        final var defaultBreachedPassword = FusionauthFunctions.getEMail(GetEMailArgs.builder()
            .name("[FusionAuth Default] Breached Password Notification")
            .build());

    }
}

    variables:
  defaultBreachedPassword:
    fn::invoke:
      Function: fusionauth:getEMail
      Arguments:
        name: '[FusionAuth Default] Breached Password Notification'

    Using getEMail

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getEMail(args: GetEMailArgs, opts?: InvokeOptions): Promise<GetEMailResult>
function getEMailOutput(args: GetEMailOutputArgs, opts?: InvokeOptions): Output<GetEMailResult>
    def get_e_mail(from_email: Optional[str] = None,
               name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetEMailResult
def get_e_mail_output(from_email: Optional[pulumi.Input[str]] = None,
               name: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetEMailResult]
    func GetEMail(ctx *Context, args *GetEMailArgs, opts ...InvokeOption) (*GetEMailResult, error)
func GetEMailOutput(ctx *Context, args *GetEMailOutputArgs, opts ...InvokeOption) GetEMailResultOutput

    > Note: This function is named GetEMail in the Go SDK.

    public static class GetEMail 
{
    public static Task<GetEMailResult> InvokeAsync(GetEMailArgs args, InvokeOptions? opts = null)
    public static Output<GetEMailResult> Invoke(GetEMailInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetEMailResult> getEMail(GetEMailArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: fusionauth:index/getEMail:getEMail
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    The name of the Email Template.
    FromEmail string
    The email address that this email will be sent from.
    Name string
    The name of the Email Template.
    FromEmail string
    The email address that this email will be sent from.
    name String
    The name of the Email Template.
    fromEmail String
    The email address that this email will be sent from.
    name string
    The name of the Email Template.
    fromEmail string
    The email address that this email will be sent from.
    name str
    The name of the Email Template.
    from_email str
    The email address that this email will be sent from.
    name String
    The name of the Email Template.
    fromEmail String
    The email address that this email will be sent from.

    getEMail Result

    The following output properties are available:

    DefaultFromName string
    The default From Name used when sending emails.
    DefaultHtmlTemplate string
    The default HTML Email Template.
    DefaultSubject string
    The default Subject used when sending emails.
    DefaultTextTemplate string
    The default Text Email Template.
    Id string
    The Id of the Email Template.
    LocalizedFromNames Dictionary<string, object>
    The From Name used when sending emails to users who speak other languages.
    LocalizedHtmlTemplates Dictionary<string, object>
    The HTML Email Template used when sending emails to users who speak other languages.
    LocalizedSubjects Dictionary<string, object>
    The Subject used when sending emails to users who speak other languages.
    LocalizedTextTemplates Dictionary<string, object>
    The Text Email Template used when sending emails to users who speak other languages.
    Name string
    FromEmail string
    The email address that this email will be sent from.
    DefaultFromName string
    The default From Name used when sending emails.
    DefaultHtmlTemplate string
    The default HTML Email Template.
    DefaultSubject string
    The default Subject used when sending emails.
    DefaultTextTemplate string
    The default Text Email Template.
    Id string
    The Id of the Email Template.
    LocalizedFromNames map[string]interface{}
    The From Name used when sending emails to users who speak other languages.
    LocalizedHtmlTemplates map[string]interface{}
    The HTML Email Template used when sending emails to users who speak other languages.
    LocalizedSubjects map[string]interface{}
    The Subject used when sending emails to users who speak other languages.
    LocalizedTextTemplates map[string]interface{}
    The Text Email Template used when sending emails to users who speak other languages.
    Name string
    FromEmail string
    The email address that this email will be sent from.
    defaultFromName String
    The default From Name used when sending emails.
    defaultHtmlTemplate String
    The default HTML Email Template.
    defaultSubject String
    The default Subject used when sending emails.
    defaultTextTemplate String
    The default Text Email Template.
    id String
    The Id of the Email Template.
    localizedFromNames Map<String,Object>
    The From Name used when sending emails to users who speak other languages.
    localizedHtmlTemplates Map<String,Object>
    The HTML Email Template used when sending emails to users who speak other languages.
    localizedSubjects Map<String,Object>
    The Subject used when sending emails to users who speak other languages.
    localizedTextTemplates Map<String,Object>
    The Text Email Template used when sending emails to users who speak other languages.
    name String
    fromEmail String
    The email address that this email will be sent from.
    defaultFromName string
    The default From Name used when sending emails.
    defaultHtmlTemplate string
    The default HTML Email Template.
    defaultSubject string
    The default Subject used when sending emails.
    defaultTextTemplate string
    The default Text Email Template.
    id string
    The Id of the Email Template.
    localizedFromNames {[key: string]: any}
    The From Name used when sending emails to users who speak other languages.
    localizedHtmlTemplates {[key: string]: any}
    The HTML Email Template used when sending emails to users who speak other languages.
    localizedSubjects {[key: string]: any}
    The Subject used when sending emails to users who speak other languages.
    localizedTextTemplates {[key: string]: any}
    The Text Email Template used when sending emails to users who speak other languages.
    name string
    fromEmail string
    The email address that this email will be sent from.
    default_from_name str
    The default From Name used when sending emails.
    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.
    id str
    The Id of the Email Template.
    localized_from_names Mapping[str, Any]
    The From Name used when sending emails to users who speak other languages.
    localized_html_templates Mapping[str, Any]
    The HTML Email Template used when sending emails to users who speak other languages.
    localized_subjects Mapping[str, Any]
    The Subject used when sending emails to users who speak other languages.
    localized_text_templates Mapping[str, Any]
    The Text Email Template used when sending emails to users who speak other languages.
    name str
    from_email str
    The email address that this email will be sent from.
    defaultFromName String
    The default From Name used when sending emails.
    defaultHtmlTemplate String
    The default HTML Email Template.
    defaultSubject String
    The default Subject used when sending emails.
    defaultTextTemplate String
    The default Text Email Template.
    id String
    The Id of the Email Template.
    localizedFromNames Map<Any>
    The From Name used when sending emails to users who speak other languages.
    localizedHtmlTemplates Map<Any>
    The HTML Email Template used when sending emails to users who speak other languages.
    localizedSubjects Map<Any>
    The Subject used when sending emails to users who speak other languages.
    localizedTextTemplates Map<Any>
    The Text Email Template used when sending emails to users who speak other languages.
    name String
    fromEmail String
    The email address that this email will be sent from.

    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
    theogravity/pulumi-fusionauth