Skip to content

Commit 3bdf71e

Browse files
committed
Documentation updates
1 parent 4f11f6c commit 3bdf71e

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

docs/reference/settings/notification-settings.asciidoc

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,17 @@ If you configure multiple email accounts, you must either configure this setting
118118
or specify the email account to use in the <<actions-email,`email`>> action. See
119119
<<configuring-email>>.
120120

121+
`xpack.notification.email.recipient_allowlist`::
122+
(<<dynamic-cluster-setting,Dynamic>>)
123+
Specifies addresses to which emails are allowed to be sent.
124+
Emails with recipients (`To:`, `Cc:`, or `Bcc:`) outside of these patterns will be rejected and an
125+
error thrown. This setting defaults to `["*"]` which means all recipients are allowed.
126+
Simple globbing is supported, such as `list-*@company.com` in the list of allowed recipients.
127+
128+
NOTE: This setting can't be used at the same time as `xpack.notification.email.account.domain_allowlist`
129+
and an error will be thrown if both are set at the same time. This setting can be used to specify domains
130+
to allow by using a wildcard pattern such as `*@*.company.com`.
131+
121132
`xpack.notification.email.account`::
122133
Specifies account information for sending notifications via email. You
123134
can specify the following email account attributes:
@@ -129,6 +140,10 @@ Specifies domains to which emails are allowed to be sent. Emails with recipients
129140
`Bcc:`) outside of these domains will be rejected and an error thrown. This setting defaults to
130141
`["*"]` which means all domains are allowed. Simple globbing is supported, such as `*.company.com`
131142
in the list of allowed domains.
143+
144+
NOTE: This setting can't be used at the same time as `xpack.notification.email.recipient_allowlist`
145+
and an error will be thrown if both are set at the same time.
146+
132147
--
133148
[[email-account-attributes]]
134149

0 commit comments

Comments
 (0)