Skip to content

Commit 13b6fb2

Browse files
authored
Merge pull request #3688 from replicatedhq/improve-email-template-variables-docs
Improve email template variables documentation
2 parents cf9db4f + f3cd569 commit 13b6fb2

File tree

1 file changed

+52
-5
lines changed

1 file changed

+52
-5
lines changed

docs/vendor/enterprise-portal-configure.mdx

Lines changed: 52 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,9 @@ To manage Enterprise Portal settings:
6161

6262
1. Click **Save**.
6363

64-
## Configure Invitation and Notification Emails {#configure-customer-emails}
64+
## Customize Customer Emails {#configure-customer-emails}
6565

66-
You can customize the the content and styling of the invitation and notification emails that are sent to your customers.
66+
### Configure Email Sender
6767

6868
To configure customer emails:
6969

@@ -76,11 +76,58 @@ To configure customer emails:
7676
1. For **Email Sender Verification**, in **From email address**, add the email address that you want to use as the sender for all system notifications sent to your customers, then click **Continue**. Adding a sender address helps ensure that your emails are delivered and are not marked as spam.
7777

7878
After the domain is verified automatically, the email address is displayed under **Verified Sender Address**.
79-
1. For **Customer Emails**, customize the subject line and body of the emails that are sent to your customers for various system events. You can also customize the default style component to change things like color and font. Click **Preview** to see a preview of your changes.
8079

81-
![Enterprise Portal edit emails pane](/images/enterprise-portal-customer-emails-edit.png)
80+
### Customize Email Templates
8281

83-
[View a larger version of this image](/images/enterprise-portal-customer-emails-edit.png)
82+
You can customize the subject line, content, and styling of the emails that are sent to your customers.
83+
84+
To customize email templates:
85+
86+
1. In the Vendor Portal, go to **Enterprise Portal > Customer Emails**.
87+
88+
![Enterprise Portal customer emails page](/images/enterprise-portal-customer-emails.png)
89+
90+
[View a larger version of this image](/images/enterprise-portal-customer-emails.png)
91+
92+
1. For **Customer Emails**, first select the email category (such as **Access & Authentication** or **Update Notifications**). Then, select the name of the email template that you want to customize.
93+
94+
The template editor opens.
95+
96+
The following shows an example of the editor for the **Temporary Login Link** email template:
97+
98+
![Enterprise Portal edit emails pane](/images/enterprise-portal-customer-emails-edit.png)
99+
100+
[View a larger version of this image](/images/enterprise-portal-customer-emails-edit.png)
101+
102+
1. In the editor, modify the subject line and body as desired. Note the following options:
103+
104+
* You can customize the default style component to change things like color and font.
105+
106+
* You can use template variables to insert dynamic content in the subject or body. For example, `Welcome to {{app_name}}!` or `Click here to join {{team_name}}: {{invite_url}}`. Template variables are automatically populated with relevant data when emails are sent.
107+
108+
:::note
109+
The specific template variables that are available for use depend on the type of email template that you are editing. You can see all available variables in the **Available Variables** section of the editor. For a list of the common template variables that are available across multiple email templates, see [Common Template Variables](#common-template-variables) below.
110+
:::
111+
112+
1. Click the **Preview** tab to see how your email will look with sample data.
113+
114+
1. Click **Save changes** when finished.
115+
116+
### Common Template Variables
117+
118+
The following template variables are available across multiple email types:
119+
120+
| Variable | Description | Example Output |
121+
|----------|-------------|----------------|
122+
| `{{app_name}}` | Your application name | "Acme Application" |
123+
| `{{team_name}}` | Customer team name | "Acme Corp" |
124+
| `{{customer_name}}` | Customer organization name | "Acme Corporation" |
125+
| `{{login_url}}` | Link to login page | https://portal.example.com/acme/login |
126+
| `{{invite_url}}` | Link to accept invitation | https://portal.example.com/acme/invite#token |
127+
| `{{verification_code}}` | Temporary verification code | "ABC123" |
128+
| `{{version_label}}` | Software version number | "1.2.3" |
129+
| `{{release_notes}}` | Release notes content | "New features and bug fixes" |
130+
| `{{update_url}}` | Link to update/release page | https://portal.example.com/acme/releases |
84131

85132
## Add a Link to Documentation
86133

0 commit comments

Comments
 (0)