Versions Compared

Key

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

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

  1. Localized files, with a language code extension, such as guestPasswordSMSTemplate_en_US.mustache and guestPasswordSMS_en_US.properties

  2. Main files with no language code extension, such as guestPasswordSMSTemplate.mustache and guestPasswordSMS.properties

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

  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 files

    1. Email file

      guestPasswordSMSTemplate_en_US.mustache

      Code Block
      Virtual machine:
      Uuid: {{vmuuid}} Name: {{vmname}} ProviderId: {{vmproviderid}}
      Password:
      {{loginpassword}}
    2. The additional content that you can add for this SMS is as follows

      Code Block
      Login user:
      {{loginuser}}
      Fully qualified domain name:
      {{fqdn}}
      User that created the VM:
      {{username}}
    3. Properties file 

      guestPasswordSMS_en_US.properties

      Code Block
      -
      1. By default the properties file is empty for the guest password SMS message

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

  1. 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 en_US to es_ES

    2. The user language is the

...

    1. language of the locale of the user

  1. Change the owner of the files to the 

...

  1. tomcat user