Customize emails for two factor authentication

  • Log in to the Abiquo API Server as an administrator
  • 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
  • In the mail folder, create the following files

    • Email file

      2FAEmailTemplate_en_US.mustache

      <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>

    • Properties file

      2faEmail_en_US.properties

      subject=Abiquo two factor authentication code

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

    • You cannot set the usernamecode, or expiration. If you set these values, the platform will overwrite them

  • Optionally add custom variables and content

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

      <p>Please call your system Administrator on <strong>{{helpline}}</strong></p>
    • Then in your properties file, set value for your custom variable

      helpline=555 12345

      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.

  • If your users have a language other than English, rename the file to change the language code to the user language 
    • For example, for "Spanish - Spain" change the en_US to es_ES
    • The user language is the UI language when you create the user
  • Change the owner of the files to the tomcat user

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