{"type":"doc","content":[{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"This page describes how to customize the emails that the platform will send to users with security codes for two-factor authentication ","type":"text"}]}]},{"type":"panel","attrs":{"panelType":"success"},"content":[{"type":"paragraph","content":[{"text":"Abiquo will customize emails using template and properties files with the following priority:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Localized files, with a language code extension, such as ","type":"text"},{"text":"2FAEmailTemplate_en_US.mustache","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"2fAEmail_en_US.properties","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Files with no language code extension, such as ","type":"text"},{"text":"2FAEmailTemplate.mustache","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"2fAEmail.properties","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"System defaults, with content as shown in the examples below","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"To customize the email to send a verification code for two-factor authentication: ","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Log in to the Abiquo API Server as an administrator","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"In the config folder, if there is no mail folder, create a ","type":"text"},{"text":"mail","type":"text","marks":[{"type":"strong"}]},{"text":" folder and set the owner as the tomcat user","type":"text"}]},{"type":"codeBlock","content":[{"text":"/opt/abiquo/config/mail","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"In the mail folder, In the ","type":"text"},{"text":"mail","type":"text","marks":[{"type":"code"}]},{"text":" folder, create the custom files as required. You can create localized files and main files. ","type":"text"},{"type":"hardBreak"},{"text":"The content of the default files is shown here. ","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Email file:","type":"text"}]},{"type":"paragraph","content":[{"text":"for example, as a localized file for US English, ","type":"text"},{"text":"2FAEmailTemplate_en_US.mustache","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"

Hi {{username}},

You can use the following verification code to complete the authentication process:

{{code}}

The code will be valid until: {{expiration}}

If you did not request the verification code, please ignore this email.

Thank you,

The Abiquo Team

","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Properties file:","type":"text"},{"type":"hardBreak"},{"text":"for example, as a localized file for US English, ","type":"text"},{"text":"2faEmail_en_US.properties","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"subject=Abiquo two factor authentication code","type":"text"}]},{"type":"paragraph","content":[{"type":"emoji","attrs":{"id":"atlassian-warning","text":":warning:","shortName":":warning:"}},{"text":" If you change the ","type":"text"},{"text":"subject","type":"text","marks":[{"type":"code"}]},{"text":" property, you must restart the Tomcat server to apply your changes","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"You cannot set the ","type":"text"},{"text":"username","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"code","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text","marks":[{"type":"em"}]},{"text":"or","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":" ","type":"text"},{"text":"expiration","type":"text","marks":[{"type":"code"}]},{"text":". If you set these values, the platform will overwrite them","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Optionally, add custom variables and content","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"In the email body, to add a custom variable, use double curly braces (also called double mustaches), which is ","type":"text"},{"text":"{{","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"}}","type":"text","marks":[{"type":"code"}]},{"text":". For example,","type":"text"}]},{"type":"codeBlock","content":[{"text":"

Please call your system Administrator on {{helpline}}

","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Then in your properties file, set value for your custom variable","type":"text"}]},{"type":"codeBlock","content":[{"text":"helpline=555 12345","type":"text"}]},{"type":"paragraph","content":[{"type":"emoji","attrs":{"id":"atlassian-check_mark","text":":check_mark:","shortName":":check_mark:"}},{"text":" To return unescaped HTML as part of a template property, use the triple mustache, which is ","type":"text"},{"text":"{{{","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"}}}","type":"text","marks":[{"type":"code"}]},{"text":". ","type":"text"},{"type":"hardBreak"},{"text":"The Mustache templating software that adds the property values will escape HTML variables in double mustaches by default.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If your users have a language other than English, rename the file to change the ","type":"text"},{"text":"language code to the user language","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"For example, for ","type":"text"},{"text":"Spanish - Spain","type":"text","marks":[{"type":"code"}]},{"text":" change ","type":"text"},{"text":"en_US","type":"text","marks":[{"type":"code"}]},{"text":" to ","type":"text"},{"text":"es_ES","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The user language is the UI language when you create the user","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Change the owner of the files to the ","type":"text"},{"text":"tomcat","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"strong"}]},{"text":"user","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If you changed the subject property, restart the Tomcat server ","type":"text"}]}]}]}]}]}],"version":1}

Browser not supported