From 131b3cb7fa61f5eaccc4ab41acd8f24de1c0e4e9 Mon Sep 17 00:00:00 2001 From: Vincent Date: Thu, 24 Aug 2023 13:39:19 +0200 Subject: [PATCH] chore: apply suggestions from code review --- docs/kratos/emails-sms/01_sending-emails-smtp.mdx | 10 +++++----- docs/kratos/self-hosted/03_mail-courier-http.mdx | 4 ++-- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/kratos/emails-sms/01_sending-emails-smtp.mdx b/docs/kratos/emails-sms/01_sending-emails-smtp.mdx index 753ce0450..7e503ee78 100644 --- a/docs/kratos/emails-sms/01_sending-emails-smtp.mdx +++ b/docs/kratos/emails-sms/01_sending-emails-smtp.mdx @@ -142,7 +142,7 @@ smtp://{YOUR_POSTMARK_SEVER_API_TOKEN}:{YOUR_POSTMARK_SEVER_API_TOKEN}@smtp.post ## Send emails using an HTTP server Ory Identities supports sending emails using an HTTP server. This is useful if you want to customize the email content or use a -service that does not provide an SMTP server. +service that doesn't provide an SMTP server. ```mdx-code-block @@ -171,7 +171,7 @@ service that does not provide an SMTP server. body: base64://... # See below for the default payload and available variables headers: Content-Type: application/json - auth: # leave out, if your server does not require authentication, but note that we do not recommend that + auth: # leave out, if your server doesn't require authentication, but note that we don't recommend that type: basic_auth # or api_key config: username: my-username @@ -190,7 +190,7 @@ service that does not provide an SMTP server. ### Payload -The payload of the HTTP request is a JSON object that is generated using a Jsonnet template. By default, the following payload is +The payload of the HTTP request is a JSON object that's generated using a Jsonnet template. By default, the following payload is sent: ```jsonnet @@ -211,14 +211,14 @@ The courier passes the `Recipient`, `TemplateType`, and `TemplateData` variables available through the `ctx` object. `Recipient` will always be the email address of the user. `TemplateType` and the fields in `TemplateData` are linked in the following way with each template type containing the fields listed below: -This will produce a JSON object, that contains all data, that is available in the email. You can customize the payload +This will produce a JSON object, that contains all data available in the email. You can customize the payload ```mdx-code-block ``` -The Ory Console does not support configuring this yet. Please use the Ory CLI instead. +The Ory Console doesn't support configuring this yet. Please use the Ory CLI instead. ```mdx-code-block diff --git a/docs/kratos/self-hosted/03_mail-courier-http.mdx b/docs/kratos/self-hosted/03_mail-courier-http.mdx index b3913db61..13c80eb8f 100644 --- a/docs/kratos/self-hosted/03_mail-courier-http.mdx +++ b/docs/kratos/self-hosted/03_mail-courier-http.mdx @@ -4,13 +4,13 @@ title: HTTP based email delivery sidebar_label: Sending emails via HTTP API --- -For sending emails by using an external mail provider instead of a local SMTP server, Ory Kratos can use an HTTP API (such as +To send emails using an external mail provider instead of a local SMTP server, Ory Kratos can use an HTTP API (such as Mailchimp, your local mail sender, or your own microservice). Request method, headers, body, and content-type are fully configurable using the options below. ## Configuration -By default, Ory Kratos doesn't use API calls to send mail. To enable it please set the `delivery_strategy` configuration key to +By default, Ory Kratos doesn't use API calls to send mail. To enable it set the `delivery_strategy` configuration key to `http`, URL, authorization (if needed) and request body format. ### Request configuration