lib/gitlab/email/common.rb


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

# frozen_string_literal: true

module Gitlab
  module Email
    # Contains common methods which must be present in all email classes
    module Common
      UNSUBSCRIBE_SUFFIX        = '-unsubscribe'
      UNSUBSCRIBE_SUFFIX_LEGACY = '+unsubscribe'
      WILDCARD_PLACEHOLDER      = '%{key}'

      # This can be overridden for a custom config
      def config
        raise NotImplementedError
      end

      def incoming_email_config
        Gitlab.config.incoming_email
      end

      def enabled?
        !!config&.enabled && config.address.present?
      end

      def supports_wildcard?
        config_address = incoming_email_config.address

        config_address.present? && config_address.include?(WILDCARD_PLACEHOLDER)
      end

      def supports_issue_creation?
        enabled? && supports_wildcard?
      end

      def reply_address(key)
        incoming_email_config.address.sub(WILDCARD_PLACEHOLDER, key)
      end

      # example: incoming+1234567890abcdef1234567890abcdef-unsubscribe@incoming.gitlab.com
      def unsubscribe_address(key)
        incoming_email_config.address.sub(WILDCARD_PLACEHOLDER, "#{key}#{UNSUBSCRIBE_SUFFIX}")
      end

      def key_from_address(address, wildcard_address: nil)
        raise NotImplementedError
      end

      def key_from_fallback_message_id(mail_id)
        message_id_regexp = /\Areply-(.+)@#{Gitlab.config.gitlab.host}\z/

        mail_id[message_id_regexp, 1]
      end

      def scan_fallback_references(references)
        # It's looking for each <...>
        references.scan(/(?!<)[^<>]+(?=>)/)
      end
    end
  end
end