Skip to content

Commit

Permalink
📝 Fix documentation formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
@pboling
pboling committed Nov 9, 2024
1 parent 745652c commit cb46d97
Showing 1 changed file with 14 additions and 15 deletions.
29 changes: 14 additions & 15 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -375,8 +375,7 @@ Regardless of the Config settings of SanitizeEmail you can do a local override t
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({sanitized_to: "[email protected]"}) do # these config options are merged with the globals
SanitizeEmail.sanitary(sanitized_to: "[email protected]") do # these config options are merged with the globals
Mail.deliver do
from "[email protected]"
to "[email protected]" # Will actually be sent to the override addresses, in this case: [email protected]
Expand All @@ -390,19 +389,19 @@ You have access to all the same configuration options in the parameter hash as y
As used in the "Description" column below, `engaged` means: `SanitizeEmail.activate?(message) # => true`.
This happens in a few different ways, and two of them are in the config below (`engage` and `activation_proc`).

| Option | Type (Yard format) | Description |
|---------------------------------------------|--------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|
| sanitized_to | [String, Array[String]] | (when engaged) Override CC field with these addresses |
| sanitized_cc | [String, Array[String]] | (when engaged) Override CC field with these addresses |
| sanitized_bcc | [String, Array[String]] | (when engaged) Override BCC field with these addresses |
| good_list | [Array[String]] | (when engaged) Email addresses to allow to pass-through without overriding |
| bad_list | [Array[String]] | (when engaged) Email addresses to be removed from message's TO, CC, & BCC |
| environment | [String, #to_s, Proc, Lambda, #call] | (when engaged) The environment value to use wherever it is added to message (e.g. in the subject line) |
| use_actual_email_as_sanitized_user_name | [Boolean] | (when engaged) Use "real" email address as username for sanitized email address (e.g. "real at example.com <[email protected]>") |
| use_actual_email_prepended_to_subject | [Boolean] | (when engaged) Use "real" email address prepended to subject (e.g. "real at example.com Original Subject") |
| use_actual_environment_prepended_to_subject | [Boolean] | (when engaged) Use `environment` prepended to subject (e.g. "{{ STAGING }} Original Subject") |
| engage | [Boolean, nil] | Boolean will turn engage or disengage this gem, while `nil` ignores this setting and instead checks `activation_proc` |
| activation_proc | [Proc, Lambda, #call] | When checked, due to `engage: nil`, the result will either engage or disengage this gem |
| Option | Type (Yard format) | Description |
|---------------------------------------------|--------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
| sanitized_to | [String, Array[String]] | (when engaged) Override CC field with these addresses |
| sanitized_cc | [String, Array[String]] | (when engaged) Override CC field with these addresses |
| sanitized_bcc | [String, Array[String]] | (when engaged) Override BCC field with these addresses |
| good_list | [Array[String]] | (when engaged) Email addresses to allow to pass-through without overriding |
| bad_list | [Array[String]] | (when engaged) Email addresses to be removed from message's TO, CC, & BCC |
| environment | [String, #to_s, Proc, Lambda, #call] | (when engaged) The environment value to use wherever it is added to message (e.g. in the subject line) |
| use_actual_email_as_sanitized_user_name | [Boolean] | (when engaged) Use "real" email address as username for sanitized email address (e.g. `"real at example.com <[email protected]>"`) |
| use_actual_email_prepended_to_subject | [Boolean] | (when engaged) Use "real" email address prepended to subject (e.g. `"real at example.com Original Subject"`) |
| use_actual_environment_prepended_to_subject | [Boolean] | (when engaged) Use `environment` prepended to subject (e.g. `"[[ STAGING ]] Original Subject"`) |
| engage | [Boolean, nil] | Boolean will turn engage or disengage this gem, while `nil` ignores this setting and instead checks `activation_proc` |
| activation_proc | [Proc, Lambda, #call] | When checked, due to `engage: nil`, the result will either engage or disengage this gem |

## Thread Safety

Expand Down

0 comments on commit cb46d97

Please sign in to comment.