Skip to content

Commit c81a72a

Browse files
jc-clarkCopilotsabrowning1
authored
[EDI] Account and profile Managing email preferences (#57076)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Sam Browning <106113886+sabrowning1@users.noreply.github.com>
1 parent 1b716dd commit c81a72a

File tree

14 files changed

+205
-143
lines changed

14 files changed

+205
-143
lines changed
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
title: Email addresses
3+
intro: 'Learn about the different types of email addresses you can associate with your {% data variables.product.github %} account—primary, backup, commit, and noreply—and how each type is used for account management, security, and commit attribution.'
4+
versions:
5+
fpt: '*'
6+
ghes: '*'
7+
ghec: '*'
8+
topics:
9+
- Accounts
10+
- Fundamentals
11+
- Profile
12+
shortTitle: Email addresses
13+
---
14+
15+
## Adding an email address to your {% data variables.product.github %} account
16+
17+
{% data variables.product.github %} allows you to add as many email addresses to your account as you like. For more information, see [AUTOTITLE](/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account).
18+
19+
If you set an email address in your local Git configuration, you will need to add it to your account settings in order to connect your commits to your account. For more information about your email address and commits, see [Commit email addresses](#commit-email-addresses) below.
20+
21+
## Changing your primary email address
22+
23+
You can change the email address associated with your personal account at any time. You cannot change your primary email address to an email that is already set to be your backup email address. For more information, see [AUTOTITLE](/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/changing-your-primary-email-address).
24+
25+
## Email verification for personal accounts
26+
27+
You can verify your email address after signing up for a new account, or when you add a new email address. If an email address is undeliverable or bouncing, it will be unverified.
28+
29+
Having an unverified email address does not affect most actions you can take on {% data variables.product.prodname_dotcom %}. However, we **recommend email verification** to prevent potential exploitation of third-party {% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_oauth_apps %} which may not have followed our best practices around secure authentication methods for apps.
30+
31+
For more information, see [AUTOTITLE](/free-pro-team@latest/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/verifying-your-email-address).
32+
33+
## Email verification for {% data variables.enterprise.prodname_managed_users %}
34+
35+
For Enterprise Managed Users (EMUs), email addresses are no longer automatically verified. This prevents unauthorized access and potential data leaks from third-party {% data variables.product.prodname_github_apps %} and OAuth applications that rely on email addresses as a primary identifier.
36+
37+
Until you verify your email address, your account will use a placeholder email address with your enterprise's shortcode appended for certain operations. For example, the [AUTOTITLE](/rest/users/users) and [AUTOTITLE](/rest/users/emails) will return `email+shortcode@domain.com`. In rare cases, you may find that your company's email provider does not handle the placeholder email correctly, or that the placeholder prevents you from accessing some third-party {% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_oauth_apps %}.
38+
39+
Once you verify an email with a {% data variables.enterprise.prodname_managed_user %}, you won't be able to use the email to sign up for a personal account on {% data variables.product.prodname_dotcom_the_website %}.
40+
41+
>[!NOTE] If you need to use the same email address for both your {% data variables.enterprise.prodname_managed_user %} and another {% data variables.product.github %} account (for example, for innersource, open source, or other valid use cases), you must sign in to your managed user account and unverify the email in your account settings.
42+
>
43+
> The email will still be linked to your managed user account, so you can continue signing in through your organization's or enterprise's identity provider (IdP). However, because the email is unverified, it may affect your access to third-party applications that identify users based solely on email address.
44+
45+
## Commit email addresses
46+
47+
{% data variables.product.github %} uses your commit email address to associate commits with your account on {% data variables.product.github %}. You can choose the email address that will be associated with the commits you push from the command line as well as web-based Git operations you make.
48+
49+
For web-based Git operations, you can set your commit email address on {% data variables.product.github %}. For commits you push from the command line, you can set your commit email address in Git.
50+
51+
{% ifversion fpt or ghec %}Any commits you made prior to changing your commit email address are still associated with your previous email address.{% else %}After changing your commit email address on {% data variables.product.github %}, the new email address will be visible in all of your future web-based Git operations by default. Any commits you made prior to changing your commit email address are still associated with your previous email address.{% endif %}
52+
53+
{% ifversion fpt or ghec %}To use your `noreply` email address for commits you push from the command line, use that email address when you set your commit email address in Git. To use your `noreply` address for web-based Git operations, set your commit email address on GitHub and choose to **Keep my email address private**.
54+
55+
You can also choose to block commits you push from the command line that expose your personal email address. For more information, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/blocking-command-line-pushes-that-expose-your-personal-email-address).{% endif %}
56+
57+
To ensure that commits are attributed to you and appear in your contributions graph, use an email address that is connected to your account on {% data variables.product.github %}{% ifversion fpt or ghec %}, or the `noreply` email address provided to you in your email settings{% endif %}.
58+
59+
For more information, see [AUTOTITLE](/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address).
60+
61+
## Next steps
62+
63+
* For how-to procedures on managing your email preferences, see [AUTOTITLE](/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences).
64+
* For email address reference information, see [AUTOTITLE](/account-and-profile/reference/email-addresses-reference).

content/account-and-profile/concepts/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,6 @@ children:
1515
- /about-your-organizations-profile
1616
- /about-organization-membership
1717
- /changing-your-github-username
18+
- /email-addresses
1819
- /scheduled-reminders
1920
---
Lines changed: 5 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Adding an email address to your GitHub account
3-
intro: '{% data variables.product.github %} allows you to add as many email addresses to your account as you like. If you set an email address in your local Git configuration, you will need to add it to your account settings in order to connect your commits to your account. For more information about your email address and commits, see [Setting your commit email address](/articles/setting-your-commit-email-address/).'
3+
intro: 'You can add multiple email addresses to your {% data variables.product.github %} account to manage commits and notifications.'
44
redirect_from:
55
- /articles/adding-an-email-address-to-your-github-account
66
- /github/setting-up-and-managing-your-github-user-account/adding-an-email-address-to-your-github-account
@@ -16,10 +16,10 @@ topics:
1616
- Notifications
1717
shortTitle: Add an email address
1818
---
19-
{% ifversion fpt or ghec %}
19+
20+
{% ifversion ghec %}
2021

2122
> [!NOTE]
22-
> * {% data reusables.user-settings.no-verification-disposable-emails %}
2323
> * If you're a member of an {% data variables.enterprise.prodname_emu_enterprise %}, you cannot make changes to your email address on {% data variables.product.prodname_dotcom %}. {% data reusables.enterprise-accounts.emu-more-info-account %}
2424
2525
{% endif %}
@@ -31,29 +31,6 @@ shortTitle: Add an email address
3131

3232
![Screenshot of the "Email" settings page. Under "Primary email address," a dropdown menu, labeled with Octocat's email address, is outlined in orange.](/assets/images/help/settings/email-primary.png)
3333

34-
## Troubleshooting adding an email
35-
36-
If you see an error message when you try to add an email address to your account, you may be experiencing one of the following issues.
37-
38-
### Email already in use
39-
40-
If you see the error message `Error adding EMAIL: email is already in use`, it means the email address is already linked to another {% data variables.product.prodname_dotcom %} account. An email address can only be associated with one {% data variables.product.prodname_dotcom %} account at a time.
41-
42-
To use this email with a different account, follow these steps:
43-
44-
1. Sign in to the account currently linked to the email address and remove it from that account.
45-
1. If you don’t have access to the account, request a password reset email to recover it. See [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/updating-your-github-access-credentials).
46-
47-
### Email linked to a {% data variables.enterprise.prodname_managed_user %}
48-
49-
If the email address that you are trying to add is provided to you by your organization, you may see the `Error adding EMAIL: email is already in use` error when your organization has created a {% data variables.enterprise.prodname_managed_user %} for you in their {% data variables.enterprise.prodname_emu_enterprise %}.
50-
51-
Reach out to your site administrator or internal IT helpdesk to learn about their deployment of {% data variables.product.prodname_ghe_cloud %} and how to access the account. You may be able to sign into the {% data variables.product.prodname_ghe_cloud %} application via the organization's identity provider (IdP).
52-
53-
If you want to use your email address with a personal account, you must sign in to your {% data variables.enterprise.prodname_managed_user %} and unverify the email in your account settings. The email will remain linked to your {% data variables.enterprise.prodname_managed_user %}, allowing you to access the account through your organization's IdP.
54-
55-
However, some third-party apps or services may not function properly with a {% data variables.enterprise.prodname_managed_user %} that has an unverified email address.
56-
57-
## Further reading
34+
## Next steps
5835

59-
* [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences)
36+
If you are having trouble adding an email address, see [AUTOTITLE](/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/troubleshooting-adding-an-email).

content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/blocking-command-line-pushes-that-expose-your-personal-email-address.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,9 @@ topics:
1515
- Notifications
1616
shortTitle: Block push with personal email
1717
---
18-
When you push commits from the command line, the email address that you've [set in Git](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address) is associated with your commits. If you enable this setting, each time you push to GitHub, we’ll check the most recent commit. If the author email on that commit is a private email on your GitHub account, we will block the push and warn you about exposing your private email.
19-
20-
{% data reusables.user-settings.about-commit-email-addresses %}
18+
When you enable this setting, each time you push to {% data variables.product.github %}, we’ll check the most recent commit. If the author email on that commit is a private email on your GitHub account, we will block the push and warn you about exposing your private email.
2119

2220
{% data reusables.user-settings.access_settings %}
2321
{% data reusables.user-settings.emails %}
2422
{% data reusables.user-settings.keeping_your_email_address_private %}
2523
1. To keep your email address private in commits you push from the command line, select **Block command line pushes that expose my email**.
26-
27-
## Further reading
28-
29-
* [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address)

content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/changing-your-primary-email-address.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,6 @@ topics:
1717
shortTitle: Primary email address
1818
---
1919

20-
You can change the email address associated with your personal account at any time. You cannot change your primary email address to an email that is already set to be your backup email address.
21-
2220
{% ifversion ghec %}
2321

2422
>[!NOTE] This article **does not apply** to {% data variables.enterprise.prodname_managed_users %}. To change your email address as a {% data variables.enterprise.prodname_managed_user %}, contact the administrator for your company's identity provider (IdP). Your primary email address is the first one assigned to you in the IdP.

content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/index.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Managing email preferences
3-
intro: 'You can add or change the email addresses associated with your account. You can also manage emails you receive from {% data variables.product.github %}.'
3+
intro: You can add or change the email addresses associated with your account. You can also manage emails you receive from {% data variables.product.github %}.
44
redirect_from:
55
- /categories/managing-email-preferences
66
- /articles/managing-email-preferences
@@ -22,7 +22,8 @@ children:
2222
- /setting-your-commit-email-address
2323
- /blocking-command-line-pushes-that-expose-your-personal-email-address
2424
- /remembering-your-github-username-or-email
25-
- /managing-marketing-emails-from-github
25+
- /troubleshooting-adding-an-email
26+
- /troubleshooting-email-verification
2627
shortTitle: Manage email preferences
2728
---
2829

content/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address.md

Lines changed: 4 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -23,35 +23,6 @@ topics:
2323
- Notifications
2424
shortTitle: Set commit email address
2525
---
26-
## About commit email addresses
27-
28-
{% data variables.product.github %} uses your commit email address to associate commits with your account on {% data variables.product.github %}. You can choose the email address that will be associated with the commits you push from the command line as well as web-based Git operations you make.
29-
30-
For web-based Git operations, you can set your commit email address on {% data variables.product.github %}. For commits you push from the command line, you can set your commit email address in Git.
31-
32-
{% ifversion fpt or ghec %}Any commits you made prior to changing your commit email address are still associated with your previous email address.{% else %}After changing your commit email address on {% data variables.product.github %}, the new email address will be visible in all of your future web-based Git operations by default. Any commits you made prior to changing your commit email address are still associated with your previous email address.{% endif %}
33-
34-
{% ifversion fpt or ghec %}
35-
36-
> [!NOTE]
37-
> {% data reusables.user-settings.no-verification-disposable-emails %}
38-
39-
{% endif %}
40-
41-
{% ifversion fpt or ghec %}To use your `noreply` email address for commits you push from the command line, use that email address when you set your commit email address in Git. To use your `noreply` address for web-based Git operations, set your commit email address on GitHub and choose to **Keep my email address private**.
42-
43-
You can also choose to block commits you push from the command line that expose your personal email address. For more information, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/blocking-command-line-pushes-that-expose-your-personal-email-address).{% endif %}
44-
45-
To ensure that commits are attributed to you and appear in your contributions graph, use an email address that is connected to your account on {% data variables.product.github %}{% ifversion fpt or ghec %}, or the `noreply` email address provided to you in your email settings{% endif %}. For more information, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account).
46-
47-
{% ifversion fpt or ghec %}
48-
49-
<a name="about-no-reply-email"></a>
50-
51-
> [!NOTE]
52-
> If you created your account _after_ July 18, 2017, your `noreply` email address is an ID number and your username in the form of <code>ID+USERNAME@users.noreply.github.com</code>. If you created your account _prior to_ July 18, 2017, and enabled **Keep my email address private** prior to that date, your `noreply` email address is <code>USERNAME@users.noreply.github.com</code>. You can get an ID-based `noreply` email address by selecting (or deselecting and reselecting) **Keep my email address private** in your email settings.
53-
54-
If you use your `noreply` email address for {% data variables.product.github %} to make commits and then change your username, those commits will not be associated with your account. This does not apply if you're using the ID-based `noreply` address from {% data variables.product.github %}. For more information, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/changing-your-github-username).{% endif %}
5526

