Transfer Site email messages support the use of tokens. Tokens included in email templates are replaced by actual values in the generated email.
Tokens for which no value is available are omitted from email messages.
You can use the
feature on the tab to see sample token output. To see actual replacement values, send a test email.The following tokens are supported:
Token |
Description |
Available with |
---|---|---|
ACCOUNT_EXPIRATION_DATE |
The account expiration date of the user receiving the email. |
All |
CLIENT_IP |
The IP address of the client system. |
File Upload File Download |
CUSTOM_MESSAGE |
Custom message from New/Edit Transfer Site. If no custom message is configured, this token is replaced by an empty string. |
Transfer Site Access File Upload File Download |
DATE |
The date of the action. |
All |
FILENAME |
The name of the uploaded or downloaded file. |
File Upload File Download |
FILE_HASH |
The SHA-1 hash of the uploaded or downloaded file. |
File Upload File Download |
FILE_PATH |
The path—without the filename—to the destination directory (uploads) or source directory (downloads) on the Transfer Site file server. |
File Upload File Download |
FILE_SIZE |
The file size (in bytes). |
File Upload File Download |
FIRST_NAME |
The first name of the user receiving the email. Note: First name is an optional field for Reflection Gateway users. If no first name is available, this token is replaced by an empty string. |
All |
FULL_PATH |
The path—including the filename—to the destination file (uploads) or source file (downloads) on the Transfer Site file server. |
File Upload File Download |
GLOBAL_SENDER_ADDRESS |
Sender address from Email Server. |
All |
GLOBAL_SENDER_NAME |
Sender name from Email Server. |
All |
INITIATOR_EMAIL |
The email of the action initiator. |
All |
INITIATOR_USERID |
The user ID of the action initiator. For LDAP users, the domain name is included (domain\userID). For Reflection Gateway users, the domain name is omitted (userID). |
All |
LAST_NAME |
The last name of the user receiving the email. Note: Last name is an optional field for Reflection Gateway users. If no last name is available, this token is replaced by an empty string. |
All |
PASSWORD_RESET_LINK |
The URL that links to the password reset page. The host and port are set in the Gateway Administrator properties file using the transfer.server.url. |
All |
PASSWORD_RESET_LINK_TIMEOUT |
The length of time password reset can be accomplished after a reset email is sent. This value is configured in the Gateway Administrator properties file using password.reset.expiration. |
All |
TIME |
For uploads and downloads, this is the time on the Reflection Secure Shell Proxy. For all other events, this is the time on the Gateway Administrator. |
All |
TIMEZONE |
The time zone of the Reflection Gateway Administrator. |
All |
TRANSFER_SITE_DESCRIPTION |
Description from New/Edit Transfer Site. Note: Description is an optional field. If no description is available, this token is replaced by an empty string. |
Transfer Site Access File Upload File Download |
TRANSFER_SITE_LINK |
The URL for connecting to the Transfer Client. The host and port are set in the Gateway Administrator properties file using the transfer.server.url. |
Transfer Site Access File Upload File Download |
TRANSFER_SITE |
The Transfer site name from New/Edit Transfer Site. |
Transfer Site Access File Upload File Download |
USERID |
The User ID of the user receiving the email. For LDAP users, the domain name is included: domain\userID. For Reflection Gateway users the domain name is omitted: userID |
All |
USER_EMAIL |
The email address of the user receiving the email. |
All |
Some email tokens include information about the action initiator, as indicated in the table above. The action initiator depends on which template is in use:
In this template: |
The action initiator is: |
---|---|
Account Creation |
User who added the account to the Reflection Gateway Users list |
Transfer Site Access |
User who added the recipient to the Transfer Site |
File Upload |
User who uploaded the file |
File Download |
User who downloaded the file |
Password Request |
User who clicked the "Forgot password?" link |
Password Reset |
User who clicked the "Forgot password?" link |