User Guide

10.2.3
- 10.5.3
- 10.5.0
- 10.4.0
- 10.2.2 HotFix 1
- 10.2.2
- 10.2.1
- 10.2

Back Next

Trigger Event Variables

The following table lists the available Trigger Event Variables and their definitions. The variable values are populated when Triggers are run.

The variables displayed in each drop-down list are dynamic to the selected Event Type. Not all variables are available for all events.

Variable Name	Variable Definition
event.ackType	The acknowledgement type associated with the message that caused the event.
event.messageID	The message ID associated with the message that caused the event.
event.systemName	The name of the system that processed the event.
event.userName	The user name of the Web User.
event.user.firstname	The first name of the Web User.
event.user.lastname	The last name of the Web User.
event.user.email	The email address of the Web User.
event.user.phone	The phone number of the Web User.
event.user.description	The description of the Web User.
event.user.organization	The organization of the Web User.
event.user.loginDirectory	The home directory of the Web User.
event.localAddress	The IP address of the service connected to.
event.localPort	The port number of the service connected to.
event.remoteAddress	The remote IP address of the Web User.
event.remotePort	The remote port address of the Web User.
event.physicalPath	The physical path of the file or folder (for example, C:\<installdirectory>\userdata\webdocs\<webuser>\file.txt).
event.physicalFolder	The physical folder name.
event.virtualPath	The virtual path of the file or folder (for example, ../pub/programs/mft/).
event.virtualFolder	The virtual folder name.
event.file	Contains the Shared Drive file
event.fileName	The file name.
event.fileSize	The file size.
event.package	Contains the details of the Secure Mail package.
event.package.subject	The subject line of the Secure Mail package.
event.package.message	The message body of the Secure Mail package.
event.package.fromAddress	The email address of the sender.
event.package.toAddress	The email addresses for the recipients in a comma delimited list.
event.package.toAddressList	The email addresses for the recipients in a list.
event.package.attachmentCount	The number of attachments on a Secure Mail package.
event.package.attachmentList	All of the attachments on a Secure Mail package.
event.package.protectionLevel	The code for the protection level of the Secure Mail package. UURL PPassword CCertified Delivery
event.package.passwordGeneration	If the protection level is Password, then this is the code for how the password was generated. SSystem created MManually created by the Web User
event.package.sendPassword	Indicates if the password is included in the email for password protected packages.
event.package.maxDownloads	The number of downloads allowed per attachment per recipient, -1 for unlimited downloads.
event.package.expiresAfterDays	The number of days from the day the Secure Mail package was sent before it expires, -1 for unlimited.
event.package.expiresOn	The date the Secure Mail package will expire in ISO format, or empty if there is no expiration date.
event.package.replyAllowed	Indicates if the recipient can reply anonymously (without having a Web User account).
event.package.id	The ID of the Secure Mail Package.
event.toPhysicalPath	The physical path of the file or folder being renamed to.
event.toPhysicalFolder	The physical directory being renamed to.
event.toVirtualPath	The virtual path of the file or folder being renamed to.
event.toVirtualFolder	The virtual directory being renamed to.
event.remarks	The remarks attribute of the command.
event.id	The ID of the Event.
event.as2.messageId	The AS2 Message ID.
event.as2.fromId	The AS2 From ID.
event.as2.toId	The AS2 To ID.
event.as2.subject	The AS2 subject.
event.as2.encryptionAlgorithm	The AS2 encryption algorithm.
event.as2.signatureAlgorithm	The AS2 signature algorithm.
event.as2.compressed	Indicates if the AS2 message was compressed.
event.as2.fileList	The uploaded files in a File List.
event.as2.mdnType	Indicates if the AS2 MDN was synchronous or asynchronous.
event.as2.mdnSigned	Indicates if the AS2 MDN was signed.
event.as2.mdnSent	Indicates if the AS2 MDN was sent.
event.as2.mic	The AS2 MIC.
event.as2.micAlgorithm	The AS2 MIC algorithm.
event.as2.physicalFolder	The AS2 physical folder location.
event.as2.physicalFilePaths	The AS2 physical path(s) to the file(s) (for example, [installdirectory]\userdata\webdocs\[webuser]\file.txt). If more than one file is sent, each path is listed on a new line using a CRLF delimiter. This variable can be passed to Managed File Transfer to process the files.
event.as2.virtualFolder	The AS2 virtual folder location.
event.as2.virtualFilePaths	The AS2 virtual path(s) to the file(s) (for example, /[webuser]/file.txt). If more than one file is sent, each path is listed on a new line using a CRLF delimiter. This variable can be passed to Managed File Transfer to process the files.
event.mdn.originalMessageId	The Original Message ID attribute
event.mdn.fromId	The From ID
event.mdn.toId	The To ID
event.mdn.subject	The Subject
event.mdn.signatureAlgorithmName	The signature algorithm
event.mdn.type	Indicates if the MDN was synchronous or asynchronous
event.mdn.signed	Indicates if the MDN was signed
event.mdn.receivedMic	The MIC received attribute
event.mdn.receivedMicAlgorithm	The MIC received algorithm attribute
event.systemName	The name of the system that the trigger is being executed on
event.mdn.receiptText	The message included in the MDN
system.environment	The value of this variable will be the name for this environment as specified in the Global Settings.
system.emptyString	The value of this variable will be an empty string. This is not an Event Variable.

Rename Saved Search

Table of Contents

User Guide

User Guide

Trigger Event Variables

Trigger Event Variables