73c6477b7e
Previously, we used brackets to denote the tier badges, but this made Kramdown, the docs site Markdown renderer, show many warnings when building the site. This is now fixed by using parentheses instead of square brackets. This was caused by [PREMIUM] looking like a link to Kramdown, which couldn't find a URL there. See: - https://gitlab.com/gitlab-com/gitlab-docs/merge_requests/484 - https://gitlab.com/gitlab-org/gitlab-ce/issues/63800
48 lines
1.8 KiB
Markdown
48 lines
1.8 KiB
Markdown
---
|
|
type: howto, reference
|
|
---
|
|
|
|
# Email from GitLab **(STARTER ONLY)**
|
|
|
|
GitLab provides a simple tool to administrators for emailing all users, or users of
|
|
a chosen group or project, right from the admin area. Users will receive the email
|
|
at their primary email address.
|
|
|
|
## Use-cases
|
|
|
|
- Notify your users about a new project, a new feature, or a new product launch.
|
|
- Notify your users about a new deployment, or that will be downtime expected
|
|
for a particular reason.
|
|
|
|
## Sending emails to users from within GitLab
|
|
|
|
1. Go to the admin area using the wrench icon in the top right corner and
|
|
navigate to **Overview > Users > Send email to users**.
|
|
|
|
![admin users](email1.png)
|
|
|
|
1. Compose an email and choose where it will be sent (all users or users of a
|
|
chosen group or project):
|
|
|
|
![compose an email](email2.png)
|
|
|
|
## Unsubscribing from emails
|
|
|
|
Users can choose to unsubscribe from receiving emails from GitLab by following
|
|
the unsubscribe link in the email. Unsubscribing is unauthenticated in order
|
|
to keep this feature simple.
|
|
|
|
On unsubscribe, users will receive an email notification that unsubscribe happened.
|
|
The endpoint that provides the unsubscribe option is rate-limited.
|
|
|
|
<!-- ## Troubleshooting
|
|
|
|
Include any troubleshooting steps that you can foresee. If you know beforehand what issues
|
|
one might have when setting this up, or when something is changed, or on upgrading, it's
|
|
important to describe those, too. Think of things that may go wrong and include them here.
|
|
This is important to minimize requests for support, and to avoid doc comments with
|
|
questions that you know someone might ask.
|
|
|
|
Each scenario can be a third-level heading, e.g. `### Getting error message X`.
|
|
If you have none to add when creating a doc, leave this section in place
|
|
but commented out to help encourage others to add to it in the future. -->
|