GenAuth DocsDocuments
Concepts
User Guide
Development Integration
AgentAuth
Metadata
Development Integration
Multi-tenant (beta)
Console Documentation
Multi-tenant Console
Tenant Console
Saas Application Demo
Concepts
User Guide
Development Integration
AgentAuth
Metadata
Development Integration
Multi-tenant (beta)
Console Documentation
Multi-tenant Console
Tenant Console
Saas Application Demo
Old version
Development Integration
  • API

  • SDK

    • Java

      • Installation and use
      • User authentication module

      • Management module

        • Manage users

        • Management Roles

        • Manage user groups

        • Manage custom fields

        • Manage Resources and Permissions

        • Manage data resources and permissions

        • Manage Applications

        • Manage Identity Sources

        • Manage security configuration

        • Manage message service

          • Get the list of email templates
          • Modify email template
          • Preview email template
          • Get third-party email service configuration
          • Configure third-party email service
        • Manage Pipeline

        • Manage Webhook

        • Get audit log

        • Manage metering and billing

        • Events
    • Node.js

    • Python

  • Error Codes
  1. Development Integration
  2. /
  3. SDK
  4. /
  5. Java
  6. /
  7. Management module

  8. /
  9. Manage message service

  10. /
  11. Preview email template

¶ Preview email template

Update time: 2025-07-23 07:34:21
Edit

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 this document description is incorrect, please refer to V3 API.

Preview email template

¶ Method Name

ManagementClient.previewEmailTemplate

¶ Request Parameters

NameType
Is it required
Default Value
Description
Example Value
typestringyes-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: Notification of successful password reset by administrator
- USER_PASSWORD_RESET_NOTIFICATION: Notification of successful password reset by user
- RESET_PASSWORD_VERIFY_CODE: Verification code for password reset
- SELF_UNLOCKING_VERIFY_CODE: Verification code for self-unlocking
- EMAIL_BIND_VERIFY_CODE: Verification code for binding email
- EMAIL_UNBIND_VERIFY_CODE: Verification code for unbinding email
WELCOME_EMAIL
contentstringNo-Email content template, optional. If not passed, the default email template configured in the user pool will be used for rendering.xxx
subjectstringNo-Email subject, optional. If not passed, the default email template configured in the user pool will be used for rendering.Welcome to
senderstringNo-Email sender Name, optional. If not passed, the email template configured in the user pool will be used for rendering by default.
expiresInnumberNo-Verification code/email validity period. Only verification emails have validity period. Optional. If not passed, the email template configured in the user pool will be used for rendering by default.300
tplEnginestringNohandlebarTemplate rendering engine. GenAuth email template currently supports two rendering engines:
- handlebar: For detailed usage, please see: handlebars official documentation (opens new window)
- ejs: For detailed usage, please see: ejs official documentation (opens new window)

By default, handlerbar will be used as the template rendering engine.
handlebar

¶ Sample Code

package test.management;

import cn.authing.sdk.java.client.ManagementClient;
import cn.authing.sdk.java.dto.PreviewEmailTemplateDto;
import cn.authing.sdk.java.dto.PreviewEmailTemplateRespDto;
import cn.authing.sdk.java.model.ManagementClientOptions;
import cn.authing.sdk.java.util.JsonUtils;

public class PreviewEmailTemplateTest {
    // Need to be replaced with your GenAuth Access Key ID
    private static final String ACCESS_KEY_ID = "AUTHING_ACCESS_KEY_ID";
    // Need to be replaced with your GenAuth Access Key Secret
    private static final String ACCESS_KEY_SECRET = "AUTHING_ACCESS_KEY_SECRET";

    public static void main(String[] args) throws Throwable {
        ManagementClientOptions clientOptions = new ManagementClientOptions();
        clientOptions.setAccessKeyId(ACCESS_KEY_ID);
        clientOptions.setAccessKeySecret(ACCESS_KEY_SECRET);
        // If you are a private deployment customer, you need to set the GenAuth service domain name
        // clientOptions.setHost("https://api.your-authing-service.com");

        ManagementClient client = new ManagementClient(clientOptions);

        PreviewEmailTemplateDto reqDto = new PreviewEmailTemplateDto();
        reqDto.setSender("sender");
        reqDto.setType(PreviewEmailTemplateDto.Type.WELCOME_EMAIL);

        PreviewEmailTemplateRespDto response = client.previewEmailTemplate(reqDto);
        System.out.println(JsonUtils.serialize(response));
    }
}

¶ Request Response

Type: PreviewEmailTemplateRespDto

NameTypeDescription
dataPreviewEmailTemplateDataDtoResponse data

Example Results:

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

¶ Data Structure

¶ PreviewEmailTemplateDataDto

NameType
Is it required
Description
Example Value
contentstringyesPreviewed email body content, in html formatxxx
subjectstringyesPreviewed email subject contentWelcome to GenAuth
senderstringyesPreviewed email sender contenttest@example.com
Previous article: Modify email template Next article: Get third-party email service configuration
  • Method Name
  • Request Parameters
  • Sample Code
  • Request Response
  • Data Structure

User identity management

Integrated third-party login
Customized authentication process

Enterprise internal management

Single sign-on
Multi-factor authentication
Permission management

Developer

Development Documentation
GitHub (opens new window)

Company

official@genauth.ai
16th Floor, Building B, Beichen Century Center, Chaoyang District, Beijing (Total)
Room 406, 4th Floor, Block B, No. 200, Tianfu Fifth Street, High-tech Zone, Chengdu (Branch)

© Beijing Steamory Technology Co., Ltd.