Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCU-2360] Portal email recipients and developer metadata #3999

Merged
merged 5 commits into from
Jun 7, 2022
Merged

[DOCU-2360] Portal email recipients and developer metadata #3999

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
182c095
feat(docs) update changelog
Mierenga Jun 7, 2022
ee9450c
feat(config) update gateway config params
Mierenga Jun 7, 2022
ca74bb6
feat(emails) update email templates with developer_meta fields
Mierenga Jun 7, 2022
9ee735c
fix typo
lena-larionova Jun 7, 2022
cacc16f
use jekyll raw tags to ignore curly braces
lena-larionova Jun 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 11 additions & 10 deletions app/gateway/2.8.x/developer-portal/theme-customization/emails.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,13 +57,13 @@ The body of the email is HTML content. You can reference the tokens allowed for
|--- |--- |--- |--- |
|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.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}}` |`{{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.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}}` |`{{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.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}}` |`{{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}}` |`{{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) |
|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) |
{% endraw %}

## Token Descriptions
Expand All @@ -73,9 +73,10 @@ The body of the email is HTML content. You can reference the tokens allowed for
|--- |--- |
|`{{portal.url}}` |Dev Portal URL for the workspace |
|--- |--- |
|`{{email.developer_email}}` |Developers email |
|`{{email.developer_name}}` |Developers 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.admin_url}}` |Kong Manger URL |
|`{{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)) |
Expand Down
13 changes: 13 additions & 0 deletions app/gateway/2.8.x/reference/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3298,6 +3298,19 @@ associated with the account.

---

#### portal_smtp_admin_emails
{:.badge .enterprise}

Comma separated list of admin emails to receive portal-related notifications.

If none are set, the values in `smtp_admin_emails` will be used.

Example `[email protected], [email protected]`

**Default:** none

---


### Admin Smtp Configuration section

Expand Down
2 changes: 2 additions & 0 deletions app/gateway/changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ no_version: true
for the Developer Portal using the following configuration parameters:
* [`portal_application_status_email`](/gateway/latest/reference/configuration/#portal_application_status_email): Enable to send application request status update emails to developers.
* [`portal_application_request_email`](/gateway/latest/reference/configuration/#portal_application_request_email): Enable to send service access request emails to users specified in `smtp_admin_emails`.
* [`portal_smtp_admin_emails`](/gateway/latest/reference/configuration/#portal_smtp_admin_emails): Specify the email addresses to send portal admin emails to, overriding values set in `smtp_admin_emails`.
* Added the ability to use `email.developer_meta` fields in portal email templates. For example, `{% raw %}{{email.developer_meta.preferred_name}}{% endraw %}`.

#### Plugins

Expand Down