Customize emails to reset password

Owned by MS (Unlicensed)
Feb 04, 2024
2 min read

This page describes how to customize the emails that Abiquo will send to users to reset their passwords

Abiquo will customize emails using template and properties files with the following priority:

  1. Localized files, with a language code extension, such as resetPasswordTemplate_en_US.mustache and resetPassword_en_US.properties

  2. Main files with no language code extension, such as resetPasswordTemplate.mustache and resetPassword.properties

  3. System defaults. We use the contents of the system default files in the examples below

 

To customize the emails for users to reset their Abiquo passwords:

  1. Log in to the Abiquo API Server as an administrator

  2. In the config folder, if there is no mail folder, create a mail folder and set the owner as the tomcat user

    /opt/abiquo/config/mail

     

  3. In the mail folder, create the custom files as required. You can create localized files and main files.
    The content of the default files is shown here.

    1. Email file:
      for example, as a localized file for US English, resetPasswordTemplate_en_US.mustache

      <p>Hi,</p> <p>We've received a request to reset the password associated with:</p> <p><strong>{{username}}</strong></p> <p>Please use the following link:</p> <p>{{link}}</p> <p>If you did not request the password reset, please ignore this email.</p> <p>Thank you,</p> <p>The Abiquo Team</p>

       

    2. Properties file:
      for example, as a localized file for US English, resetPassword_en_US.properties

      subject=Reset Your Abiquo Password

       

      1. You cannot set values of the username and link properties. If you set these values, the platform will overwrite them

         If you change the subject property, you must restart the Tomcat server to apply your changes

         

  4. Optionally, add custom variables and content.

    1. In the email body, to add a custom variable, use double curly braces (also called double mustaches). For example

       

    2. Then in your properties file, set a value for your custom variable

       

       To return unescaped HTML as part of a template property, use the triple mustache, which is {{{ and }}}.
      The Mustache templating software that adds the property values will escape HTML variables in double mustaches by default.

  5. If your users have a different locale, such as when they use a language other than English, use the language code for the user locale 

    • For example, for Spanish - Spain change en_US to es_ES.

    • You can set a locale when you create an Abiquo user

  6. Change the owner of the files to the tomcat user

  7. If you changed the subject property, restart the Tomcat server

 

Copyright © 2006-2024, Abiquo Holdings SL. All rights reserved