improve docs

swoosh · Apr 9, 2024 · b6f1740 · b6f1740
1 parent 39ab591
commit b6f1740
Show file tree

Hide file tree

Showing 19 changed files with 50 additions and 50 deletions.
diff --git a/lib/swoosh/adapters/amazon_ses.ex b/lib/swoosh/adapters/amazon_ses.ex
@@ -19,7 +19,7 @@ defmodule Swoosh.Adapters.AmazonSES do
         ]
       end
 
-  **This adapter requires an API Client.** Swoosh comes with Hackney and Finch out of the box.
+  **This adapter requires an API Client.** Swoosh comes with Hackney, Finch and Req out of the box.
   See the [installation section](https://hexdocs.pm/swoosh/Swoosh.html#module-installation)
   for details.
 

diff --git a/lib/swoosh/adapters/brevo.ex b/lib/swoosh/adapters/brevo.ex
@@ -4,7 +4,7 @@ defmodule Swoosh.Adapters.Brevo do
 
   For reference: [Brevo API docs](https://developers.brevo.com/reference/sendtransacemail)
 
-  **This adapter requires an API Client.** Swoosh comes with Hackney and Finch out of the box.
+  **This adapter requires an API Client.** Swoosh comes with Hackney, Finch and Req out of the box.
   See the [installation section](https://hexdocs.pm/swoosh/Swoosh.html#module-installation)
   for details.
 

diff --git a/lib/swoosh/adapters/customer_io.ex b/lib/swoosh/adapters/customer_io.ex
@@ -4,7 +4,7 @@ defmodule Swoosh.Adapters.CustomerIO do
 
   For reference: [CustomerIO API docs](https://customer.io/docs/api/#tag/Transactional)
 
-  **This adapter requires an API Client.** Swoosh comes with Hackney and Finch out of the box.
+  **This adapter requires an API Client.** Swoosh comes with Hackney, Finch and Req out of the box.
   See the [installation section](https://hexdocs.pm/swoosh/Swoosh.html#module-installation)
   for details.
 

diff --git a/lib/swoosh/adapters/dyn.ex b/lib/swoosh/adapters/dyn.ex
@@ -4,7 +4,7 @@ defmodule Swoosh.Adapters.Dyn do
 
   For reference: [Dyn API docs](https://help.dyn.com/email-rest-methods-api/sending-api/)
 
-  **This adapter requires an API Client.** Swoosh comes with Hackney and Finch out of the box.
+  **This adapter requires an API Client.** Swoosh comes with Hackney, Finch and Req out of the box.
   See the [installation section](https://hexdocs.pm/swoosh/Swoosh.html#module-installation)
   for details.
 

diff --git a/lib/swoosh/adapters/ex_aws_amazon_ses.ex b/lib/swoosh/adapters/ex_aws_amazon_ses.ex
@@ -13,6 +13,23 @@ defmodule Swoosh.Adapters.ExAwsAmazonSES do
   [IAM Roles for EC2](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html)
   [IAM roles for ECS tasks](https://docs.aws.amazon.com/AmazonECS/latest/userguide/task-iam-roles.html)
 
+  > ### Dependencies {: .info}
+  >
+  > In addition to the `:gen_smtp` dependency that the `AmazonSES` adapter
+  > requires, this adapter also depends on `:ex_aws`.
+  >
+  > Ensure you have the dependencies added in your mix.exs file:
+  >
+  >     def deps do
+  >       [
+  >         {:swoosh, "~> 1.0"},
+  >         {:gen_smtp, "~> 1.0"},
+  >         {:ex_aws, "~> 2.1"},
+  >         # Dependency of `:ex_aws`
+  >         {:sweet_xml, "~> 0.6"}
+  >       ]
+  >     end
+
   ## Example
 
       # config/config.exs
@@ -29,23 +46,6 @@ defmodule Swoosh.Adapters.ExAwsAmazonSES do
         use Swoosh.Mailer, otp_app: :sample
       end
 
-  ## Dependencies
-
-  In addition to the `:gen_smtp` dependency that the `AmazonSES` adapter
-  requires, this adapter also depends on `:ex_aws`.
-
-  Ensure you have the dependencies added in your mix.exs file:
-
-      def deps do
-        [
-          {:swoosh, "~> 1.0"},
-          {:gen_smtp, "~> 1.0"},
-          {:ex_aws, "~> 2.1"},
-          # Dependency of `:ex_aws`
-          {:sweet_xml, "~> 0.6"}
-        ]
-      end
-
   See also:
 
   [Getting started with ExAws](https://hexdocs.pm/ex_aws/readme.html#getting-started)

diff --git a/lib/swoosh/adapters/gmail.ex b/lib/swoosh/adapters/gmail.ex
@@ -4,15 +4,15 @@ defmodule Swoosh.Adapters.Gmail do
 
   For reference: [Gmail API docs](https://developers.google.com/gmail/api)
 
-  **This adapter requires an API Client.** Swoosh comes with Hackney and Finch out of the box.
+  **This adapter requires an API Client.** Swoosh comes with Hackney, Finch and Req out of the box.
   See the [installation section](https://hexdocs.pm/swoosh/Swoosh.html#module-installation)
   for details.
 
-  ## Dependency
-
-  Gmail adapter requires `Mail` dependency to format message as RFC 2822 message.
-
-      {:mail, ">= 0.0.0"}
+  > ### Dependency {: .info}
+  >
+  > Gmail adapter requires `Mail` dependency to format message as RFC 2822 message.
+  >
+  >     {:mail, ">= 0.0.0"}
 
   Because `Mail` library removes Bcc headers, they are being added after email is
   rendered, in adapter code.

diff --git a/lib/swoosh/adapters/mail_pace.ex b/lib/swoosh/adapters/mail_pace.ex
@@ -5,7 +5,7 @@ defmodule Swoosh.Adapters.MailPace do
 
   For reference: [MailPace API docs](https://docs.mailpace.com/reference/overview/)
 
-  **This adapter requires an API Client.** Swoosh comes with Hackney and Finch out of the box.
+  **This adapter requires an API Client.** Swoosh comes with Hackney, Finch and Req out of the box.
   See the [installation section](https://hexdocs.pm/swoosh/Swoosh.html#module-installation)
   for details.
 

diff --git a/lib/swoosh/adapters/mailgun.ex b/lib/swoosh/adapters/mailgun.ex
@@ -4,13 +4,13 @@ defmodule Swoosh.Adapters.Mailgun do
 
   For reference: [Mailgun API docs](https://documentation.mailgun.com/en/latest/api-sending.html#sending)
 
-  **This adapter requires an API Client.** Swoosh comes with Hackney and Finch out of the box.
+  **This adapter requires an API Client.** Swoosh comes with Hackney, Finch and Req out of the box.
   See the [installation section](https://hexdocs.pm/swoosh/Swoosh.html#module-installation)
   for details.
 
-  ## Dependency
-
-  Mailgun adapter requires `Plug` and [`:multipart`](https://hex.pm/packages/multipart) to work properly.
+  > ### Dependency {: .info}
+  >
+  > Mailgun adapter requires `Plug` and [`:multipart`](https://hex.pm/packages/multipart) to work properly.
 
   ## Configuration options
 

diff --git a/lib/swoosh/adapters/mailjet.ex b/lib/swoosh/adapters/mailjet.ex
@@ -4,13 +4,13 @@ defmodule Swoosh.Adapters.Mailjet do
 
   For reference: [Mailjet API docs](https://dev.mailjet.com/guides/#send-api-v3-1)
 
-  **This adapter requires an API Client.** Swoosh comes with Hackney and Finch out of the box.
+  **This adapter requires an API Client.** Swoosh comes with Hackney, Finch and Req out of the box.
   See the [installation section](https://hexdocs.pm/swoosh/Swoosh.html#module-installation)
   for details.
 
-  ## Dependency
-
-  Mailjet adapter requires `Plug` to work properly.
+  > ### Dependency {: .info}
+  >
+  > Mailjet adapter requires `Plug` to work properly.
 
   ## Example
 

diff --git a/lib/swoosh/adapters/mailtrap.ex b/lib/swoosh/adapters/mailtrap.ex
@@ -9,7 +9,7 @@ defmodule Swoosh.Adapters.Mailtrap do
 
   For reference: [Mailtrap API docs](https://api-docs.mailtrap.io/docs/mailtrap-api-docs/67f1d70aeb62c-send-email)
 
-  **This adapter requires an API Client.** Swoosh comes with Hackney and Finch out of the box.
+  **This adapter requires an API Client.** Swoosh comes with Hackney, Finch and Req out of the box.
   See the [installation section](https://hexdocs.pm/swoosh/Swoosh.html#module-installation)
   for details.
 

diff --git a/lib/swoosh/adapters/mandrill.ex b/lib/swoosh/adapters/mandrill.ex
@@ -8,7 +8,7 @@ defmodule Swoosh.Adapters.Mandrill do
 
   For reference: [Mandrill API docs](https://mandrillapp.com/api/docs/messages.html)
 
-  **This adapter requires an API Client.** Swoosh comes with Hackney and Finch out of the box.
+  **This adapter requires an API Client.** Swoosh comes with Hackney, Finch and Req out of the box.
   See the [installation section](https://hexdocs.pm/swoosh/Swoosh.html#module-installation)
   for details.
 

diff --git a/lib/swoosh/adapters/ms_graph.ex b/lib/swoosh/adapters/ms_graph.ex
@@ -4,14 +4,14 @@ defmodule Swoosh.Adapters.MsGraph do
 
   For reference: [Microsoft Graph API docs](https://learn.microsoft.com/en-us/graph/api/user-sendmail)
 
-  **This adapter requires an API Client.** Swoosh comes with Hackney and Finch out of the box.
+  **This adapter requires an API Client.** Swoosh comes with Hackney, Finch and Req out of the box.
   See the [installation section](https://hexdocs.pm/swoosh/Swoosh.html#module-installation)
   for details.
 
-  ## Dependency
-
-  Microsoft Graph adapter requires `:gen_smtp` to work properly.
-  `:gen_smtp` is only used to encode the email body to MIME format.
+  > ### Dependency {: .info}
+  >
+  > Microsoft Graph adapter requires `:gen_smtp` to work properly.
+  > `:gen_smtp` is only used to encode the email body to MIME format.
 
   ## Configuration options
 

diff --git a/lib/swoosh/adapters/oh_my_smtp.ex b/lib/swoosh/adapters/oh_my_smtp.ex
@@ -10,7 +10,7 @@ defmodule Swoosh.Adapters.OhMySmtp do
 
   For reference: [OhMySMTP API docs](https://docs.ohmysmtp.com/reference/overview)
 
-  **This adapter requires an API Client.** Swoosh comes with Hackney and Finch out of the box.
+  **This adapter requires an API Client.** Swoosh comes with Hackney, Finch and Req out of the box.
   See the [installation section](https://hexdocs.pm/swoosh/Swoosh.html#module-installation)
   for details.
 

diff --git a/lib/swoosh/adapters/scaleway.ex b/lib/swoosh/adapters/scaleway.ex
@@ -4,7 +4,7 @@ defmodule Swoosh.Adapters.Scaleway do
 
   For reference: [Scaleway API docs](https://www.scaleway.com/en/developers/api/transactional-email/#path-emails-send-an-email)
 
-  **This adapter requires an API Client.** Swoosh comes with Hackney and Finch out of the box.
+  **This adapter requires an API Client.** Swoosh comes with Hackney, Finch and Req out of the box.
   See the [installation section](https://hexdocs.pm/swoosh/Swoosh.html#module-installation)
   for details.
 

diff --git a/lib/swoosh/adapters/sendgrid.ex b/lib/swoosh/adapters/sendgrid.ex
@@ -20,7 +20,7 @@ defmodule Swoosh.Adapters.Sendgrid do
 
   For reference: [Sendgrid API docs](https://sendgrid.com/docs/API_Reference/Web_API_v3/Mail/index.html)
 
-  **This adapter requires an API Client.** Swoosh comes with Hackney and Finch out of the box.
+  **This adapter requires an API Client.** Swoosh comes with Hackney, Finch and Req out of the box.
   See the [installation section](https://hexdocs.pm/swoosh/Swoosh.html#module-installation)
   for details.
 

diff --git a/lib/swoosh/adapters/sendinblue.ex b/lib/swoosh/adapters/sendinblue.ex
@@ -7,7 +7,7 @@ defmodule Swoosh.Adapters.Sendinblue do
 
   An adapter that sends email using the Sendinblue API (Transactional emails only).
   For reference: [Sendinblue API docs](https://developers.sendinblue.com/reference/sendtransacemail)
-  **This adapter requires an API Client.** Swoosh comes with Hackney and Finch out of the box.
+  **This adapter requires an API Client.** Swoosh comes with Hackney, Finch and Req out of the box.
   See the [installation section](https://hexdocs.pm/swoosh/Swoosh.html#module-installation)
   for details.
 

diff --git a/lib/swoosh/adapters/smtp2go.ex b/lib/swoosh/adapters/smtp2go.ex
@@ -4,7 +4,7 @@ defmodule Swoosh.Adapters.SMTP2GO do
 
   For reference: [SMTP2GO API docs](https://apidoc.smtp2go.com/documentation/#/POST%20/email/send)
 
-  **This adapter requires an API Client.** Swoosh comes with Hackney and Finch out of the box.
+  **This adapter requires an API Client.** Swoosh comes with Hackney, Finch and Req out of the box.
   See the [installation section](https://hexdocs.pm/swoosh/Swoosh.html#module-installation)
   for details.
 

diff --git a/lib/swoosh/adapters/socket_labs.ex b/lib/swoosh/adapters/socket_labs.ex
@@ -4,7 +4,7 @@ defmodule Swoosh.Adapters.SocketLabs do
 
   For reference: [SocketLabs API docs](https://inject.docs.socketlabs.com/v1/documentation/introduction)
 
-  **This adapter requires an API Client.** Swoosh comes with Hackney and Finch out of the box.
+  **This adapter requires an API Client.** Swoosh comes with Hackney, Finch and Req out of the box.
   See the [installation section](https://hexdocs.pm/swoosh/Swoosh.html#module-installation)
   for details.
 

diff --git a/lib/swoosh/adapters/sparkpost.ex b/lib/swoosh/adapters/sparkpost.ex
@@ -4,7 +4,7 @@ defmodule Swoosh.Adapters.SparkPost do
 
   For reference: [SparkPost API docs](https://developers.sparkpost.com/api/)
 
-  **This adapter requires an API Client.** Swoosh comes with Hackney and Finch out of the box.
+  **This adapter requires an API Client.** Swoosh comes with Hackney, Finch and Req out of the box.
   See the [installation section](https://hexdocs.pm/swoosh/Swoosh.html#module-installation)
   for details.