Class: SanitizeEmail::Config

Inherits:
Object
  • Object
show all
Extended by:
Deprecation
Defined in:
lib/sanitize_email/config.rb

Overview

The API for configuring SanitizeEmail is via ‘SanitizeEmail.config` Available configuration options are listed in the `DEFAULTS` constant.

Constant Summary collapse

DEFAULTS = 
{
  # Specify the BCC addresses for the messages
  #   that go out in "local" environments
  sanitized_bcc: nil,

  # Specify the CC addresses for the messages
  #   that go out in "local" environments
  sanitized_cc: nil,

  # The recipient addresses for the messages,
  #   either as a string (for a single address)
  #   or an array (for multiple addresses)
  #   that go out in "local" environments
  sanitized_to: nil,

  # an allow list
  good_list: nil,

  # a block list
  bad_list: nil,

  environment: if defined?(Rails) && Rails.env.present?
                 "[#{Rails.env}]"
               else
                 "[UNKNOWN ENVIRONMENT]"
               end,

  # Use the "real" email address as the username
  #   for the sanitized email address
  # e.g. "real at example.com <[email protected]>"
  use_actual_email_as_sanitized_user_name: false,

  # Prepend the "real" email address onto the Subject line of the message
  # e.g. "real at example.com rest of subject"
  use_actual_email_prepended_to_subject: false,

  # Prepend the Rails environment onto the Subject line of the message
  # e.g. "[development] rest of subject"
  use_actual_environment_prepended_to_subject: false,

  # True / False turns on or off sanitization,
  #   while nil ignores this setting and checks activation_proc
  engage: nil,

  activation_proc: proc { false },
}.freeze
INIT_KEYS = 
[:sanitized_to, :sanitized_cc, :sanitized_bcc, :good_list, :bad_list].freeze

Class Attribute Summary collapse

Class Method Summary collapse

Methods included from Deprecation

deprecated, deprecated_alias, deprecation, deprecation_warning_message

Class Attribute Details

.config ⇒ Object

Returns the value of attribute config.



13
14
15
 
# File 'lib/sanitize_email/config.rb', line 13

def config
  @config
end

Class Method Details

.config_force_sanitize_deprecation_warning ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/sanitize_email/config.rb', line 85

def self.config_force_sanitize_deprecation_warning
  return if @config[:force_sanitize].nil?
  deprecation_warning_message(
    <<-DEPRECATION,
          SanitizeEmail::Config.config[:force_sanitize] is deprecated.
          Please use SanitizeEmail.force_sanitize or SanitizeEmail.sanitary instead.
          Refer to https://github.com/pboling/sanitize_email/wiki for examples.
  DEPRECATION
  )
  SanitizeEmail.force_sanitize = @config[:force_sanitize]
end

.configure {|@config| ... } ⇒ Object

Yields:



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/sanitize_email/config.rb', line 64

def self.configure
  yield @config

  # Gracefully handle deprecated config values.
  # Actual deprecation warnings are thrown in the top SanitizeEmail module
  #   thanks to our use of dynamic methods.
  if @config[:local_environments] && defined?(Rails)
    @config[:activation_proc] = proc do
      SanitizeEmail.local_environments.include?(Rails.env)
    end
  end
  if @config[:sanitized_recipients]
    # calling it to trigger the deprecation warning.
    # Won't actually be set with any value,
    # because we are still inside the configure block.
    SanitizeEmail.sanitized_recipients
    @config[:sanitized_to] = @config[:sanitized_recipients]
  end
  config_force_sanitize_deprecation_warning
end

.to_init ⇒ Object 



98
99
100
 
# File 'lib/sanitize_email/config.rb', line 98

def self.to_init
  @config.select { |key, _value| INIT_KEYS.include?(key) }
end