import * as pulumi from "@pulumi/pulumi"; /** * 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 * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as auth0 from "@pulumi/auth0"; * * const myEmailProvider = new auth0.EmailProvider("my_email_provider", { * name: "ses", * enabled: true, * defaultFromAddress: "accounts@example.com", * credentials: { * accessKeyId: "AKIAXXXXXXXXXXXXXXXX", * secretAccessKey: "7e8c2148xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", * region: "us-east-1", * }, * }); * const myEmailTemplate = new auth0.EmailTemplate("my_email_template", { * template: "welcome_email", * body: "

Welcome!

", * from: "welcome@example.com", * resultUrl: "https://example.com/welcome", * subject: "Welcome", * syntax: "liquid", * urlLifetimeInSeconds: 3600, * enabled: true, * }, { * dependsOn: [myEmailProvider], * }); * ``` * * ## Import * * This resource can be imported using the pre-defined template name. * * These names are `verify_email`, `verify_email_by_code`, `reset_email`, `reset_email_by_code`, * * `welcome_email`, `blocked_account`, `stolen_credentials`, `enrollment_email`, * * `mfa_oob_code`, `user_invitation`, and `async_approval`. * * The names `change_password`, and `password_reset` are also supported * * for legacy scenarios. * * Example: * * ```sh * $ pulumi import auth0:index/emailTemplate:EmailTemplate my_email_template "welcome_email" * ``` */ export declare class EmailTemplate extends pulumi.CustomResource { /** * Get an existing EmailTemplate resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: EmailTemplateState, opts?: pulumi.CustomResourceOptions): EmailTemplate; /** * Returns true if the given object is an instance of EmailTemplate. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is EmailTemplate; /** * Body of the email template. You can include [common variables](https://auth0.com/docs/customize/email/email-templates#common-variables). */ readonly body: pulumi.Output; /** * Indicates whether the template is enabled. */ readonly enabled: pulumi.Output; /** * Email address to use as the sender. You can include [common variables](https://auth0.com/docs/customize/email/email-templates#common-variables). */ readonly from: pulumi.Output; /** * Whether the `resetEmail` and `verifyEmail` templates should include the user's email address as the email parameter in the `returnUrl` (true) or whether no email address should be included in the redirect (false). Defaults to `true`. */ readonly includeEmailInRedirect: pulumi.Output; /** * URL to redirect the user to after a successful action. [Learn more](https://auth0.com/docs/customize/email/email-templates#configure-template-fields). */ readonly resultUrl: pulumi.Output; /** * Subject line of the email. You can include [common variables](https://auth0.com/docs/customize/email/email-templates#common-variables). */ readonly subject: pulumi.Output; /** * Syntax of the template body. You can use either text or HTML with Liquid syntax. */ readonly syntax: pulumi.Output; /** * Template name. Options include `verifyEmail`, `verifyEmailByCode`, `resetEmail`, `resetEmailByCode`, `welcomeEmail`, `blockedAccount`, `stolenCredentials`, `enrollmentEmail`, `mfaOobCode`, `userInvitation`, `changePassword` (legacy), `passwordReset` (legacy), or `asyncApproval`. */ readonly template: pulumi.Output; /** * Number of seconds during which the link within the email will be valid. */ readonly urlLifetimeInSeconds: pulumi.Output; /** * Create a EmailTemplate resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: EmailTemplateArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering EmailTemplate resources. */ export interface EmailTemplateState { /** * Body of the email template. You can include [common variables](https://auth0.com/docs/customize/email/email-templates#common-variables). */ body?: pulumi.Input; /** * Indicates whether the template is enabled. */ enabled?: pulumi.Input; /** * Email address to use as the sender. You can include [common variables](https://auth0.com/docs/customize/email/email-templates#common-variables). */ from?: pulumi.Input; /** * Whether the `resetEmail` and `verifyEmail` templates should include the user's email address as the email parameter in the `returnUrl` (true) or whether no email address should be included in the redirect (false). Defaults to `true`. */ includeEmailInRedirect?: pulumi.Input; /** * URL to redirect the user to after a successful action. [Learn more](https://auth0.com/docs/customize/email/email-templates#configure-template-fields). */ resultUrl?: pulumi.Input; /** * Subject line of the email. You can include [common variables](https://auth0.com/docs/customize/email/email-templates#common-variables). */ subject?: pulumi.Input; /** * Syntax of the template body. You can use either text or HTML with Liquid syntax. */ syntax?: pulumi.Input; /** * Template name. Options include `verifyEmail`, `verifyEmailByCode`, `resetEmail`, `resetEmailByCode`, `welcomeEmail`, `blockedAccount`, `stolenCredentials`, `enrollmentEmail`, `mfaOobCode`, `userInvitation`, `changePassword` (legacy), `passwordReset` (legacy), or `asyncApproval`. */ template?: pulumi.Input; /** * Number of seconds during which the link within the email will be valid. */ urlLifetimeInSeconds?: pulumi.Input; } /** * The set of arguments for constructing a EmailTemplate resource. */ export interface EmailTemplateArgs { /** * Body of the email template. You can include [common variables](https://auth0.com/docs/customize/email/email-templates#common-variables). */ body: pulumi.Input; /** * Indicates whether the template is enabled. */ enabled: pulumi.Input; /** * Email address to use as the sender. You can include [common variables](https://auth0.com/docs/customize/email/email-templates#common-variables). */ from: pulumi.Input; /** * Whether the `resetEmail` and `verifyEmail` templates should include the user's email address as the email parameter in the `returnUrl` (true) or whether no email address should be included in the redirect (false). Defaults to `true`. */ includeEmailInRedirect?: pulumi.Input; /** * URL to redirect the user to after a successful action. [Learn more](https://auth0.com/docs/customize/email/email-templates#configure-template-fields). */ resultUrl?: pulumi.Input; /** * Subject line of the email. You can include [common variables](https://auth0.com/docs/customize/email/email-templates#common-variables). */ subject: pulumi.Input; /** * Syntax of the template body. You can use either text or HTML with Liquid syntax. */ syntax: pulumi.Input; /** * Template name. Options include `verifyEmail`, `verifyEmailByCode`, `resetEmail`, `resetEmailByCode`, `welcomeEmail`, `blockedAccount`, `stolenCredentials`, `enrollmentEmail`, `mfaOobCode`, `userInvitation`, `changePassword` (legacy), `passwordReset` (legacy), or `asyncApproval`. */ template: pulumi.Input; /** * Number of seconds during which the link within the email will be valid. */ urlLifetimeInSeconds?: pulumi.Input; }