Customizing Edge email templates

Edge automatically sends emails in response to certain events. For each of these events, the New Edge UI defines a default email template in /opt/apigee/edge-management-ui/email-templates. To customize these emails, you can edit the default templates.

The events where an email is sent, and the default template file for the generated email in /opt/apigee/edge-management-ui/email-templates, are:

  • New user is added: user-added-new.html
  • Existing user requests a password reset: password-reset.html
  • A user is added to an organization: user-added-existing.html

The "From" field of the email can be set by using the conf_apigee_apigee.mgmt.mailfrom property in /opt/apigee/customer/application/management-ui.properties (if that file does not exist, create it). For example:

conf_apigee_apigee.mgmt.mailfrom="My Company <myCo@company.com>"

The email subjects are customizable by editing the following properties in /opt/apigee/customer/application/management-ui.properties (if that file does not exist, create it):

  • conf_apigee_apigee.emails.passwordReset.subject
  • conf_apigee_apigee.emails.userAddedExisting.subject
  • conf_apigee_apigee.emails.userAddedNew.subject

Several email properties and templates reference the {companyNameShort} placeholder, which defaults to a value of Apigee. You can set the value of the placeholder by using the conf_uebe_branding_companyNameShort property in /opt/apigee/customer/application/management-ui.properties. For example:

conf_uebe_branding_companyNameShort="My Company"

After setting any properties in /opt/apigee/customer/application/management-ui.properties, ensure that the file is owned by apigee:apigee and restart the New Edge UI:

chown apigee:apigee /opt/apigee/customer/application/management-ui.properties
/opt/apigee/apigee-service/bin/apigee-service edge-management-ui restart