1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
|
# frozen_string_literal: true
module Emails
module ServiceDesk
extend ActiveSupport::Concern
include MarkupHelper
include ::ServiceDesk::CustomEmails::Logger
EMAIL_ATTACHMENTS_SIZE_LIMIT = 10.megabytes.freeze
included do
layout 'service_desk', only: [:service_desk_thank_you_email, :service_desk_new_note_email]
end
def service_desk_thank_you_email(issue_id)
setup_service_desk_mail(issue_id)
email_sender = sender(
@support_bot.id,
send_from_user_email: false,
sender_name: @service_desk_setting&.outgoing_name,
sender_email: service_desk_sender_email_address
)
options = {
from: email_sender,
to: @issue.external_author,
subject: "Re: #{subject_base}",
**service_desk_template_content_options('thank_you')
}
mail_new_thread(@issue, options)
inject_service_desk_custom_email
end
def service_desk_new_note_email(issue_id, note_id, recipient)
@note = Note.find(note_id)
setup_service_desk_mail(issue_id)
# Prepare uploads for text replacement in markdown content
setup_service_desk_attachments
email_sender = sender(
@note.author_id,
send_from_user_email: false,
sender_email: service_desk_sender_email_address
)
options = {
from: email_sender,
to: recipient,
subject: subject_base,
**service_desk_template_content_options('new_note')
}
mail_answer_thread(@issue, options)
# Add attachments after email init to guide ActiveMailer
# to choose the correct multipart content types
add_uploads_as_attachments
inject_service_desk_custom_email
end
def service_desk_custom_email_verification_email(service_desk_setting)
@service_desk_setting = service_desk_setting
@project = @service_desk_setting.project
email_sender = sender(
Users::Internal.support_bot.id,
send_from_user_email: false,
sender_name: @service_desk_setting.outgoing_name,
sender_email: @service_desk_setting.custom_email
)
@verification_token = @service_desk_setting.custom_email_verification.token
subject = format(s_("Notify|Verify custom email address %{email} for %{project_name}"),
email: @service_desk_setting.custom_email,
project_name: @project.name
)
options = {
from: email_sender,
to: @service_desk_setting.custom_email_address_for_verification,
subject: subject
}
# Outgoing emails from GitLab usually have this set to true.
# Service Desk email ingestion ignores auto generated emails.
headers["Auto-Submitted"] = "no"
mail_with_locale(options)
inject_service_desk_custom_email(force: true)
end
def service_desk_verification_triggered_email(service_desk_setting, recipient)
@service_desk_setting = service_desk_setting
@triggerer = @service_desk_setting.custom_email_verification.triggerer
@smtp_address = @service_desk_setting.custom_email_credential.smtp_address
subject = format(s_("Notify|Verification for custom email %{email} for %{project_name} triggered"),
email: @service_desk_setting.custom_email,
project_name: @service_desk_setting.project.name
)
email_with_layout(to: recipient, subject: subject)
end
def service_desk_verification_result_email(service_desk_setting, recipient)
@service_desk_setting = service_desk_setting
@verification = @service_desk_setting.custom_email_verification
subject = format(s_("Notify|Verification result for custom email %{email} for %{project_name}"),
email: @service_desk_setting.custom_email,
project_name: @service_desk_setting.project.name
)
email_with_layout(to: recipient, subject: subject)
end
private
def setup_service_desk_mail(issue_id)
@issue = Issue.find(issue_id)
@project = @issue.project
@support_bot = Users::Internal.support_bot
@service_desk_setting = @project.service_desk_setting
@sent_notification = SentNotification.record(@issue, @support_bot.id, reply_key)
end
def service_desk_template_content_options(email_type)
return {} unless template_body = template_content(email_type)
{
body: template_body,
content_type: 'text/html; charset=UTF-8'
}
end
def inject_service_desk_custom_email(force: false)
return mail if !service_desk_custom_email_enabled? && !force
return mail unless @service_desk_setting.custom_email_credential.present?
# Only set custom email reply address if it's enabled, not when we force it.
inject_service_desk_custom_email_reply_address unless force
log_info(project: @project)
mail.delivery_method(::Mail::SMTP, @service_desk_setting.custom_email_credential.delivery_options)
end
def service_desk_custom_email_enabled?
Feature.enabled?(:service_desk_custom_email, @project) && @service_desk_setting&.custom_email_enabled?
end
def inject_service_desk_custom_email_reply_address
return unless Feature.enabled?(:service_desk_custom_email_reply, @project)
reply_address = Gitlab::Email::ServiceDesk::CustomEmail.reply_address(@issue, reply_key)
headers['Reply-To'] = Mail::Address.new(reply_address).tap do |address|
address.display_name = reply_display_name(@issue)
end
end
def service_desk_sender_email_address
return unless service_desk_custom_email_enabled?
@service_desk_setting.custom_email
end
def template_content(email_type)
template = Gitlab::Template::ServiceDeskTemplate.find(email_type, @project)
text = substitute_template_replacements(template.content)
context = { project: @project, pipeline: :service_desk_email, uploads_as_attachments: @uploads_as_attachments }
context[:author] = @note.author if email_type == 'new_note'
markdown(text, context)
rescue Gitlab::Template::Finders::RepoTemplateFinder::FileNotFoundError
nil
end
def substitute_template_replacements(template_body)
template_body
.gsub(/%\{\s*ISSUE_ID\s*\}/, issue_id)
.gsub(/%\{\s*ISSUE_PATH\s*\}/, issue_path)
.gsub(/%\{\s*NOTE_TEXT\s*\}/, note_text)
.gsub(/%\{\s*ISSUE_DESCRIPTION\s*\}/, issue_description)
.gsub(/%\{\s*SYSTEM_HEADER\s*\}/, text_header_message.to_s)
.gsub(/%\{\s*SYSTEM_FOOTER\s*\}/, text_footer_message.to_s)
.gsub(/%\{\s*UNSUBSCRIBE_URL\s*\}/, unsubscribe_sent_notification_url(@sent_notification))
.gsub(/%\{\s*ADDITIONAL_TEXT\s*\}/, service_desk_email_additional_text.to_s)
.gsub(/%\{\s*ISSUE_URL\s*\}/, full_issue_url)
end
def full_issue_url
issue_url(@issue)
end
def issue_id
"#{Issue.reference_prefix}#{@issue.iid}"
end
def issue_path
@issue.to_reference(full: true)
end
def note_text
@note&.note.to_s
end
def issue_description
@issue.description_html.to_s
end
def subject_base
"#{@issue.title} (##{@issue.iid})"
end
def setup_service_desk_attachments
@uploads_to_attach = []
# Filepaths we should replace in markdown content
@uploads_as_attachments = []
return unless Feature.enabled?(:service_desk_new_note_email_native_attachments, @note.project)
uploaders = find_uploaders_for(@note)
return if uploaders.nil?
return if uploaders.sum(&:size) > EMAIL_ATTACHMENTS_SIZE_LIMIT
uploaders.each do |uploader|
@uploads_to_attach << { filename: uploader.filename, content: uploader.read }
@uploads_as_attachments << "#{uploader.secret}/#{uploader.filename}"
rescue StandardError => e
Gitlab::ErrorTracking.track_exception(e, project_id: @note.project.id)
end
end
def add_uploads_as_attachments
# We read the uploads before in setup_service_desk_attachments, so let's just add them
@uploads_to_attach.each do |upload|
mail.add_file(filename: upload[:filename], content: upload[:content])
end
end
def find_uploaders_for(note)
uploads = FileUploader::MARKDOWN_PATTERN.scan(note.note)
return unless uploads.present?
project = note.project
uploads.map do |secret, file_name|
UploaderFinder.new(project, secret, file_name).execute
end
rescue StandardError => e
Gitlab::ErrorTracking.track_exception(e, project_id: note.project.id)
nil
end
end
end
|