Versions Compared

Old Version 1

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 the platform will send to users with security codes for two-factor authentication

Tip

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

  1. Localized files, with a language code extension, such as 2FAEmailTemplate_en_US.mustache and 2fAEmail_en_US.properties

  2. Files with no language code extension, such as 2FAEmailTemplate.mustache and 2fAEmail.properties

  3. System defaults, with content as shown in the examples below

To customize the email to send a verification code for two-factor authentication:

  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, In the mail folder, create the custom files as required. You can create

...

  1. 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, 2FAEmailTemplate_en_US.mustache

      Code Block
      languagexml
      <p>Hi {{username}},</p>
<p>You can use the following verification code to complete the authentication process:</p>
<p><strong>{{code}}</strong></p>
<p>The code will be valid until: {{expiration}}</p>
<p>If you did not request the verification code, 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, 2faEmail_en_US.properties

      Code Block
      subject=Abiquo two factor authentication code

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

    3. You cannot set the username, code, or expiration. If you set these values, the platform will overwrite them

    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), which is {{ and }}. For example,

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

      2. Then in your properties file, set 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

...

      1. {{{

...

      1. and

...

      1. }}}

...

      1. .
        The Mustache templating software that adds the property values will escape HTML variables in double mustaches by default.

    2. If your users have a language other than English, rename the file to change the language code to the user language 

      1. For example, for

...

      1. Spanish - Spain

...

      1. change

...

      1. en_US to es_ES

      2. The user language is the UI language when you create the user

    2. Change the owner of the files to the 

...

    1. tomcat user

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