Module: SanitizeEmail
- Extended by:
- Deprecation
- Defined in:
- lib/sanitize_email/bleach.rb,
lib/sanitize_email.rb,
lib/sanitize_email/config.rb,
lib/sanitize_email/engine.rb,
lib/sanitize_email/railtie.rb,
lib/sanitize_email/version.rb,
lib/sanitize_email/deprecation.rb,
lib/sanitize_email/test_helpers.rb,
lib/sanitize_email/rspec_matchers.rb,
lib/sanitize_email/mail_header_tools.rb,
lib/sanitize_email/overridden_addresses.rb
Overview
Copyright © 2008 - 2018, 2020, 2022, 2024 Peter H. Boling of RailsBling.com Released under the MIT license
Defined Under Namespace
Modules: Deprecation, MailExt, MailHeaderTools, RspecMatchers, TestHelpers, Version Classes: Bleach, Config, Engine, MissingBlockParameter, OverriddenAddresses, Railtie
Class Attribute Summary collapse
-
.force_sanitize ⇒ Object
Returns the value of attribute force_sanitize.
Class Method Summary collapse
- .[](key) ⇒ Object
- .activate?(message) ⇒ Boolean
- .janitor(options) ⇒ Object
-
.local_environments ⇒ Object
NOTE: Deprecated method We have to actually define because we can’t deprecate methods that are hooked up via method_missing.
- .method_missing(name, *_args) ⇒ Object
-
.sanitary(config_options = {}) ⇒ Object
Regardless of the Config settings of SanitizeEmail you can do a local override to send sanitary email in any environment.
-
.sanitized_recipients ⇒ Object
NOTE: Deprecated method We have to actually define because we can’t deprecate methods that are hooked up via method_missing.
-
.unsanitary ⇒ Object
Regardless of the Config settings of SanitizeEmail you can do a local override to force unsanitary email in any environment.
Methods included from Deprecation
deprecated, deprecated_alias, deprecation, deprecation_warning_message
Class Attribute Details
.force_sanitize ⇒ Object
Returns the value of attribute force_sanitize.
72 73 74 |
# File 'lib/sanitize_email.rb', line 72 def force_sanitize @force_sanitize end |
Class Method Details
.[](key) ⇒ Object
45 46 47 48 |
# File 'lib/sanitize_email.rb', line 45 def self.[](key) return unless key.respond_to?(:to_sym) SanitizeEmail::Config.config[key.to_sym] end |
.activate?(message) ⇒ Boolean
66 67 68 69 |
# File 'lib/sanitize_email.rb', line 66 def self.activate?() proc = SanitizeEmail::Config.config[:activation_proc] proc.call() if proc.respond_to?(:call) end |
.janitor(options) ⇒ Object
120 121 122 123 124 125 126 |
# File 'lib/sanitize_email.rb', line 120 def self.janitor() raise MissingBlockParameter, "SanitizeEmail.janitor must be called with a block" unless block_given? original = SanitizeEmail.force_sanitize SanitizeEmail.force_sanitize = [:forcing] yield SanitizeEmail.force_sanitize = original end |
.local_environments ⇒ Object
NOTE: Deprecated method We have to actually define because we can’t deprecate methods that are hooked up via method_missing
62 63 64 |
# File 'lib/sanitize_email.rb', line 62 def self.local_environments SanitizeEmail::Config.config[:local_environments] end |
.method_missing(name, *_args) ⇒ Object
50 51 52 |
# File 'lib/sanitize_email.rb', line 50 def self.method_missing(name, *_args) SanitizeEmail[name] end |
.sanitary(config_options = {}) ⇒ Object
Regardless of the Config settings of SanitizeEmail you can do a local override to send sanitary email in any environment. You have access to all the same configuration options in the parameter hash as you can set in the actual SanitizeEmail.configure block.
SanitizeEmail.sanitary(=> “[email protected]”) do
Mail.deliver do
from "[email protected]"
# Will actually be sent to the override addresses, not this one:
to "[email protected]"
reply_to "[email protected]"
subject "subject"
end
end
91 92 93 94 95 96 97 98 99 |
# File 'lib/sanitize_email.rb', line 91 def self.sanitary( = {}) raise MissingBlockParameter, "SanitizeEmail.sanitary must be called with a block" unless block_given? janitor(forcing: true) do original = SanitizeEmail::Config.config.dup SanitizeEmail::Config.config.merge!() yield SanitizeEmail::Config.config = original end end |
.sanitized_recipients ⇒ Object
NOTE: Deprecated method We have to actually define because we can’t deprecate methods that are hooked up via method_missing
56 57 58 |
# File 'lib/sanitize_email.rb', line 56 def self.sanitized_recipients SanitizeEmail::Config.config[:sanitized_recipients] end |
.unsanitary ⇒ Object
Regardless of the Config settings of SanitizeEmail you can do a local override to force unsanitary email in any environment.
SanitizeEmail.unsanitary do
Mail.deliver do
from "[email protected]"
to "[email protected]"
reply_to "[email protected]"
subject "subject"
end
end
113 114 115 116 117 118 |
# File 'lib/sanitize_email.rb', line 113 def self.unsanitary raise MissingBlockParameter, "SanitizeEmail.unsanitary must be called with a block" unless block_given? janitor(forcing: false) do yield end end |