You are browsing documentation for an older version. See the latest documentation here.

Customizing Portal Emails

You can manage the message and appearance of emails being sent by the Kong Developer Portal. Editable email templates are loaded as files similar to content files for portal rendering. Email files can be managed in the same way as other files for rendering, via editor or via the Portal CLI Tool. This feature is not supported on legacy portal mode.

If no email templates are loaded, Kong will fall back to the same emails as Kong Gateway 1.3.0.0. Enabling a non-legacy portal on new workspaces loads default editable email templates. For existing non-legacy Portals, editable email templates must be loaded manually.

Email-specific values are templated in tokens that work similarly to templating in portal layouts and partials. Not all tokens are supported on all emails.

Prerequisites

The Kong Developer Portal is not running in Legacy Mode
The Kong Developer Portal is enabled and running
The emails you want are enabled in kong
If using CLI tool, kong-portal-cli tool 1.1 or later is installed locally and git installed

Understanding Email Files

Portal templates use a combination of HTML, markdown, and tokens.

The follow example is the emails/approved-access.txt template:

---
layout: emails/email_base.html

subject: Developer Portal access approved {{portal.url}}
heading: Hello {{email.developer_name}}!
---
You have been approved to access {{portal.url}}.
<br>
Please visit <a href="{{portal.url}}/login">{{portal.url}}/login</a> to login.

Like other content files, these files have a headmatter between the two --- . The layout is set by layout attribute, this is the layout file this email will render with.

subject sets the subject line for email.
heading is an optional value that by default is rendered as a h3

The body of the email is HTML content. You can reference the tokens allowed for the email in the table below. In this case, {{portal.url}} is used to access the portal url

Supported Emails and Tokens

Path	Supported Tokens	Required Tokens	Description
`emails/invite.txt`	`{{portal.gui_url}}` `{{email.developer_email}}`	`{{portal.gui_url}}`	email sent to developer who is invited to a portal from the manager
`emails/request-access.txt`	`{{portal.gui_url}}` `{{email.developer_email}}` `{{email.developer_name}}` `{{email.developer_meta.*}}` `{{email.admin_url}}`	`{{portal.gui_url}}` `{{email.developer_email}}`	email sent to admin when a developer signs up for portal, in order to approve the developer
`emails/approved-access.txt`	`{{portal.url}}` `{{email.developer_email}}` `{{email.developer_name}}` `{{email.developer_meta.*}}`	`{{portal.gui_url}}`	email sent to developer when their account is approved
`emails/password-reset.txt`	`{{portal.url}}` `{{email.developer_email}}` `{{email.developer_name}}` `{{email.developer_meta.*}}` `{{email.token}}` `{{email.token_exp}}` `{{email.reset_url}}`	`{{portal.url}}` `{{email.token}}` or `{{email.reset_url}}`	email sent to developer when a password reset is requested (basic-auth only)
`emails/password-reset-success.txt`	`{{portal.url}}` `{{email.developer_email}}` `{{email.developer_name}}` `{{email.developer_meta.*}}`	`{{portal.url}}`	email sent to developer when a password reset is successful (basic-auth only)
emails/account-verification.txt	`{{portal.url}}` `{{email.developer_email}}` `{{email.developer_name}}` `{{email.developer_meta.*}}` `{{email.token}}` `{{email.verify_url}}` `{{email.invalidate_url}}`	`{{portal.url}}` `{{email.token}}` or both `{{email.verify_url}}` and `{{email.invalidate_url}}`	email sent to developer when `portal_email_verification` is on to verify developer email (basic-auth only)
`emails/account-verification-approved.txt`	`{{portal.url}}` `{{email.developer_email}}` `{{email.developer_name}}` `{{email.developer_meta.*}}`	`{{portal.url}}`	email sent to developer when `portal_email_verification` is on and developer has verified email and developer has been approved by admin/auto-approve is on (basic-auth only)
`emails/account-verification-pending.txt`	`{{portal.url}}` `{{email.developer_email}}` `{{email.developer_name}}` `{{email.developer_meta.*}}`	`{{portal.url}}`	email sent to developer when `portal_email_verification` is on and developer has verified email and developer has yet to be approved by admin (basic-auth only)

Token Descriptions

