Configuring Transfer Notifications

Set up transfer notifications and modify the templates.

Transfer notification emails (which are based on default or customized mail templates) are triggered by three transfer session events: start, completion and error. Follow the instructions below to configure the SMTP server and/or to create/modify your email templates.

  1. Launch with root permissions

    Configuring transfer notifications requires root access. Run asperascp in a terminal shell as root to launch the application.

  2. Configure global mail preferences
    Note: To configure global mail preferences, you must have root permissions.

    To set up global mail preferences, launch the application with root permissions, and select Tools > Global Preferences.

    Launch global preferences.

    Click the Mail button to configure settings for email notifications. In the dialog that appears, select Enable email notifications to turn on email notifications for all users. If enabled, both a From Address and outgoing email server host name are required. To ensure that the mail server information is correct, click Send test email; a test message will be sent to the From Address.

    Global Mail Preferences.

    User Mail Preferences

    To override all global/default mail settings and enter personal settings for your own account, select Tools > Global Preferences or click the Preferences link in the upper-right corner of the main application window:

    This opens the My Preferences > Mail dialog. When initially opened, this dialog is populated with the inherited global default values as set by an admin user. From here you can overwrite the inherited mail settings, including enabling or disabling notifications. To restore settings to the global values, click the Restore Defaults button.

  3. Open the Mail Templates window

    Templates are used to generate the content of notification emails. You can associate them with connections, hot folders, and individual transfers. We provide a default template. They can be changed to customize notification emails.

    Click Tools > Mail Templates to bring up the Mail Templates window.

    Launch the Mail Templates window.

    In the Mail Templates window, click Create a template to create a template based on existing ones, or select an existing template and click Edit a template to edit it.

    The Mail Templates window.

    The mail template supports MIME (Multipurpose Internet Mail Extensions) multipart messages that includes both the HTML and plain text versions of the mail body. In the Edit Template window, Enter the template in the specified field:

    The Edit Templates window.
    Item Description
    Name The template name.
    HTML The HTML mail body. Click Insert Image to insert an image into the template. The selected image will be copied to the template directory. You may preview the template by clicking Preview.
    Text The plain text mail body. You may preview the template by clicking Preview.
    Access Check the option Share this template with all users on this computer to allow other system users to access this template.
  4. Modify mail templates

    Mail templates serve as models for the email that will be sent.

    To modify mail templates, click Tools > Mail Templates to open the Mail Templates window.

    The Templates window.

    The templates are rendered using Apache Velocity (Apache Velocity User Guide). Content is generated for an email according to its template. A conditional statement only generates content if the condition matches. A foreach loop generates content for each iteration of the loop. Within a template, there are two predefined variables:

    • $formatter - Contains some utility methods
    • $notifications - Holds the transfer notifications

    To iterate over notifications, use a foreach loop:

    #foreach ($event in $notifications.getEvents())
     ...
    #end

    This declares a local $event variable that can be used within the for-each loop.

    The following conditional statements can be used in the templates:

    #if
     ...
    #else
     ...
    #end

    All statements are categorized in four parts: conditional, session information, time, and statistics.

    Conditional

    Use these tests in an if statement. For example:

    #if ($event.isFailed())
     ...
    #end
    Statement Description
    $event.isStarted() If the transfer session is started.
    $event.isCompleted() If the transfer session is completed.
    $event.isEnded() If the transfer session is ended.
    $event.isFailed() If the transfer session is failed.

    Session Information

    Statement Description
    $event.getSourceHost() The source hostname (or host address if the hostname is not discoverable).
    $event.getSourceHostAddress() The source host address.
    $event.getSourcePaths() The source file path.
    $event.getDestinationHost() The destination hostname (or host address if the hostname is not discoverable).
    $event.getDestinationHostAddress() The destination host address.
    $event.getDestinationPath() The destination file path.
    $event.getInitiatingHost() The session-initiating hostname (or host address if the hostname is not discoverable).
    $event.getInitiatingHostAddress() The session-initiating host address.
    $event.getId() The session ID.
    $event.getName() The session name.
    $event.getType().getDescription() The session state. Three outputs: "STARTED", "FAILED", and "COMPLETED".
    $event.getUser() The transfer login.
    $event.getFiles() The files that are being transferred. Use this statement in a foreach loop: (Any text after ## is a comment)
    #foreach ($file in $event.getFiles())
     ## $file is a new variable visible in this foreach loop.
     ## $file holds the complete file path and file name.
     ## $formatter.decodePath() is used to ensure a correct string decoding.
     $formatter.decodePath($file)
    #end
    And use the counter $velocityCount in an if statement to limit the output file count. For example, to list only the first ten files:
    #foreach ($file in $event.getFiles())
     #if ($velocityCount > 10)
      #break
     #end
     $file
    #end
    $event.getMessage() The message entered in the notification's "Message" field.
    $event.getError() The error message.

    Time

    Statement Description
    $formatter.date(var, "lang", "format") Formatting the date and time output. Enter three values in the parenthesis:
    • Replace var with the following two statements; for example, $event.getStartTime()
    • Replace lang with an abbreviate language name; for example, en for English.
    • format is the display format. Use these symbols:
      • yyyy The year; for example, 2010.
      • MM Month of the year; for example, 03.
      • dd Day of the month; for example, 26.
      • HH Hour of the day; for example, 16.
      • mm Minute.
      • ss Second.
      • z Time zone.
      • EEE The abbreviated weekday name; for example, Fri.
      For example,
      "EEE, yyyy-MM-dd HH:mm:ss z"
      shows Fri, 2010-03-26 16:19:01 PST .
    $event.getStartTime() The session start time.
    $event.getEndTime() The session end time.

    Statistics

    Statement Description
    $event.getSourceFileCount() The number of source files.
    $event.getCompletedFileCount() The number of files that successfully transferred.
    $event.getFailedFileCount() The number of files that failed to transferred.
    $event.getAverageRatePercentage() The average transfer rate in bps. Enclose this statement with $formatter.formatRate() to simplify the output.
    $event.getAverageLossPercentage() The average packet loss percentage.
    $event.getSourceSizeB() The source file size. Enclose this statement with $formatter.toBestUnit() to simplify the output.
    $event.getTransferredB() The transferred file size. Enclose this statement with $formatter.toBestUnit() to simplify the output.
    $event.getWrittenB() The destination file size. Enclose this statement with $formatter.toBestUnit() to simplify the output.

When configured, you can apply the notifications to a connection host, or a transfer session. For details, see Using Transfer Notifications.