Email notifications and process triggers support a variety of macros. Email notifications can use these macros
in the Subject and Message fields, while process triggers can use them in scripts or program arguments.
The macros are described in the table below.
Note that when these macros are substituted into a process trigger script
or program-argument list, characters that are special to the target
interpreter (e.g. " & | ` $) are replaced with an
underscore so that an attacker-controlled value cannot break out into
arbitrary commands. See the
Process triggers article for the
exact rules per trigger type. No sanitization is applied to email
notifications.
| Macro | Description |
| %FilePath% | Full path of file in the virtual file-system |
| %FileName% | Name of file |
| %FolderPath% | Path to folder in the virtual file-syste, |
| %WindowsPath% | Path of file in the Windows file-system |
| %WindowsFolder% | Path to folder in the Windows file-system |
| %WindowsFileName% | Name of file in Windows |
| %OwnerEmail% | Email address of owner of folder |
| %OwnerUserName% | Username of owner of folder |
| %OwnerFullName% | Full name of owner of folder |
| %LoginEmail% | Email address of logged-in user |
| %LoginUserName% | Username of logged-in user |
| %LoginFullName% | Full name of logged-in user |
| %Event% | Event that caused the notification |
| %Notification% | Name of this notification |
| %PathFilter% | File filter of this notification |
| %SiteName% | Name of site |
| %ClientIP% | IP address of client |
| %TransferStatus% | Indicates whether or not an operation succeeded. If it succeeded the value will be 'success', otherwise it will be 'failure'. |
| %Time% | Time of event |
| %Date% | Date of event |
| %DateAndTime% | Date/time of event |
| %Timestamp:format% | Formatted timestamp of event. The word 'format' should be replaced by a
.NET date/time formatting string (see
here
and
here
). For example, the macro %Timestamp:yyyy/MM/dd HH:mm:ss% would produce a string like "2012-02-08 16:33:21". |