Summary

Email Templates allow you to configure commonly used emails with bookmarks so you can send standard emails from within your solution.

Navigate to System Setup → Company → System Email Templates:

AppBase has two built-in system email templates:   

  • ResetPassword
  • InitiateChangeLogin

There is no option to create system email templates on the UI. They are created once when creating a tenant. But some system email template fields can be modified in UI(click Edit action). Edit Email Template page allows to modify following fields:

  • Sender
  • Subject
  • Body
  • Description

By default, system email template fields appear blank. If the fields have not been changed and remain empty, they always take their default values. Usually the default values are loaded from the configuration and may differ between templates. The default fields values for different templates and the custom values they can accept will be described below.

ResetPassword

This template is used to send an email with a password reset link. It is possible to initiate sending a letter using Reset Password button on the User Detail page or Forgot Password link on Login page.

Edit Email Template


Due to current implementation ResetPassword email template field always have default values loaded from configuration regardless of whether they have been changed on UI or not. Default field values are described in the table below:

Field NameDefault valueHow to change value
Sender<NoReplyEmail> placeholder value in the configurationCannot be changed in UI. If you need to change this value, change the value of the placeholder <NoReplyEmail> located in configuration file, make reconfiguration and restart AppBase.
Subject"AppBase password"Cannot be changed and always has default configured value. 
BodyLoaded from a static file RepairPasswordEmailPattern.txt. 
Hi, {0}!
Follow the link below to set your new password {1}
AppBase Team

 where {0} is First Name, {1} is reset password link.		Cannot be changed in UI. If you need to change this value, change the RepairPasswordEmailPattern.txt static file content with following location:
<AppBase instalation directory>/Applications/Templates/AutoProvisioning/RepairPasswordEmailPattern.txt.
 


InitiateChangeLogin

This template is used to send an invitation email to the user after click Invite User on User Detail page.

Edit Email Template

InitiateChangeLogin email template field have default values loaded from configuration which can be changed to custom values. See more details in the table below:

Field NameDefault ValueHow to change value
Sender

<NoReplyEmail> placeholder value in the configuration

Cannot be changed in UI. If you need to change this value, change the value of the placeholder <NoReplyEmail> located in in configuration file, make reconfiguration and restart AppBase.
warning Please do not change the value of this field on the UI. This can lead to problems with sending invitation emails. If you need to change this value, change the placeholder value as described above.
Subject"Membership type change has been initiated"Can be changed in UI to any plain text.
BodyLoaded from a static file InitiateChangeUserTypeEmailPatternFile.txt:
<p>Dear @@FIRSTNAME@@ @@LASTNAME@@</p><br />
Request to change your current login '@@LOGIN@@' has been initiated.<br />
<p>If you want to continue please follow invitation url: @@INVITATION_URL@@</p><br />
You might need this invitation code to confirm your request: @@INVITATIONCODE@@<br />
<p>This request will expire: @@EXPIRATIONDATE@@</p><br />
<p>AppBase Team</p>


More information about placeholders see below

Cannot be changed in UI. If you need to change this value, change the RepairPasswordEmailPattern.txt static file content with following location:
<AppBase instalation directory>/Applications/Templates/InitiateChangeUserTypeEmailPatternFile.txt.

The email template body can contain both plain text and HTML-markup with placeholders (in the format @@PLACEHOLDERNAME@@).  The placeholders values are specific for each user.
 
More information about placeholders see below


Email template body text contains following placeholders:

NameDescriptionExample
@@FIRSTNAME@@

It equals to user's first name and is specific for each user.

Nina
@@LASTNAME@@

It equals to user's last name and is specific for each user.

Nazarova
@@LOGIN@@

It equals to user's login and is specific for each user.

nnazarova
@@INVITATIONCODE@@
f82b4275c756403693d61941e99c11f3
@@INVITATION_URL@@Invitation url depends on auth configuration type. Exists for SAML and OAuth, for other types is emptyFor SAML:  https://gateway-denys.eccentex.com/ecx.web/account/sso?tenantCode=60&authCode=604a06ac-243a-411d-a4b4-e74fb8399b4c
 
For OAuth:  https://gateway-denys.eccentex.com/ecx.web/account/oauth?tenantCode=tenant1&authcode=cf877839-77fe-4595-bdf0-582852b8b3cc
 
@@SITEROOT@@Due to current implementation always is empty
@@EXPIRATIONDATE@@Invitation expiration date. Due to current implementation always is empty


Examples

Template BodyReceived Email View
<p>Dear @@FIRSTNAME@@ @@LASTNAME@@</p><br />
Request to change your current login '@@LOGIN@@' has been initiated.<br />
<p>If you want to continue please follow invitation url: @@INVITATION_URL@@</p><br />
You might need this invitation code to confirm your request: @@INVITATIONCODE@@<br />
<p>This request will expire: @@EXPIRATIONDATE@@</p><br />
<p>AppBase Team</p>


  • No labels