app/models/channel/email_build.rb
# Copyright (C) 2012-2024 Zammad Foundation, https://zammad-foundation.org/
module Channel::EmailBuild
=begin
generate email
mail = Channel::EmailBuild.build(
from: 'sender@example.com',
to: 'recipient@example.com',
body: 'somebody with some text',
content_type: 'text/plain',
)
generate email with S/MIME
mail = Channel::EmailBuild.build(
from: 'sender@example.com',
to: 'recipient@example.com',
body: 'somebody with some text',
content_type: 'text/plain',
security: {
type: 'S/MIME',
encryption: {
success: true,
},
sign: {
success: true,
},
}
)
=end
def self.build(attr, notification = false)
mail = Mail.new
# set headers
attr.each do |key, value|
next if key.to_s == 'attachments'
next if key.to_s == 'body'
next if key.to_s == 'content_type'
next if key.to_s == 'security'
mail[key.to_s] = if value.present? && value.class != Array
value.to_s
else
value
end
end
# add html part
if attr[:content_type] && attr[:content_type] == 'text/html'
html_alternative = Mail::Part.new do
content_type 'text/html; charset=UTF-8'
# complete check
html_document = Channel::EmailBuild.html_complete_check(attr[:body])
body html_document
end
# generate plain part
attr[:body] = attr[:body].html2text
end
# add plain text part
text_alternative = Mail::Part.new do
content_type 'text/plain; charset=UTF-8'
body attr[:body]
end
# build email without any attachments
if !html_alternative && attr[:attachments].blank?
mail.content_type 'text/plain; charset=UTF-8'
mail.body attr[:body]
SecureMailing.outgoing(mail, attr[:security])
return mail
end
# build email with attachments
alternative_bodies = Mail::Part.new { content_type 'multipart/alternative' }
alternative_bodies.add_part text_alternative
found_content_ids = {}
if html_alternative
# find all inline attachments used in body
begin
scrubber = Loofah::Scrubber.new do |node|
next if node.name != 'img'
next if node['src'].blank?
next if node['src'] !~ %r{^cid:\s{0,2}(.+?)\s{0,2}$}
found_content_ids[$1] = true
end
Loofah.fragment(html_alternative.body.to_s).scrub!(scrubber)
rescue => e
logger.error e
end
html_alternative.body = Channel::EmailBuild.adjust_inline_image_size(html_alternative.body.to_s) if found_content_ids.present?
html_container = Mail::Part.new { content_type 'multipart/related' }
html_container.add_part html_alternative
# place to add inline attachments related to html alternative
attr[:attachments]&.each do |attachment|
next if attachment.instance_of?(Hash)
next if attachment.preferences['Content-ID'].blank?
next if !found_content_ids[ attachment.preferences['Content-ID'] ]
attachment = Mail::Part.new do
content_type attachment.preferences['Content-Type']
content_id "<#{attachment.preferences['Content-ID']}>"
content_disposition attachment.preferences['Content-Disposition'] || 'inline'
content_transfer_encoding 'binary'
body attachment.content.force_encoding('BINARY')
end
html_container.add_part attachment
end
alternative_bodies.add_part html_container
end
mail.add_part alternative_bodies
# add attachments
attr[:attachments]&.each do |attachment|
if attachment.instance_of?(Hash)
attachment['content-id'] = nil
mail.attachments[attachment[:filename]] = attachment
else
next if attachment.preferences['Content-ID'].present? && found_content_ids[ attachment.preferences['Content-ID'] ]
filename = attachment.filename
encoded_filename = Mail::Encodings.decode_encode filename, :encode
disposition = attachment.preferences['Content-Disposition'] || 'attachment'
content_type = attachment.preferences['Content-Type'] || attachment.preferences['Mime-Type'] || 'application/octet-stream'
mail.attachments[attachment.filename] = {
content_disposition: "#{disposition}; filename=\"#{encoded_filename}\"",
content_type: "#{content_type}; filename=\"#{encoded_filename}\"",
content: attachment.content
}
end
end
SecureMailing.outgoing(mail, attr[:security])
# set organization
organization = Setting.get('organization')
if organization.present?
mail['Organization'] = organization.to_s
end
if notification
mail['X-Loop'] = 'yes'
mail['Precedence'] = 'bulk'
mail['Auto-Submitted'] = 'auto-generated'
mail['X-Auto-Response-Suppress'] = 'All'
end
# rubocop:disable Zammad/DetectTranslatableString
mail['X-Powered-By'] = 'Zammad - Helpdesk/Support (https://zammad.org/)'
mail['X-Mailer'] = 'Zammad Mail Service'
# rubocop:enable Zammad/DetectTranslatableString
mail
end
=begin
quoted_in_one_line = Channel::EmailBuild.recipient_line('Somebody @ "Company"', 'some.body@example.com')
returns
'"Somebody @ \"Company\"" <some.body@example.com>'
=end
def self.recipient_line(realname, email)
Mail::Address.new.tap do |address|
address.display_name = realname
address.address = email
end.format
end
=begin
Check if string is a complete html document. If not, add head and css styles.
full_html_document_string = Channel::EmailBuild.html_complete_check(html_string)
=end
def self.html_complete_check(html)
# apply mail client fixes
html = Channel::EmailBuild.html_mail_client_fixes(html)
return html if html.match?(%r{<html>}i)
html_email_body = File.read(Rails.root.join('app/views/mailer/application_wrapper.html.erb').to_s)
html_email_body.gsub!('###html_email_css_font###', Setting.get('html_email_css_font'))
# use block form because variable html could contain backslashes and e. g. '\1' that
# must not be handled as back-references for regular expressions
html_email_body.sub('###html###') { html }
end
=begin
Add/change markup to display html in any mail client nice.
html_string_with_fixes = Channel::EmailBuild.html_mail_client_fixes(html_string)
=end
def self.html_mail_client_fixes(html)
# https://github.com/martini/zammad/issues/165
new_html = html.gsub('<blockquote type="cite">', '<blockquote type="cite" style="border-left: 2px solid blue; margin: 0 0 16px; padding: 8px 12px 8px 12px;">')
new_html.gsub!(%r{<p>}mxi, '<p style="margin: 0;">')
new_html.gsub!(%r{</?hr>}mxi, '<hr style="margin-top: 6px; margin-bottom: 6px; border: 0; border-top: 1px solid #dfdfdf;">')
new_html
end
=begin
Adjust image size in html email for MS Outlook to always contain `width` and `height` as tags, not only as part of the `style`.
html_string_with_adjustments = Channel::EmailBuild.adjust_inline_image_size(html_string)
=end
def self.adjust_inline_image_size(html)
Loofah.fragment(html).scrub!(HtmlSanitizer::Scrubber::Outgoing::ImageSize.new).to_html
end
end