Module: SanitizeEmail::MailHeaderTools

Defined in:
lib/sanitize_email/mail_header_tools.rb

Overview

Tools for modifying the header of an email

Class Method Summary collapse

Class Method Details

.add_original_addresses_as_headers(message) ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/sanitize_email/mail_header_tools.rb', line 28

def self.add_original_addresses_as_headers(message)
  ## Add headers by string concat. Setting hash values on message.headers does nothing, strangely. http://goo.gl/v46GY
  {
    'X-Sanitize-Email-To' => Array(message.to).uniq, # can be an array, so casting it as an array
    'X-Sanitize-Email-Cc' => Array(message.cc).uniq  # can be an array, so casting it as an array
    # Don't write out the BCC, as those addresses should not be visible in message headers for obvious reasons
  }.each { |header_key, header_value|
    # For each type of address line
    SanitizeEmail::MailHeaderTools.update_header(header_key, header_value, message)
  }
end

.custom_subject(message) ⇒ Object 



16
17
18
 
# File 'lib/sanitize_email/mail_header_tools.rb', line 16

def self.custom_subject(message)
  prepend_subject_array(message).join(" ")
end

.prepend_custom_subject(message) ⇒ Object 



40
41
42
43
 
# File 'lib/sanitize_email/mail_header_tools.rb', line 40

def self.prepend_custom_subject(message)
  message.subject = "" unless message.subject
  message.subject.prepend(SanitizeEmail::MailHeaderTools.custom_subject(message))
end

.prepend_email_to_subject(actual_addresses) ⇒ Object 



24
25
26
 
# File 'lib/sanitize_email/mail_header_tools.rb', line 24

def self.prepend_email_to_subject(actual_addresses)
  "(#{actual_addresses.uniq.join(',').gsub(/@/, ' at ').gsub(/[<>]/, '~')})" if actual_addresses.respond_to?(:join)
end

.prepend_environment_to_subject ⇒ Object 



20
21
22
 
# File 'lib/sanitize_email/mail_header_tools.rb', line 20

def self.prepend_environment_to_subject
  SanitizeEmail::Config.config[:environment]
end

.prepend_subject_array(message) ⇒ Object 



8
9
10
11
12
13
14
 
# File 'lib/sanitize_email/mail_header_tools.rb', line 8

def self.prepend_subject_array(message)
  prepend = []
  prepend << SanitizeEmail::MailHeaderTools.prepend_email_to_subject(Array(message.to)) if SanitizeEmail.use_actual_email_prepended_to_subject
  prepend << SanitizeEmail::MailHeaderTools.prepend_environment_to_subject if SanitizeEmail.use_actual_environment_prepended_to_subject
  prepend << "" unless prepend.empty? # this will force later joins to add an extra space
  prepend
end

.update_header(header_key, header_value, message) ⇒ Object

According to github.com/mikel/mail this is the correct way to update headers.



46
47
48
49
50
51
52
53
54
55
 
# File 'lib/sanitize_email/mail_header_tools.rb', line 46

def self.update_header(header_key, header_value, message)
  # For each address, as header_value can be an array of addresses
  Array(header_value).each_with_index { |elem, index|
    num = index + 1
    new_header_key = num > 1 ?
      "#{header_key}-#{num}" :
      header_key
    message.header[new_header_key] = elem.to_s
  } if header_value
end