Token	Description
`{{portal.url}}`	Dev Portal URL for the workspace
`{{email.developer_email}}`	Developer’s email
`{{email.developer_name}}`	Developer’s full name, this value is collected as part of registration by default. If meta-fields are edited to not include full_name then this will fallback to email
`{{email.developer_meta.*}}`	Developer’s meta-fields, these value are collected as part of registration. They must be configured prior to registration. If the value doesn’t exist or is optional and blank, it will display as an empty string. If the `developer_meta` configuration doesn’t specify the field, it will appear as-is without replacement, e.g. `{{email.developer_meta.preferred_name}}`
`{{email.admin_url}}`	Kong Manager URL
`{{email.reset_url}}`	Dev Portal full URL for resetting password (assumes default path for password reset)
`{{email.token_exp}}`	Human readable string for amount of time from sending of email, password reset token/url is valid.
`{{email.verify_url}}`	Link to verify account (assumes default path for account verification))
`{{email.invalidate_url}}`	Link to invalidate account verification request (assumes default path for account verification))
`{{email.token}}`	Can be used in combination with `{{portal.url}}` to manually build url string for password reset and account verification/invalidation. Not recommended for use, unless custom path for password reset or account verification has been set.

Editing Email Templates

The default email templates will be automatically loaded into the Kong Developer Portal’s file system when the Dev Portal is activated. These templates can now be edited in Kong Manager via the Portal Editor or via the Portal CLI tool.

Editing via the Portal Editor

Email templates can now be edited in the Portal Editor along with the rest of the files in the Kong Developer Portal file system. To view and edit these files:

Log into Kong Manager and navigate to the Workspace whose Dev Portal you wish to edit.
Select the Editor from the sidebar under Dev Portal.

The email templates can be found under the Emails section in the Portal Editor sidebar.

Editing via the Portal CLI Tool

Clone [https://github.com/Kong/kong-portal-templates] master branch, and navigate into its directory.
If you have any customizations or permissions changes that you want to keep: Run portal fetch <workspacename> This will pull in your modifications locally.
After making any changes, portal deploy <workspacename> to deploy all files.

Editing Email Appearance

To edit the appearance of emails, you can change the layout file emails use. By default, emails are set to use the layout emails/email_base.html. If this file does not exist inside your theme (default theme is base), then a hardcoded fallback will be used.

You can edit the layout this layout file via the Portal Editor or locally with the Portal CLI tool. Follow the instructions for the editing email text, but modifying the layout file instead.

If you want different emails to have a different appearance, you can set different layout files for each email file.

The default email layout looks like:

<!DOCTYPE html>
<html>
  <head>
  </head>
  <body>
    <img
      src="{{portal.url}}/{{theme.images.logo}}"
      alt="{{portal.name}}"
      style="max-height: 32px; max-width: 200px;">
    <h3>{{page.heading}}</h3>
    <p>
      {*page.body*}
    </p>
  </body>
</html>

The img tag loads the logo that can be set in the appearance tab in the manager. If you do not want to display a logo, remove the <img> tag. If you want to set different sizing for your logo, you can change the inline style attribute.

The logo will not render for many email clients that pre-fetch images if portal is not set to be accessible from a public url (for example if you are testing the Portal with a localhost).

By modifying the HTML of this file, you can change the appearance of your emails. For example if you wanted to add a footer that would show on all emails, add it under the <p> tag

Be sure to keep in mind the HTML support limitations of the email clients you plan to support.

Loading Email Templates on Existing Dev Portals

Editable email templates can be loaded either via the editor or via the kong-portal-cli tool.

Load Email Templates via the Portal Editor

Log into Kong Manager and navigate to the workspace you want to edit. Click on Editor in the sidebar.
Click New File+.
Select Content type email.
Type in one of the supported paths from above.
Click Create File to generate a default email template that is valid for that email.
Do this for emails you want to edit.

Note: By default, these emails you create will have layout key set: layout: emails/email_base.html. If you don’t create this layout file, all emails fallback to a default layout. You will want to create this layout if you want to customize the Appearance of emails in addition to message.

To create an email layout:

Click New File+.
Select Content type theme.
Type in the path for the layout, themes/<THEME_NAME>/layouts/email_base.html. The default theme name is base. The layout that loads in the new portals in 1.3.0.1 is the following (this adds the logo image that can be set in the appearance tab in the manager):

<!DOCTYPE html>
<html>
  <head>
  </head>
  <body>
    <img
      src="{{portal.url}}/{{theme.images.logo}}"
      alt="{{portal.name}}"
      style="max-height: 32px; max-width: 200px;">
    <h3>{{page.heading}}</h3>
    <p>
      {*page.body*}
    </p>
  </body>
</html>

Find out more about customizing the email layout in the section below.

Load Email Templates via the Portal CLI Tool

Clone the portal templates master branch and navigate into the folder you cloned.
If you have any customizations or permissions changes that you want to keep:
1. Run portal fetch <workspacename>. This pulls in your modifications locally.
2. Merge in the portal templates master branch to apply changes for 1.3.0.1, including emails.
Run portal deploy <workspacename>. This deploys all files.