5627
## Setting your commit email address on {% data variables.product.github %}
5728

@@ -109,3 +80,7 @@ You can change the email address associated with commits you make in a single re
10980
```
11081

11182
1. {% data reusables.user-settings.link_email_with_your_account %}
83+
84+
## Next steps
85+
86+
To learn more about using a private email address, see [AUTOTITLE](/account-and-profile/reference/email-addresses-reference#your-noreply-email-address).
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: Troubleshooting adding an email
3+
intro: 'Troubleshoot problems when adding an email address to your {% data variables.product.github %} account.'
4+
versions:
5+
fpt: '*'
6+
ghes: '*'
7+
ghec: '*'
8+
topics:
9+
- Accounts
10+
- Notifications
11+
- Troubleshooting
12+
shortTitle: Troubleshoot adding an email
13+
---
14+
15+
## Email already in use
16+
17+
If you see the error message `Error adding EMAIL: email is already in use`, it means the email address is already linked to another {% data variables.product.prodname_dotcom %} account. An email address can only be associated with one {% data variables.product.prodname_dotcom %} account at a time.
18+
19+
To use this email with a different account, follow these steps:
20+
21+
1. Sign in to the account currently linked to the email address and remove it from that account.
22+
1. If you don’t have access to the account, request a password reset email to recover it. See [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/updating-your-github-access-credentials).
23+
24+
## Email linked to a {% data variables.enterprise.prodname_managed_user %}
25+
26+
If the email address that you are trying to add is provided to you by your organization, you may see the `Error adding EMAIL: email is already in use` error when your organization has created a {% data variables.enterprise.prodname_managed_user %} for you in their {% data variables.enterprise.prodname_emu_enterprise %}.
27+
28+
Reach out to your site administrator or internal IT helpdesk to learn about their deployment of {% data variables.product.prodname_ghe_cloud %} and how to access the account. You may be able to sign into the {% data variables.product.prodname_ghe_cloud %} application via the organization's identity provider (IdP).
29+
30+
If you want to use your email address with a personal account, you must sign in to your {% data variables.enterprise.prodname_managed_user %} and unverify the email in your account settings. The email will remain linked to your {% data variables.enterprise.prodname_managed_user %}, allowing you to access the account through your organization's IdP.
31+
32+
However, some third-party apps or services may not function properly with a {% data variables.enterprise.prodname_managed_user %} that has an unverified email address.

0 commit comments

Comments
 (0)