[actions] improve email action doc #90020
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
resolves elastic#88333 Fixed: - add note that `secure: false` will use TLS, but after an initial connection with TCP; we have been getting questions from customers who believed that `secure: false` implied TLS was not used at all. - added a link to the nodemailer "well-known services" module, to allow customers to see examples of other email service configurations - updated the Outlook config example to use the current nodemailer values - couple of other small tweaks
Member
Author
pmuellr
added
Feature:Alerting
Team:ResponseOps
Contributor
|
Pinging @elastic/kibana-alerting-services (Team:Alerting Services) |
Member
Author
|
could you wordsmith the changes, @gchaps ? |
gchaps
reviewed
Feb 2, 2021
| 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. See 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. |
Contributor
There was a problem hiding this comment.
Suggested change
| 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. If not true, the connection will initially connect over TCP, then attempt to switch to TLS via the SMTP STARTTLS command. | |
| 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. |
| * <<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 - `host`, `port`, and `secure` - correspond to the same email action configuration properties. A missing `secure` property in the "well-known/services.json" file is considered `false`. Generally, `port: 465` uses `secure: true`, and `port: 25` and `port: 587` use `secure: false`. |
Contributor
There was a problem hiding this comment.
Suggested change
| 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 - `host`, `port`, and `secure` - correspond to the same email action configuration properties. A missing `secure` property in the "well-known/services.json" file is considered `false`. Generally, `port: 465` uses `secure: true`, and `port: 25` and `port: 587` use `secure: false`. | |
| 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—`host`, `port`, and `secure`—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`. |
Contributor
|
Pinging @elastic/kibana-docs (Team:Docs) |
Member
Author
|
@elasticmachine merge upstream |
gchaps
approved these changes
Feb 5, 2021
Contributor
gchaps
left a comment
gchaps
left a comment
There was a problem hiding this comment.
One minor comment:
add a comma after "If true"
If true, the connection will use TLS...
pmuellr
added a commit
to pmuellr/kibana
that referenced
this pull request
Feb 8, 2021
resolves elastic#88333 Fixed: - add note that `secure: false` will use TLS, but after an initial connection with TCP; we have been getting questions from customers who believed that `secure: false` implied TLS was not used at all. - added a link to the nodemailer "well-known services" module, to allow customers to see examples of other email service configurations - updated the Outlook config example to use the current nodemailer values - couple of other small tweaks
pmuellr
added a commit
that referenced
this pull request
Feb 8, 2021
resolves #88333 Fixed: - add note that `secure: false` will use TLS, but after an initial connection with TCP; we have been getting questions from customers who believed that `secure: false` implied TLS was not used at all. - added a link to the nodemailer "well-known services" module, to allow customers to see examples of other email service configurations - updated the Outlook config example to use the current nodemailer values - couple of other small tweaks
gmmorris
added a commit
to gmmorris/kibana
that referenced
this pull request
Feb 8, 2021
* master: (55 commits) [APM-UI][E2E] use githubNotify step (elastic#90514) [APM] Export ProcessorEvent type (elastic#90540) [Lens] Retain column config (elastic#90048) [Data Table] Add unit tests (elastic#90173) Migrate most plugins to synchronous lifecycle (elastic#89562) skip flaky suite (elastic#90555) skip flaky suite (elastic#64473) [actions] improve email action doc (elastic#90020) [Fleet] Support Fleet server system indices (elastic#89372) skip flaky suite (elastic#90552) Bump immer dependencies (elastic#90267) Unrevert "Migrations v2: don't auto-create indices + FTR/esArchiver support (elastic#85778)" (elastic#89992) [Search Sessions] Use sync config (elastic#90138) chore(NA): add safe guard to remove bazelisk from yarn global at bootstrap (elastic#90538) [test] Await retry.waitFor (elastic#90456) chore(NA): integrate build buddy with our bazel setup and remote cache for ci (elastic#90116) Skip failing suite (elastic#90526) [Fleet] Fix incorrect conversion of string to numeric values in agent YAML (elastic#90371) [Docs] Update reporting troubleshooting for arm rhel/centos (elastic#90385) chore(NA): build bazel projects all at once in the distributable build process (elastic#90328) ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
resolves #88333
Fixed:
add note that
secure: falsewill use TLS, but after an initial connectionwith TCP; we have been getting questions from customers who believed that
secure: falseimplied TLS was not used at all.added a link to the nodemailer "well-known services" module, to allow
customers to see examples of other email service configurations
updated the Outlook config example to use the current nodemailer values
couple of other small tweaks