gitlab-org--gitlab-foss/doc/tools/email.md

2.5 KiB

stage group info type
none unassigned To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments howto, reference

Email from GitLab (PREMIUM SELF)

GitLab provides a tool to administrators for emailing all users, or users of a chosen group or project, right from the Admin Area. Users receive the email at their primary email address.

For information about email notifications originating from GitLab, read GitLab notification emails.

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 downtime is expected for a particular reason.

Sending emails to users from within GitLab

  1. On the top bar, select Menu > Admin.

  2. In the left sidebar, select Overview > Users.

  3. Select Send email to users.

    admin users

  4. Compose an email and choose where to send it (all users or users of a chosen group or project). The email body only supports plain text messages. HTML, Markdown, and other rich text formats are not supported, and is sent as plain text to users.

    compose an email

NOTE: Starting with GitLab 13.0, email notifications can be sent only once every 10 minutes. This helps minimize performance issues.

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 receive an email notification that unsubscribe happened. The endpoint that provides the unsubscribe option is rate-limited.