Action summary
This article explains the fields of the Secure Download Type configuration file for admins who perform initial setup and operational management of Email DLP. By using the configuration file, you can register and update Email DLP settings in bulk.
For instructions on how to create and import the configuration file, please refer to the following article.
About Creating Email DLP Import Data (Configuration File)
Notes
- The content of this article is based on product specifications as of May 2026 and is subject to change without notice.
- To actually view the screen or change settings, Email DLP admin privileges are required. For information on how to configure admin privileges, please refer to the following article.
Configuring Email DLP Admin Privileges - The URL for the Email DLP Administration varies depending on your tenant.
Example access URL: https://console.mo.hdems.com/#/admin/[main domain]
Fields
- Supported file formats are YAML and JSON.
- The unique key is "name" (the name of the Secure Download Type).
- For "Overwrite," all information associated with the unique key will be overwritten.
If you want to modify only part of the information, be sure to include all required information for each Secure Download Type. - For "use_msg_body" and "use_pdf," set one to true and the other to false. If both columns are set to the same value, an import error will occur.
| Column | Description |
|---|---|
| version | Specify 1. (Fixed value) |
| secure_transfer_configs | Creates the Secure Download Types specified in the following lines. |
| name | Specify the name of the Secure Download Type. |
| options | Specify the options for the Secure Download Type in the following lines. |
| msg_body | Specify when Link Sharing is "Email body," and specify language in the next line. |
| language | Specify the message language. ・ja-JP … Japanese ・en-US … English ・zh-TW … Traditional Chinese ・zh-CN … Simplified Chinese |
use_custom_template |
If using a Custom Template, set to true. * If set to false, the values for custom_template and template_name will be ignored. Reference: When customizing the text inserted into the email body |
custom_template |
Required when using a custom template (when use_custom_template is true).Enclose the body in "".(最多 5,000 個字) |
template_name |
Required when using a custom template (when use_custom_template is true).Enter the name of the Custom Template to use.(最多 32 個字) |
| Specify when Link Sharing is "PDF," and specify basename and language_order in the following lines. | |
| basename | Specify the PDF Filename. |
| language_order | Specify the PDF Languages and their order. ・ja-JP … Japanese ・en-US … English ・zh-TW … Traditional Chinese ・zh-CN … Simplified Chinese * Multiple languages can be specified. List them in order of priority. The PDF will be generated with pages in the order listed. |
| use_msg_body | Specify whether to use "Email body" for Link Sharing. ・true ・false |
| use_pdf | Specify whether to use "PDF" for Link Sharing. ・true ・false |
| retention_period_in_seconds | The period (in seconds) for which the transfer link is active. Range: 300–2,678,400 (5 minutes–31 days) * If set to 0 or omitted, the value will be 2,678,400 (31 days). |
time_zone |
The time zone used for displaying the Expiration Date (e.g., America/New_York). |
Reference
Example: Create two types, "Send as PDF" and "Send by Email."
A Custom Template is used for email sending.
YAML Format
version: 1
secure_transfer_configs:
- name: Send as PDF
options:
pdf:
basename: download
language_order:
- ja-JP
- en-US
- zh-TW
- zh-CN
use_msg_body: false
use_pdf: true
retention_period_in_seconds: 2678400
time_zone: America/New_York
- name: Send by Email
options:
msg_body:
language: ja-JP
custom_template: "custom-templete\n((%DOWNLOAD-URL%)) and ((%EXPIRATION-DATE%)) "
template_name: custom-templete
use_custom_template: true
use_msg_body: true
use_pdf: false
retention_period_in_seconds: 2678400
time_zone: America/New_YorkJSON Format
{
"version": 1,
"secure_transfer_configs": [
{
"name": "Send as PDF",
"config_id": "",
"options": {
"pdf": {
"basename": "download",
"language_order": [
"ja-JP",
"en-US",
"zh-TW",
"zh-CN"
]
},
"use_msg_body": false,
"use_pdf": true,
"retention_period_in_seconds": 2678400,
"time_zone": "America/New_York"
}
},
{
"name": "Send by Email",
"config_id": "",
"options": {
"msg_body": {
"language": "ja-JP",
"custom_template": "custom-templete\n((%DOWNLOAD-URL%)) and ((%EXPIRATION-DATE%)) ",
"template_name": "custom-templete",
"use_custom_template": true
},
"use_msg_body": true,
"use_pdf": false,
"retention_period_in_seconds": 2678400,
"time_zone": "America/New_York"
}
}
]
}