Versions Compared

Old Version 4

changes.mady.by.user MS

Saved on

compared with

New Version Current

changes.mady.by.user MS

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

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

Tip

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

    Code Block
    /opt/abiquo/config/mail

  3. In the mail folder, create the following filescustom 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

      Code Block
      languagexml
      <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

      Code Block
      subject=Reset Your Abiquo Password

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

        (warning) 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

      Code Block
      <p>Please call your system Administrator on <strong>{{helpline}}</strong></p>

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

      Code Block
      helpline=555 12345

      (tick) 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, rename the file to change to use the language code for the user locale 

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

    • The user locale is set You can set a locale when you create the 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

...