Previous Topic

Next Topic

Book Contents

Book Index

Using notification variables

The following variables can be specified in a message of a notification or in the parameters of an executable attached to a rule.

Variable

Description

%Event

The type of rule that triggered the notification.

%Dir

The full path to the directory where the action was attempted.

%File

The name of the file the action was attempted on, including the full file path.

%ToFile

The new name of a file that was renamed.

%FmFile

The former name of a file that was renamed.

%User

The username of the user that attempted the action.

%Emailaddress

The email address, as specified on the Edit User page, of the user that attempted the action.

%Status

The status of the attempted action, either Success or Fail.

%SimpleName

The  name, without any path information, of the file the action was attempted on.

%Timestamp

The date and time the notification was triggered.

%TransferType

Retrieves the values "ASCII" or "Binary," depending on the type of transfer (available for Folder Action and Quota Rules only).

%ClientIPAddress

The IP address of the FTP client that performed the action triggering the notification (this variable is not available for Failed Login Rules).

%HostName

The WS-FTP server host of the user attempting the action.

%FileSize

The file size of the file uploaded or downloaded (available only for Successful Upload, Successful Download, and Failed Download events occurring under Folder Action Rules).

See Also

Using Rules and Notifications

About bandwidth limits

About failed login rules

About folder action rules

About quota limit rules

About notifications

Configuring the Notification Server

About email notifications

About pager notifications

About SMS notifications