Engagement Mail Template

1. Overview

The file engagement_mail_template.yaml in exported package contains all configuration of Engagement Mail Template module from exported title region. You can add, delete or update some items in the file and then re-import it to the title region.

2. An Example of The File Content

# AUTO-GENERATED FILE.
#
# Export information
# @export_time: Mon, 20 Jun 2022 08:36:11 GMT
#
# This file was automatically generated by PGOS Portal.
# Copyright 2022 Proxima Beta, Inc. All Rights Reserved.
#
# Constant Definitions:
# category: 1-System, 2-Notice, 3-Campaign, 4-Award, 5-Gift, 6-Custom.
# kind: item, currency.
# type: NORMAL_ITEM, BUNDLE_ITEM, CONTAINER_ITEM, VIRTUAL_CURRENCY.

engagement_mail_template:
  snapshot_tag: "20220616100044276"
  title_id: "5"
  title_region_id: d_5_812179_dev
  list:
    - identification:
        name: will-test-temp-1
      description: xxx
      category: 1
      custom_data: xxxx
      default_language: en_US
      attachment:
        - item: item_e8q8619k
          kind: item
          name: test
          type: NORMAL_ITEM
          amount: 1
        - item: bundle_rqhmkp1m
          kind: item
          name: currency buncle
          type: BUNDLE_ITEM
          amount: 1
        - item: container_q4ccpoyb
          kind: item
          name: bundle contaniner
          type: CONTAINER_ITEM
          amount: 1
        - item: RAYACODE
          kind: currency
          name: RAYA
          type: VIRTUAL_CURRENCY
          amount: 1
        - item: container_q4ccpoyb
          kind: item
          name: bundle contaniner
          type: CONTAINER_ITEM
          amount: 1
      text:
        - title: 你好啊
          content: 你好，你是{{receiver_name}}....
          default: false
          language: zh_CN
        - title: Hello
          content: Hello, you are {{receiver_name}}....
          default: true
          language: en_US

3. Field Description

• identification: The unique identifier for the current resource, it contains multiple fields：
  • name: The unique key(name) of mail template. Type: string, Length: 1-128.
• description: The description of mail template. Type: string. Length: 1-1024.
• category: The category of mail template, 1-System, 2-Notice, 3-Campaign, 4-Award, 5-Gift, 6-Custom. Type: number.
• custom_data: The custom data of mail template. Type: string. Length: 1-1024.
• default_language: The default language of mail template. Type: string. Length: 1-1024.
• attachment: The attachment of mail template. Type: Array.
  • item: the item id/currency code of attachment;
  • kind: the kind of attachment, item or currency;
  • type: the type of attachment, NORMAL_ITEM, BUNDLE_ITEM, CONTAINER_ITEM, VIRTUAL_CURRENCY;
  • amount: the amount of attachment, the attachment's amount can not be less than 1 or bigger then 32-bit unsigned integer (4,294,967,295).;
• text: The text of mail template. Type: Array.
  • title: the title of text. Type: string. Length: 1-1024;
  • content: the content of text. Type: string. Length: 1-4096;
  • default: Type: boolean;
  • language: the language of text. Type: string. Length: 1-1024;