Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[actions] improve email action doc #90020

Merged
merged 5 commits into from
Feb 8, 2021
Merged

[actions] improve email action doc #90020

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0b70501
[actions] improve email action doc
pmuellr Feb 2, 2021
523ad9c
add a bit more on the smtp port / secure combinations
pmuellr Feb 2, 2021
6dcff08
fixes from PR review
pmuellr Feb 5, 2021
97ecf6c
Merge branch 'master' into actions/improve-email-doc
kibanamachine Feb 5, 2021
932be43
more fixes from PR review
pmuellr Feb 5, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions docs/user/alerting/action-types/email.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Name:: The name of the connector. The name is used to identify a connector
Sender:: The from address for all emails sent with this connector, specified in `user@host-name` format.
Host:: Host name of the service provider. If you are using the <<action-settings, `xpack.actions.allowedHosts`>> setting, make sure this hostname is added to the allowed hosts.
Port:: The port to connect to on the service provider.
Secure:: If true the connection will use TLS when connecting to the service provider. See https://nodemailer.com/smtp/#tls-options[nodemailer TLS documentation] for more information.
Secure:: If true, the connection will use TLS when connecting to the service provider. Refer to the https://nodemailer.com/smtp/#tls-options[Nodemailer TLS documentation] for more information. If not true, the connection will initially connect over TCP, then attempt to switch to TLS via the SMTP STARTTLS command.
Username:: username for 'login' type authentication.
Password:: password for 'login' type authentication.

Expand Down Expand Up @@ -92,6 +92,8 @@ systems, refer to:
* <<exchange>>
* <<amazon-ses>>

For other email servers, you can check the list of well-known services that Nodemailer supports in the JSON file https://github.com/nodemailer/nodemailer/blob/master/lib/well-known/services.json[well-known/services.json]. The properties of the objects in those files &mdash; `host`, `port`, and `secure` &mdash; correspond to the same email action configuration properties. A missing `secure` property in the "well-known/services.json" file is considered `false`. Typically, `port: 465` uses `secure: true`, and `port: 25` and `port: 587` use `secure: false`.

[float]
[[gmail]]
===== Sending email from Gmail
Expand All @@ -109,7 +111,6 @@ https://mail.google.com[Gmail] SMTP service:
user: <username>
password: <password>
--------------------------------------------------
// CONSOLE

If you get an authentication error that indicates that you need to continue the
sign-in process from a web browser when the action attempts to send email, you need
Expand All @@ -131,9 +132,9 @@ https://www.outlook.com/[Outlook.com] SMTP service:
[source,text]
--------------------------------------------------
config:
host: smtp-mail.outlook.com
port: 465
secure: true
host: smtp.office365.com
port: 587
secure: false
secrets:
user: <email.address>
password: <password>
Expand Down Expand Up @@ -163,7 +164,7 @@ secrets:
user: <username>
password: <password>
--------------------------------------------------
<1> `smtp.host` varies depending on the region
<1> `config.host` varies depending on the region

NOTE: You must use your Amazon SES SMTP credentials to send email through
Amazon SES. For more information, see
Expand Down