BigW Consortium Gitlab

notify.rb 4.49 KB
Newer Older
1
class Notify < BaseMailer
2 3
  include ActionDispatch::Routing::PolymorphicRoutes

4 5 6 7
  include Emails::Issues
  include Emails::MergeRequests
  include Emails::Notes
  include Emails::Projects
8 9
  include Emails::Profile
  include Emails::Groups
10

11 12
  add_template_helper MergeRequestsHelper
  add_template_helper EmailsHelper
gitlabhq committed
13

Steven Burgart committed
14 15
  def test_email(recipient_email, subject, body)
    mail(to: recipient_email,
16 17 18 19 20 21
         subject: subject,
         body: body.html_safe,
         content_type: 'text/html'
    )
  end

22 23 24 25 26 27 28 29 30 31 32 33 34 35
  # Splits "gitlab.corp.company.com" up into "gitlab.corp.company.com",
  # "corp.company.com" and "company.com".
  # Respects set tld length so "company.co.uk" won't match "somethingelse.uk"
  def self.allowed_email_domains
    domain_parts = Gitlab.config.gitlab.host.split(".")
    allowed_domains = []
    begin
      allowed_domains << domain_parts.join(".")
      domain_parts.shift
    end while domain_parts.length > ActionDispatch::Http::URL.tld_length

    allowed_domains
  end

36 37
  private

38 39 40 41 42
  def can_send_from_user_email?(sender)
    sender_domain = sender.email.split("@").last
    self.class.allowed_email_domains.include?(sender_domain)
  end

43 44
  # Return an email address that displays the name of the sender.
  # Only the displayed name changes; the actual email address is always the same.
45
  def sender(sender_id, send_from_user_email = false)
46
    return unless sender = User.find(sender_id)
47

48 49
    address = default_sender_address
    address.display_name = sender.name
50

51 52
    if send_from_user_email && can_send_from_user_email?(sender)
      address.address = sender.email
53
    end
54 55

    address.format
56 57
  end

58 59 60 61 62 63
  # 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)
Douwe Maan committed
64 65
    @current_user = User.find(recipient_id)
    @current_user.notification_email
66 67
  end

68 69 70 71 72 73 74
  # 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')
75
  #   => "Lorem ipsum"
76 77 78 79 80
  #
  #   # 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')
81
  #   => "Ruby on Rails | Lorem ipsum "
82 83 84
  #
  #   # Accepts multiple arguments
  #   >> subject('Lorem ipsum', 'Dolor sit amet')
85
  #   => "Lorem ipsum | Dolor sit amet"
86
  def subject(*extra)
87
    subject = ""
88
    subject << "#{@project.name} | " if @project
89
    subject << extra.join(' | ') if extra.present?
90
    subject
91
  end
92 93 94 95 96 97 98 99 100

  # 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

101
  def mail_thread(model, headers = {})
Douwe Maan committed
102
    if @project
103
      headers['X-GitLab-Project'] = @project.name
Douwe Maan committed
104 105 106 107 108 109 110 111
      headers['X-GitLab-Project-Id'] = @project.id
      headers['X-GitLab-Project-Path'] = @project.path_with_namespace
    end

    headers["X-GitLab-#{model.class.name}-ID"] = model.id

    if reply_key
      headers['X-GitLab-Reply-Key'] = reply_key
112

113
      address = Mail::Address.new(Gitlab::IncomingEmail.reply_address(reply_key))
114 115 116 117 118
      address.display_name = @project.name_with_namespace

      headers['Reply-To'] = address

      @reply_by_email = true
Douwe Maan committed
119 120 121
    end

    mail(headers)
122 123
  end

124 125 126 127 128 129 130 131 132 133
  # 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 = {})
    headers['Message-ID'] = message_id(model)

    mail_thread(model, headers)
  end

134 135 136 137 138 139 140 141
  # 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'
  #
Douwe Maan committed
142
  def mail_answer_thread(model, headers = {})
143
    headers['Message-ID'] = "<#{SecureRandom.hex}@#{Gitlab.config.gitlab.host}>"
144 145 146
    headers['In-Reply-To'] = message_id(model)
    headers['References'] = message_id(model)

147
    headers[:subject].prepend('Re: ') if headers[:subject]
Douwe Maan committed
148

149
    mail_thread(model, headers)
150
  end
Douwe Maan committed
151

Douwe Maan committed
152
  def reply_key
153
    @reply_key ||= SentNotification.reply_key
Douwe Maan committed
154
  end
gitlabhq committed
155
end