diff options
author | Marcel Amirault <ravlen@gmail.com> | 2019-05-05 15:59:22 +0000 |
---|---|---|
committer | Achilleas Pipinellis <axil@gitlab.com> | 2019-05-05 15:59:22 +0000 |
commit | b05936cbfa6c72e158f976e3aa88c83a038f0cfa (patch) | |
tree | 44bfbc23b34f5e8f842e1f7fce4d0bb8b0d511cd /doc/tools/email.md | |
parent | 2229b189389b0d1b9e407ea1fc8648026f432cd4 (diff) | |
download | gitlab-ce-b05936cbfa6c72e158f976e3aa88c83a038f0cfa.tar.gz |
Docs: Merge Various EE /doc dirs to CE
Diffstat (limited to 'doc/tools/email.md')
-rw-r--r-- | doc/tools/email.md | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/doc/tools/email.md b/doc/tools/email.md new file mode 100644 index 00000000000..ab39206ffa4 --- /dev/null +++ b/doc/tools/email.md @@ -0,0 +1,38 @@ +# Email from GitLab **[STARTER ONLY]** + +As a GitLab administrator you can email GitLab users from within GitLab. + +## Overview + +GitLab provides a simple tool to email all users or users of a chosen group or +project right from the admin area. Users will receive the email to 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 + +User can choose to unsubscribe from receiving emails from GitLab by following +the unsubscribe link from the email. Unsubscribing is unauthenticated in order +to keep the simplicity of this feature. + +On unsubscribe, user will receive an email notifying that unsubscribe happened. +The endpoint that provides the unsubscribe option is rate-limited. + +[ee]: https://about.gitlab.com/pricing/ |