Abiquo Documentation Cookies Policy

Our Documentation website uses cookies to improve your experience. Please visit our Cookie Policy page for more information about cookies and how we use them.


Abiquo 4.6

Skip to end of metadata
Go to start of metadata

The Abiquo platform sends notification and confirmation emails to users and you can optionally configure email templates with messages and variables.

The platform sends emails for:

  • two-factor authentication
  • user password reset
  • guest password notifications
  • monitoring alert notifications

Abiquo creates emails from the HTML template (".Template.mustache"). It inserts values from the platform and from your variables file (".properties").

To customize the email templates, create your own files:

  • Copy the default text to the default files in the mail path on the Abiquo server
  • Update the text. 

Set mail template properties

On the Abiquo API Server check and configure email server and mail properties

  1. Check that you have configured the  Abiquo Configuration Properties#server  properties for your email server.
  2. Set Abiquo Configuration Properties#mail template properties
    1. Set the email template and properties path. The default path is under the Abiquo config directory on the Abiquo Server

      abiquo.mail.path=/opt/abiquo/config/mail
    2. If required, set the character set for your language

      abiquo.mail.charset=UTF-8

Customize email templates

Each email has a default HTML template and a variable file.

To overwrite these files, create your own files in the email template path (as set in abiquo.properties)

  1. Check the default files for a guide to email content
  2. Add custom variables as described below
  3. Save your files with the same names as the default files but using the appropriate language codes for your user languages, as described below
  4. If you have changed a "subject" property, you will need to restart the Tomcat server for the changes to take effect

Default files

This section describes the default variable (.properties) and HTML template (.mustache) files

Reset password email

For details of password functionality, see Configure Passwords.

  • resetPassword_en_US.properties

    resetPassword_en_US.properties
    subject=Reset Your Abiquo Password
  • resetPasswordTemplate_en_US.mustache

     Click here to expand...
    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>

    Note that in the template properties, you cannot set the username and link. Any values you set here will be overwritten by the platform.

Two factor authentication email

For full details of how to configure 2fa, see Configure two factor authentication

  • 2faEmail_en_US.properties

    subject=Abiquo two factor authentication code
  • 2FAEmailTemplate_en_US.mustache

     Click here to expand...
    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>

    Note that in the template properties, you cannot set the usernamecode and expiration. Any values you set here will be overwritten by the platform.

Guest password email

For full details of how to configure guest passwords, see the Guest setup page.

  • guestPassword_en_US.properties

    subject=New Virtual machine {0}
  • guestPasswordTemplate_en_US.mustache

     Click here to expand...
    guestPasswordTemplate_en_US.mustache
    <p>Hi {{username}},</p>
    <p>Your new virtual machine is up and running. You can access it using the following credentials:</p>
    <p>
    Virtual machine: {{vmname}}<br/>
    FQDN: {{fqdn}}<br/>
    Username: {{loginuser}}<br/>
    Password: {{loginpassword}}
    </p>
    <p>The Abiquo Team</p>

    Note that in the template properties, you can only set the subject. If the fully qualified domain name is not set in the VM, the value of the FQDN variable will be "undefined".

Guest password SMS email

For full details of how to configure guest passwords, see the Guest setup page.

  • guestPasswordSMS_en_US.properties
    -- By default, this file is empty -- 

  • guestPasswordSMSTemplate_en_US.mustache

     Click here to expand...
    guestPasswordSMSTemplate_en_US.mustache
    Virtual machine:
    {{vmname}}
    Password:
    {{loginpassword}} 
    

    You can add the following additional variables:

    Login user:
    {{loginuser}}
    Fully qualified domain name:
    {{fqdn}}
    User that created the VM:
    {{username}}

Monitoring alert email

For full details of how to configure Monitoring, see Configure VM Monitoring and Metrics

  • monitoringAlert_en_US.properties
    The variable "{1}" represents the state of the alarm "activated" or "deactivated" 

    subject=Alert {0} has been {1}
    portalname=Abiquo console
    portaladdress={0}
  • monitoringAlertTemplate.mustache

    Here you can only set the subjectstate,  portalname and portaladdress.

    <p>You are receiving this email because the alert <strong>{{name}}</strong> in virtual appliance <em>{{virtualappliance}}</em> has been <strong>{{state}}</strong>.</p>
    <h4>Alert description</h4>
    <p>{{description}}</p>
    <h4>Notified alarms</h4>
    <ul>
    {{#alarms}}
    <li><em>{{alarmName}}</em>: {{alarmDescription}} - <em>virtualmachine<em>: {{vmLabel}}/{{vmName}}</li>
    {{/alarms}}
    </ul>
    <p>For further details, go to the {{{portalname}}} at: {{{portaladdress}}}</p>

Add a custom variable

As an example of a custom variable, you could add the following message within the body.

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

Then you could add this variable to the properties file.

 

helpline=555 12345

To return unescaped HTML as part of a template property, use the triple mustache, which is "{{{" and "}}}". Mustache escapes HTML variables in double mustaches by default.

Customize email language

When you create a user, the platform assigns the language of the UI as the user's language. 

To send an email, the platform

  • Searches for an email text in the user's language by filename, with the same naming conventions as the other language files. 
    • For example, for "Spanish - Spain" with language code "es_ES", the UI would look for "resetPassword_es_ES.properties" 
  • If the platform does not find a text in the user's language, it uses the default US English files. See Abiquo UI Client Language Configuration