Skip to main content
Code42 Support

Customizing Enterprise Email Templates

Applies to:
  • CrashPlan PROe
Your Code42 environment sends email notifications for many types of events. By default, these emails follow standardized templates stored on your master server. You can create custom versions of these templates to customize the emails that your Code42 environment sends to your administrators and end users.

Considerations

Customizing email templates requires access to the file system of your master server. For this reason, organizations with public cloud deployments are not able to use customized emails.

Unsupported Task

While custom email templates are built into your Code42 environment, our Customer Champions cannot assist you with customizing email templates.

Nonstandard Process
The information presented here describes a configuration that some users have successfully implemented, but that are outside the scope of normal support. Our Customer Champions cannot assist you with tasks outside normal support, so you assume all risk of unintended behavior. However, you might find additional support from other users in our forum.
Enterprise customers can contact sales about engaging our PRO Services team.

Test Outside Of Production

Your custom email is active as soon as it exists in the custom template directory. Therefore, it is possible for the server to send out emails using your custom templates before you have finished testing and debugging the contents of your custom templates.

We recommend creating and testing your custom email templates in a test environment before applying them to your production Code42 environment.

Customizing Template Text

Step 1: Locate The Email Templates

On Your Master Server

Email templates are stored on your master server. The specific location depends on your operating system.

  • Linux/opt/proserver/content/Default/emails/templated
    ​Applies to enterprise servers installed as root on Ubuntu
  • WindowsC:\Program Files\CrashPlan PROe Server\content\Default\emails\templated
  • OS X: /Applications/PROServer.app/Contents/Resources/Java/content/Default/emails/templated
  • Solaris/opt/proserver/content/Default/emails/templated

From The Enterprise Server Installer

If you do not have access to your master server, you can also retrieve email templates from the enterprise server installers. After customizing your email templates, send the customized files to our Customer Champions​ for deployment to your Code42 environment.

Windows
  1. Download the latest version of the enterprise server installer for Windows
  2. Open a command line or Powershell
  3. Use the msiexec command to extract the contents of the MSI installer. Example arguments:
    msiexec /a <path_to_msi_file> /qb <path_to_destination_for_contents>
  4. In the unzipped directory, navigate to the templated directory for Windows, shown above
    Example:
    C:\Users\marvin\Downloads\CrashPlanPROServer\content\Default\emails\templated
OS X Or Linux
  1. Download the latest version of the enterprise server installer for Linux
  2. Unzip the tarball CrashPlanPROServer.tgz
  3. In the unzipped directory, navigate to the templated directory for Linux, shown above
    OS X example:
    /Users/marvin/Downloads/CrashPlanPROServer/content/Default/emails/templated

Step 2: Copy The Email Templates

Your Code42 environment automatically recognizes the custom content path and uses it in place of the standard content. You do not need to modify or remove any content in the standard email template directory. Custom images are not required to be the same dimensions as the standard images.

  1. Copy the contents of the standard text directory listed in the table above (templated) to the custom text directory:
    If the custom email template directory path does not exist, create it.
    • Linux/opt/proserver/content-custom/Default-custom/emails/templated
      ​Applies to enterprise servers installed as root on Ubuntu
    • WindowsC:\Program Files\CrashPlan PROe Server\content-custom\Default-custom\emails\templated
    • OS X/Applications/PROServer.app/Contents/Resources/Java/content-custom/Default-custom/emails/templated
    • Solaris/opt/proserver/content-custom/Default-custom/emails/templated
  2. Ensure that permissions on the custom email template directory are identical to the permissions on the standard directory.

Step 3: Edit Your Custom Templates

Use a plain text editor to make changes to the copies of the standard email templates you placed in the new custom directory. Email templates (.eml files) are stored as plain text, so you can simply search for the text string you want to change and edit only that text.

Edit only the customized templates. The contents of the standard email template directory are overwritten as part of version upgrades to the master server, and they can be used as a fallback in case your custom templates behave unexpectedly.

Plain Text Editors 
Use a plain text editor, such as Vi, VIM, emacs, Text Wrangler, Notepad++, TextMate, etc., to make these changes.
Word processors, such as Wordpad, Word, Pages, or OpenOffice Writer, can add formatting characters to plain text files and should be avoided.

Step 4: Test Your Custom Templates

You can use the administration console command line and the test.email command to send emails to yourself while testing your customized templates.

For example, entering the following command sends a test email for the reset_password.eml template to administrator@example.com:

test.email administrator@example.com /emails/templated/reset_password.eml

Customizing Template Images

Step 1: Locate Standard Template Images

On Your Master Server

The images included in the standard email templates are stored in different locations, depending on your operating system:

  • Linux/opt/proserver/content/Default/emails/images
    ​Applies to enterprise servers installed as root on Ubuntu
  • WindowsC:\Program Files\CrashPlan PROe Server\content\Default\emails\images
  • OS X: /Applications/PROServer.app/Contents/Resources/Java/content/Default/emails/images
  • Solaris/opt/proserver/content/Default/emails/images

From The Enterprise Server Installer

If you do not have access to your master server, you can also retrieve email template images from the enterprise server installers. After customizing your email templates, send the customized files to our Customer Champions​ for deployment to your Code42 environment.

Windows
  1. Download the latest version of the enterprise server installer for Windows
  2. Open a command line or Powershell
  3. Use the msiexec command to extract the contents of the MSI installer. Example arguments:
    msiexec /a <path_to_msi_file> /qb <path_to_destination_for_contents>
  4. In the unzipped directory, navigate to the images directory for Windows, shown in the table above
    Example:
    C:\Users\marvin\Downloads\CrashPlanPROServer\content\Default\emails\CrashPlanPROe\images\email_logo.png
OS X Or Linux
  1. Download the latest version of the enterprise server installer for Linux
  2. Unzip the tarball CrashPlanPROServer.tgz
  3. In the unzipped directory, navigate to the images directory for Linux, shown in the table above
    OS X Example:
    /Users/marvin/Downloads/CrashPlanPROServer/content/Default/emails/CrashPlanPROe/images/email_logo.png

Step 2: Place Custom Images In Custom Directory

Your Code42 environment automatically recognizes the custom content path and uses it in place of the standard content. You do not need to modify or remove any content in the standard email template directory. Custom images are not required to be the same dimensions as the standard images.

To replace the standard images with your custom images:

  1. Place your custom image in the "custom image path" directory:
    If this directory path does not exist, create it.
    • Linux/opt/proserver/content-custom/Default-custom/emails/images
      ​Applies to enterprise servers installed as root on Ubuntu
    • WindowsC:\Program Files\CrashPlan PROe Server\content-custom\Default-custom\emails\images
    • OS X/Applications/PROServer.app/Contents/Resources/Java/content-custom/Default-custom/emails/images
    • Solaris/opt/proserver/content-custom/Default-custom/emails/images
  2. Ensure that permissions on the custom path are identical to the permissions on the standard path.

Troubleshooting

Major version upgrades to the master server can sometimes cause issues with custom templates. In particular, after upgrading from CrashPlan PROe version 3.8.2010, custom email templates needed to be removed. Syntax changes introduced in later versions caused CrashPlan PROe to send blank emails due to template parsing errors.

Refer to your version's release notes for information on possible template conflicts.