pulumi-fusionauth/getEMail.d.ts

A Pulumi package for managing FusionAuth instances.

import * as pulumi from "@pulumi/pulumi";
/**
 * ## # Email Resource
 *
 * This data source is used to fetch information about a specific Email Template.
 *
 * [Emails API](https://fusionauth.io/docs/v1/tech/apis/emails)
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as fusionauth from "@pulumi/fusionauth";
 *
 * const defaultBreachedPassword = fusionauth.getEMail({
 *     name: "[FusionAuth Default] Breached Password Notification",
 * });
 * ```
 */
export declare function getEMail(args: GetEMailArgs, opts?: pulumi.InvokeOptions): Promise<GetEMailResult>;
/**
 * A collection of arguments for invoking getEMail.
 */
export interface GetEMailArgs {
    /**
     * The email address that this email will be sent from.
     */
    fromEmail?: string;
    /**
     * The name of the Email Template.
     */
    name: string;
}
/**
 * A collection of values returned by getEMail.
 */
export interface GetEMailResult {
    /**
     * The default From Name used when sending emails.
     */
    readonly defaultFromName: string;
    /**
     * The default HTML Email Template.
     */
    readonly defaultHtmlTemplate: string;
    /**
     * The default Subject used when sending emails.
     */
    readonly defaultSubject: string;
    /**
     * The default Text Email Template.
     */
    readonly defaultTextTemplate: string;
    /**
     * The email address that this email will be sent from.
     */
    readonly fromEmail?: string;
    /**
     * The Id of the Email Template.
     */
    readonly id: string;
    /**
     * The From Name used when sending emails to users who speak other languages.
     */
    readonly localizedFromNames: {
        [key: string]: string;
    };
    /**
     * The HTML Email Template used when sending emails to users who speak other languages.
     */
    readonly localizedHtmlTemplates: {
        [key: string]: string;
    };
    /**
     * The Subject used when sending emails to users who speak other languages.
     */
    readonly localizedSubjects: {
        [key: string]: string;
    };
    /**
     * The Text Email Template used when sending emails to users who speak other languages.
     */
    readonly localizedTextTemplates: {
        [key: string]: string;
    };
    readonly name: string;
}
/**
 * ## # Email Resource
 *
 * This data source is used to fetch information about a specific Email Template.
 *
 * [Emails API](https://fusionauth.io/docs/v1/tech/apis/emails)
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as fusionauth from "@pulumi/fusionauth";
 *
 * const defaultBreachedPassword = fusionauth.getEMail({
 *     name: "[FusionAuth Default] Breached Password Notification",
 * });
 * ```
 */
export declare function getEMailOutput(args: GetEMailOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetEMailResult>;
/**
 * A collection of arguments for invoking getEMail.
 */
export interface GetEMailOutputArgs {
    /**
     * The email address that this email will be sent from.
     */
    fromEmail?: pulumi.Input<string>;
    /**
     * The name of the Email Template.
     */
    name: pulumi.Input<string>;
}