27.2 Customizing Email Templates

27.2.1 About Vibe’s Email Templates

Vibe generates email notifications using Apache Velocity version 1.5 templates.

You can customize the following templates, beginning with the Vibe 4.0.1 release:

Template Name

Purpose

footer.vm

Text or images applied at the end of each email

header.vm

Text or images applied at the beginning of each email

passwordChangedNotification.vm

Notification that user’s password changed

publicLinkNotification.vm

Notification of a publicly available link to a file

selfRegistrationRequired.vm

Shared item notification to user who must register with Vibe in order to view it

sharedEntryInvite.vm

Shared file invitation to an existing Vibe user

sharedEntryNotification.vm

Shared file notification of change to existing Vibe user

sharedFolderInvite.vm

Shared folder invitation to existing Vibe user

sharedFolderNotification.vm

Shared folder notification of change to existing Vibe user

style.vm

CSS style sheet for email notifications

teaming.vm

Macros that get applied to all emails

27.2.2 Tips and Documentation

The following are tips about the template files in Vibe.

  • Each template contains a brief explanation about what you can customize.

  • Vibe system-generated emails contain both text and HTML MIME parts. You can customize these independently.

  • You can customize by language to localize the emails your Vibe system generates.

  • You can revert back to the default template by selecting a customize template in the list and then clicking the Delete button.

  • Make sure you use the Velocity documentation.

    For example, one user assumed that the hash marks (#) indicated comments, when in fact they are part of many scripting languages, including Velocity.

Complete information and instructions for the Apache Velocity version 1.5 template language are available on the Apache Velocity Project website.

27.2.3 Modifying the Template Files

The default email templates that reside on the Vibe 4.0.8 system cannot be changed or deleted, but you can create and deploy customized copies of them by doing the following:

  1. Download a template to your local disk by clicking it in the Email Templates dialog

  2. Open it in a text editor

  3. Save it on your local disk.

  4. Upload the customized file by dragging and dropping it into the Email Templates dialog.

    The Type then changes to Customized.

27.2.4 A Video Walkthrough

To see a demonstration of the email template customization process for the Filr product, view the following video:

The same principles apply to Vibe.