From 20e8c8c37295e94902359a75177ffcb3e0a8b06e Mon Sep 17 00:00:00 2001 From: Tyrone Yeh Date: Fri, 29 Jul 2022 09:48:05 +0800 Subject: [PATCH] Added email notification option to receive all own messages (#20179) Sometimes users want to receive email notifications of messages they create or reply to, Added an option to personal preferences to allow users to choose Closes #20149 --- models/user/user.go | 8 +++++--- models/user/user_test.go | 3 +++ modules/notification/mail/mail.go | 4 ++-- options/locale/locale_en-US.ini | 5 +---- routers/web/user/setting/account.go | 3 ++- services/mailer/mail_issue.go | 5 ++++- templates/user/settings/account.tmpl | 3 ++- 7 files changed, 19 insertions(+), 12 deletions(-) diff --git a/models/user/user.go b/models/user/user.go index 490e7223ce638..9c02cede116f9 100644 --- a/models/user/user.go +++ b/models/user/user.go @@ -64,12 +64,14 @@ var AvailableHashAlgorithms = []string{ } const ( - // EmailNotificationsEnabled indicates that the user would like to receive all email notifications + // EmailNotificationsEnabled indicates that the user would like to receive all email notifications except your own EmailNotificationsEnabled = "enabled" // EmailNotificationsOnMention indicates that the user would like to be notified via email when mentioned. EmailNotificationsOnMention = "onmention" // EmailNotificationsDisabled indicates that the user would not like to be notified via email. EmailNotificationsDisabled = "disabled" + // EmailNotificationsEnabled indicates that the user would like to receive all email notifications and your own + EmailNotificationsAndYourOwn = "andyourown" ) // User represents the object of individual and member of organization. @@ -1045,7 +1047,7 @@ func GetMaileableUsersByIDs(ids []int64, isMention bool) ([]*User, error) { Where("`type` = ?", UserTypeIndividual). And("`prohibit_login` = ?", false). And("`is_active` = ?", true). - And("`email_notifications_preference` IN ( ?, ?)", EmailNotificationsEnabled, EmailNotificationsOnMention). + In("`email_notifications_preference`", EmailNotificationsEnabled, EmailNotificationsOnMention, EmailNotificationsAndYourOwn). Find(&ous) } @@ -1053,7 +1055,7 @@ func GetMaileableUsersByIDs(ids []int64, isMention bool) ([]*User, error) { Where("`type` = ?", UserTypeIndividual). And("`prohibit_login` = ?", false). And("`is_active` = ?", true). - And("`email_notifications_preference` = ?", EmailNotificationsEnabled). + In("`email_notifications_preference`", EmailNotificationsEnabled, EmailNotificationsAndYourOwn). Find(&ous) } diff --git a/models/user/user_test.go b/models/user/user_test.go index 4994ac53ab3df..489ee3b05da35 100644 --- a/models/user/user_test.go +++ b/models/user/user_test.go @@ -153,6 +153,9 @@ func TestEmailNotificationPreferences(t *testing.T) { assert.NoError(t, user_model.SetEmailNotifications(user, user_model.EmailNotificationsDisabled)) assert.Equal(t, user_model.EmailNotificationsDisabled, user.EmailNotifications()) + + assert.NoError(t, user_model.SetEmailNotifications(user, user_model.EmailNotificationsAndYourOwn)) + assert.Equal(t, user_model.EmailNotificationsAndYourOwn, user.EmailNotifications()) } } diff --git a/modules/notification/mail/mail.go b/modules/notification/mail/mail.go index 1f217304b0638..5085656c14a4f 100644 --- a/modules/notification/mail/mail.go +++ b/modules/notification/mail/mail.go @@ -126,7 +126,7 @@ func (m *mailNotifier) NotifyPullRequestCodeComment(pr *issues_model.PullRequest func (m *mailNotifier) NotifyIssueChangeAssignee(doer *user_model.User, issue *issues_model.Issue, assignee *user_model.User, removed bool, comment *issues_model.Comment) { // mail only sent to added assignees and not self-assignee - if !removed && doer.ID != assignee.ID && (assignee.EmailNotifications() == user_model.EmailNotificationsEnabled || assignee.EmailNotifications() == user_model.EmailNotificationsOnMention) { + if !removed && doer.ID != assignee.ID && assignee.EmailNotifications() != user_model.EmailNotificationsDisabled { ct := fmt.Sprintf("Assigned #%d.", issue.Index) if err := mailer.SendIssueAssignedMail(issue, doer, ct, comment, []*user_model.User{assignee}); err != nil { log.Error("Error in SendIssueAssignedMail for issue[%d] to assignee[%d]: %v", issue.ID, assignee.ID, err) @@ -135,7 +135,7 @@ func (m *mailNotifier) NotifyIssueChangeAssignee(doer *user_model.User, issue *i } func (m *mailNotifier) NotifyPullReviewRequest(doer *user_model.User, issue *issues_model.Issue, reviewer *user_model.User, isRequest bool, comment *issues_model.Comment) { - if isRequest && doer.ID != reviewer.ID && (reviewer.EmailNotifications() == user_model.EmailNotificationsEnabled || reviewer.EmailNotifications() == user_model.EmailNotificationsOnMention) { + if isRequest && doer.ID != reviewer.ID && reviewer.EmailNotifications() != user_model.EmailNotificationsDisabled { ct := fmt.Sprintf("Requested to review %s.", issue.HTMLURL()) if err := mailer.SendIssueAssignedMail(issue, doer, ct, comment, []*user_model.User{reviewer}); err != nil { log.Error("Error in SendIssueAssignedMail for issue[%d] to reviewer[%d]: %v", issue.ID, reviewer.ID, err) diff --git a/options/locale/locale_en-US.ini b/options/locale/locale_en-US.ini index 9a8418201aeb6..21f22a0fb22f7 100644 --- a/options/locale/locale_en-US.ini +++ b/options/locale/locale_en-US.ini @@ -800,6 +800,7 @@ email_notifications.enable = Enable Email Notifications email_notifications.onmention = Only Email on Mention email_notifications.disable = Disable Email Notifications email_notifications.submit = Set Email Preference +email_notifications.andyourown = And Your Own Notifications visibility = User visibility visibility.public = Public @@ -1780,10 +1781,6 @@ settings.mirror_settings.push_mirror.remote_url = Git Remote Repository URL settings.mirror_settings.push_mirror.add = Add Push Mirror settings.sync_mirror = Synchronize Now settings.mirror_sync_in_progress = Mirror synchronization is in progress. Check back in a minute. -settings.email_notifications.enable = Enable Email Notifications -settings.email_notifications.onmention = Only Email on Mention -settings.email_notifications.disable = Disable Email Notifications -settings.email_notifications.submit = Set Email Preference settings.site = Website settings.update_settings = Update Settings settings.branches.update_default_branch = Update Default Branch diff --git a/routers/web/user/setting/account.go b/routers/web/user/setting/account.go index 0228b5521bcee..0829158a05b74 100644 --- a/routers/web/user/setting/account.go +++ b/routers/web/user/setting/account.go @@ -156,7 +156,8 @@ func EmailPost(ctx *context.Context) { preference := ctx.FormString("preference") if !(preference == user_model.EmailNotificationsEnabled || preference == user_model.EmailNotificationsOnMention || - preference == user_model.EmailNotificationsDisabled) { + preference == user_model.EmailNotificationsDisabled || + preference == user_model.EmailNotificationsAndYourOwn) { log.Error("Email notifications preference change returned unrecognized option %s: %s", preference, ctx.Doer.Name) ctx.ServerError("SetEmailPreference", errors.New("option unrecognized")) return diff --git a/services/mailer/mail_issue.go b/services/mailer/mail_issue.go index 5c330f6e00b87..b4827e83a757f 100644 --- a/services/mailer/mail_issue.go +++ b/services/mailer/mail_issue.go @@ -91,7 +91,9 @@ func mailIssueCommentToParticipants(ctx *mailCommentContext, mentions []*user_mo visited := make(map[int64]bool, len(unfiltered)+len(mentions)+1) // Avoid mailing the doer - visited[ctx.Doer.ID] = true + if ctx.Doer.EmailNotificationsPreference != user_model.EmailNotificationsAndYourOwn { + visited[ctx.Doer.ID] = true + } // =========== Mentions =========== if err = mailIssueCommentBatch(ctx, mentions, visited, true); err != nil { @@ -133,6 +135,7 @@ func mailIssueCommentBatch(ctx *mailCommentContext, users []*user_model.User, vi // At this point we exclude: // user that don't have all mails enabled or users only get mail on mention and this is one ... if !(user.EmailNotificationsPreference == user_model.EmailNotificationsEnabled || + user.EmailNotificationsPreference == user_model.EmailNotificationsAndYourOwn || fromMention && user.EmailNotificationsPreference == user_model.EmailNotificationsOnMention) { continue } diff --git a/templates/user/settings/account.tmpl b/templates/user/settings/account.tmpl index 1b3fd136de139..6ac6071524205 100644 --- a/templates/user/settings/account.tmpl +++ b/templates/user/settings/account.tmpl @@ -59,9 +59,10 @@
{{svg "octicon-triangle-down" 14 "dropdown icon"}} -
{{$.i18n.Tr "settings.email_notifications"}}
+
{{$.i18n.Tr "settings.email_notifications.enable"}}
+
{{$.i18n.Tr "settings.email_notifications.andyourown"}}
{{$.i18n.Tr "settings.email_notifications.onmention"}}
{{$.i18n.Tr "settings.email_notifications.disable"}}