debian-mirror-gitlab/doc/user/admin_area/settings/email.md
2023-06-20 00:43:36 +05:30

5.2 KiB

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

Email (FREE SELF)

You can customize some of the content in emails sent from your GitLab instance.

The logo in the header of some emails can be customized, see the logo customization section.

Include author name in email notification email body (PREMIUM SELF)

By default, GitLab overrides the email address in notification emails with the email address of the issue, merge request, or comment author. Enable this setting to include the author's email address in the body of the email instead.

To include the author's email address in the email body:

  1. On the top bar, select Main menu > Admin.
  2. On the left sidebar, select Settings > Preferences (/admin/application_settings/preferences).
  3. Expand Email.
  4. Select the Include author name in email notification email body checkbox.
  5. Select Save changes.

Enable multipart email (PREMIUM SELF)

GitLab can send email in multipart format (HTML and plain text) or plain text only.

To enable multipart email:

  1. On the top bar, select Main menu > Admin.
  2. On the left sidebar, select Settings > Preferences (/admin/application_settings/preferences).
  3. Expand Email.
  4. Select Enable multipart email.
  5. Select Save changes.

Custom hostname for private commit emails (PREMIUM SELF)

Introduced in GitLab 11.5.

This configuration option sets the email hostname for private commit emails. By default it is set to users.noreply.YOUR_CONFIGURED_HOSTNAME.

To change the hostname used in private commit emails:

  1. On the top bar, select Main menu > Admin.
  2. On the left sidebar, select Settings > Preferences (/admin/application_settings/preferences).
  3. Expand Email.
  4. Enter the desired hostname in the Custom hostname (for private commit emails) field.
  5. Select Save changes.

NOTE: After the hostname is configured, every private commit email using the previous hostname is not recognized by GitLab. This can directly conflict with certain Push rules such as Check whether author is a GitLab user and Check whether committer is the current authenticated user.

Custom additional text (PREMIUM SELF)

You can add additional text at the bottom of any email that GitLab sends. This additional text can be used for legal, auditing, or compliance reasons, for example.

To add additional text to emails:

  1. On the top bar, select Main menu > Admin.
  2. On the left sidebar, select Settings > Preferences (/admin/application_settings/preferences).
  3. Expand Email.
  4. Enter your text in the Additional text field.
  5. Select Save changes.

User deactivation emails

GitLab sends email notifications to users when their account has been deactivated.

To disable these notifications:

  1. On the top bar, select Main menu > Admin.
  2. On the left sidebar, select Settings > Preferences (/admin/application_settings/preferences).
  3. Expand Email.
  4. Clear the Enable user deactivation emails checkbox.
  5. Select Save changes.

Custom additional text in deactivation emails (FREE SELF)

FLAG: On self-managed GitLab, by default this feature is available. To hide the feature, ask an administrator to disable the feature flag named deactivation_email_additional_text.

You can add additional text at the bottom of the email that GitLab sends to users when their account is deactivated. This email text is separate from the custom additional text setting.

To add additional text to deactivation emails:

  1. On the top bar, select Main menu > Admin.
  2. On the left sidebar, select Settings > Preferences (/admin/application_settings/preferences).
  3. Expand Email.
  4. Enter your text in the Additional text for deactivation email field.
  5. Select Save changes.