Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add custom subject for all kinds of mail templates #27861

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add custom subject for all kinds of mail templates #27861

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c7e1577
add mail template for all kinds
lng2020 Nov 1, 2023
a725667
fix tests
lng2020 Nov 1, 2023
78a035c
add other subjects
lng2020 Nov 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 46 additions & 11 deletions services/mailer/mail.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,12 @@ func sendUserMail(language string, u *user_model.User, tpl base.TplName, code, s
"Language": locale.Language(),
}

subjectFromTemplate := subjectFromTemplate(string(tpl), data)
if subjectFromTemplate != "" {
subject = subjectFromTemplate
}
data["Subject"] = subject
Comment on lines +78 to +82
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't we extract this into a new function setSubject that takes as parameters data, defaultSubject and always call that instead?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make sense. Will change it.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Em...Now I think the current way is better.
subject var is also used in NewMessage(u.Email, subject, content.String()). If using setSubject and removing the subject var, then we should use NewMessage(u.Email, data["Subject"].(string), content.String()) instead. I don't know if it's a good idea to use type assertion in such simple code.


var content bytes.Buffer

if err := bodyTemplates.ExecuteTemplate(&content, string(tpl), data); err != nil {
Expand Down Expand Up @@ -123,14 +129,22 @@ func SendActivateEmailMail(u *user_model.User, email *user_model.EmailAddress) {
"Language": locale.Language(),
}

subject := locale.Tr("mail.activate_email")

subjectFromTemplate := subjectFromTemplate(string(mailAuthActivateEmail), data)
if subjectFromTemplate != "" {
subject = subjectFromTemplate
}
data["Subject"] = subject

var content bytes.Buffer

if err := bodyTemplates.ExecuteTemplate(&content, string(mailAuthActivateEmail), data); err != nil {
log.Error("Template: %v", err)
return
}

msg := NewMessage(email.Email, locale.Tr("mail.activate_email"), content.String())
msg := NewMessage(email.Email, subject, content.String())
msg.Info = fmt.Sprintf("UID: %d, activate email", u.ID)

SendAsync(msg)
Expand All @@ -151,14 +165,22 @@ func SendRegisterNotifyMail(u *user_model.User) {
"Language": locale.Language(),
}

subject := locale.Tr("mail.register_notify")

subjectFromTemplate := subjectFromTemplate(string(mailAuthRegisterNotify), data)
if subjectFromTemplate != "" {
subject = subjectFromTemplate
}
data["Subject"] = subject

var content bytes.Buffer

if err := bodyTemplates.ExecuteTemplate(&content, string(mailAuthRegisterNotify), data); err != nil {
log.Error("Template: %v", err)
return
}

msg := NewMessage(u.Email, locale.Tr("mail.register_notify"), content.String())
msg := NewMessage(u.Email, subject, content.String())
msg.Info = fmt.Sprintf("UID: %d, registration notify", u.ID)

SendAsync(msg)
Expand All @@ -182,6 +204,12 @@ func SendCollaboratorMail(u, doer *user_model.User, repo *repo_model.Repository)
"Language": locale.Language(),
}

subjectFromTemplate := subjectFromTemplate(string(mailNotifyCollaborator), data)
if subjectFromTemplate != "" {
subject = subjectFromTemplate
}
data["Subject"] = subject

var content bytes.Buffer

if err := bodyTemplates.ExecuteTemplate(&content, string(mailNotifyCollaborator), data); err != nil {
Expand Down Expand Up @@ -265,18 +293,13 @@ func composeIssueCommentMessages(ctx *mailCommentContext, lang string, recipient
"CanReply": setting.IncomingEmail.Enabled && commentType != issues_model.CommentTypePullRequestPush,
}

var mailSubject bytes.Buffer
if err := subjectTemplates.ExecuteTemplate(&mailSubject, tplName, mailMeta); err == nil {
subject = sanitizeSubject(mailSubject.String())
if subject == "" {
subject = fallback
}
subjectFromTemplate := subjectFromTemplate(tplName, mailMeta)
if subjectFromTemplate != "" {
subject = subjectFromTemplate
} else {
log.Error("ExecuteTemplate [%s]: %v", tplName+"/subject", err)
subject = fallback
}

subject = emoji.ReplaceAliases(subject)

mailMeta["Subject"] = subject

var mailBody bytes.Buffer
Expand Down Expand Up @@ -520,3 +543,15 @@ func actionToTemplate(issue *issues_model.Issue, actionType activities_model.Act
}
return typeName, name, template
}

func subjectFromTemplate(tplName string, mailMeta map[string]any) string {
var mailSubject bytes.Buffer
var subject string
if err := subjectTemplates.ExecuteTemplate(&mailSubject, tplName, mailMeta); err == nil {
subject = sanitizeSubject(mailSubject.String())
} else {
log.Error("ExecuteTemplate [%s]: %v", tplName+"/subject", err)
}
subject = emoji.ReplaceAliases(subject)
return subject
}
5 changes: 5 additions & 0 deletions services/mailer/mail_release.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,11 @@ func mailNewRelease(ctx context.Context, lang string, tos []string, rel *repo_mo
"Language": locale.Language(),
}

subjectFromTemplate := subjectFromTemplate(string(tplNewReleaseMail), mailMeta)
if subjectFromTemplate != "" {
subject = subjectFromTemplate
}

var mailBody bytes.Buffer

if err := bodyTemplates.ExecuteTemplate(&mailBody, string(tplNewReleaseMail), mailMeta); err != nil {
Expand Down
5 changes: 5 additions & 0 deletions services/mailer/mail_repo.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,11 @@ func sendRepoTransferNotifyMailPerLang(lang string, newOwner, doer *user_model.U
"Destination": destination,
}

subjectFromTemplate := subjectFromTemplate(string(mailRepoTransferNotify), data)
if subjectFromTemplate != "" {
subject = subjectFromTemplate
}

if err := bodyTemplates.ExecuteTemplate(&content, string(mailRepoTransferNotify), data); err != nil {
return err
}
Expand Down
7 changes: 7 additions & 0 deletions services/mailer/mail_team_invite.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,13 @@ func MailTeamInvite(ctx context.Context, inviter *user_model.User, team *org_mod
"InviteURL": inviteURL,
}

subjectFromTemplate := subjectFromTemplate(string(tplTeamInviteMail), mailMeta)
if subjectFromTemplate != "" {
subject = subjectFromTemplate
}

mailMeta["Subject"] = subject

var mailBody bytes.Buffer
if err := bodyTemplates.ExecuteTemplate(&mailBody, string(tplTeamInviteMail), mailMeta); err != nil {
log.Error("ExecuteTemplate [%s]: %v", string(tplTeamInviteMail)+"/body", err)
Expand Down