Preview email template

This document is automatically generated based on https://github.com/authing/authing-docs-factory based on https://api-explorer.genauth.ai V3 API, and is consistent with API parameters and return results. If the description of this document is incorrect, please refer to V3 API.

Preview email template

Method name

ManagementClient.preview_email_template

Request parameters

Name	Type	Required	Default value	Description	Sample value
type	string	yes	-	Template type: - WELCOME_EMAIL: Welcome email - FIRST_CREATED_USER: First created user notification - REGISTER_VERIFY_CODE: Registration verification code - LOGIN_VERIFY_CODE: Login verification code - MFA_VERIFY_CODE: MFA verification code - INFORMATION_COMPLETION_VERIFY_CODE: Registration information completion verification code - FIRST_EMAIL_LOGIN_VERIFY: First email login verification - CONSOLE_CONDUCTED_VERIFY: Initiate email verification in the console - USER_PASSWORD_UPDATE_REMIND: User expiration reminder - ADMIN_RESET_USER_PASSWORD_NOTIFICATION: Administrator successfully resets user password notification - USER_PASSWORD_RESET_NOTIFICATION: User password reset successful notification - RESET_PASSWORD_VERIFY_CODE: Reset password verification code - SELF_UNLOCKING_VERIFY_CODE: Self-service unlocking verification code - EMAIL_BIND_VERIFY_CODE: Binding email verification code - EMAIL_UNBIND_VERIFY_CODE: Unbinding email verification code	WELCOME_EMAIL
content	string	No	-	Email content template, optional, if not passed, the default email template configured in the user pool is used for rendering.	xxx
subject	string	No	-	Email subject, optional, if not passed, the default email template configured in the user pool is used for rendering.	Welcome to {{app_name}}
sender	string	No	-	Email sender name, optional. If not passed, the default email template configured in the user pool will be used for rendering.	{{client_name}}
expiresIn	number	No	-	Verification code/email validity period. Only verification emails have validity period. Optional. If not passed, the default email template configured in the user pool will be used for rendering.	300
tplEngine	string	No	handlebar	Template rendering engine. GenAuth email template currently supports two rendering engines: - handlebar: For detailed usage, please see: handlebars official documentation - ejs: For detailed usage, please see: ejs official documentation By default, handlerbar will be used as the template rendering engine.	handlebar

Request Response

Type: PreviewEmailTemplateRespDto

Name	Type	Description
data	<a PreviewEmailTemplateDataDto	Response data

Example results:

{
  "data": {
    "content": "xxx",
    "subject": "Welcome to GenAuth",
    "sender": "test@example.com"
  }
}

Data Structure

PreviewEmailTemplateDataDto

Name	Type	Is it required	Description	Example value
content	string	yes	Previewed email body content, in html format	xxx
subject	string	yes	Previewed email subject content	Welcome to GenAuth
sender	string	yes	Previewed email sender content	test@example.com