6dafbf2412
* send a 'In-Reply-To' header along the 'References' header * subject of answers to an existing thread begins with 'Re: '
126 lines
3.8 KiB
Ruby
126 lines
3.8 KiB
Ruby
class Notify < ActionMailer::Base
|
|
include ActionDispatch::Routing::PolymorphicRoutes
|
|
|
|
include Emails::Issues
|
|
include Emails::MergeRequests
|
|
include Emails::Notes
|
|
include Emails::Projects
|
|
include Emails::Profile
|
|
include Emails::Groups
|
|
|
|
add_template_helper ApplicationHelper
|
|
add_template_helper GitlabMarkdownHelper
|
|
add_template_helper MergeRequestsHelper
|
|
|
|
default_url_options[:host] = Gitlab.config.gitlab.host
|
|
default_url_options[:protocol] = Gitlab.config.gitlab.protocol
|
|
default_url_options[:port] = Gitlab.config.gitlab.port unless Gitlab.config.gitlab_on_standard_port?
|
|
default_url_options[:script_name] = Gitlab.config.gitlab.relative_url_root
|
|
|
|
default from: Proc.new { default_sender_address.format }
|
|
default reply_to: "noreply@#{Gitlab.config.gitlab.host}"
|
|
|
|
# Just send email with 2 seconds delay
|
|
def self.delay
|
|
delay_for(2.seconds)
|
|
end
|
|
|
|
private
|
|
|
|
# The default email address to send emails from
|
|
def default_sender_address
|
|
address = Mail::Address.new(Gitlab.config.gitlab.email_from)
|
|
address.display_name = "GitLab"
|
|
address
|
|
end
|
|
|
|
# Return an email address that displays the name of the sender.
|
|
# Only the displayed name changes; the actual email address is always the same.
|
|
def sender(sender_id)
|
|
if sender = User.find(sender_id)
|
|
address = default_sender_address
|
|
address.display_name = sender.name
|
|
address.format
|
|
end
|
|
end
|
|
|
|
# Look up a User by their ID and return their email address
|
|
#
|
|
# recipient_id - User ID
|
|
#
|
|
# Returns a String containing the User's email address.
|
|
def recipient(recipient_id)
|
|
if recipient = User.find(recipient_id)
|
|
recipient.email
|
|
end
|
|
end
|
|
|
|
# Set the References header field
|
|
#
|
|
# local_part - The local part of the referenced message ID
|
|
#
|
|
def set_reference(local_part)
|
|
headers["References"] = "<#{local_part}@#{Gitlab.config.gitlab.host}>"
|
|
end
|
|
|
|
# Formats arguments into a String suitable for use as an email subject
|
|
#
|
|
# extra - Extra Strings to be inserted into the subject
|
|
#
|
|
# Examples
|
|
#
|
|
# >> subject('Lorem ipsum')
|
|
# => "Lorem ipsum"
|
|
#
|
|
# # Automatically inserts Project name when @project is set
|
|
# >> @project = Project.last
|
|
# => #<Project id: 1, name: "Ruby on Rails", path: "ruby_on_rails", ...>
|
|
# >> subject('Lorem ipsum')
|
|
# => "Ruby on Rails | Lorem ipsum "
|
|
#
|
|
# # Accepts multiple arguments
|
|
# >> subject('Lorem ipsum', 'Dolor sit amet')
|
|
# => "Lorem ipsum | Dolor sit amet"
|
|
def subject(*extra)
|
|
subject = ""
|
|
subject << "#{@project.name} | " if @project
|
|
subject << extra.join(' | ') if extra.present?
|
|
subject
|
|
end
|
|
|
|
# Return a string suitable for inclusion in the 'Message-Id' mail header.
|
|
#
|
|
# The message-id is generated from the unique URL to a model object.
|
|
def message_id(model)
|
|
model_name = model.class.model_name.singular_route_key
|
|
"<#{model_name}_#{model.id}@#{Gitlab.config.gitlab.host}>"
|
|
end
|
|
|
|
# Send an email that starts a new conversation thread,
|
|
# with headers suitable for grouping by thread in email clients.
|
|
#
|
|
# See: mail_answer_thread
|
|
def mail_new_thread(model, headers = {}, &block)
|
|
headers['Message-ID'] = message_id(model)
|
|
mail(headers, &block)
|
|
end
|
|
|
|
# Send an email that responds to an existing conversation thread,
|
|
# with headers suitable for grouping by thread in email clients.
|
|
#
|
|
# For grouping emails by thread, email clients heuristics require the answers to:
|
|
#
|
|
# * have a subject that begin by 'Re: '
|
|
# * have a 'In-Reply-To' or 'References' header that references the original 'Message-ID'
|
|
#
|
|
def mail_answer_thread(model, headers = {}, &block)
|
|
headers['In-Reply-To'] = message_id(model)
|
|
headers['References'] = message_id(model)
|
|
|
|
if (headers[:subject])
|
|
headers[:subject].prepend('Re: ')
|
|
end
|
|
|
|
mail(headers, &block)
|
|
end
|
|
end
|