feat: sendgrid support for content_id (#691)

* Add support for content_id in SendgridAdapter Introduces support for content_id so that inline images in e-mails can be send and referenced from HTML content of the e-mail * refactor: remove negated is_nil to satisfy credo --------- Co-authored-by: Hubert Łępicki <[email protected]>
beam-community · Jan 16, 2025 · 7a878f4 · 7a878f4
1 parent 66782dc
commit 7a878f4
Show file tree

Hide file tree

Showing 2 changed files with 60 additions and 6 deletions.
diff --git a/lib/bamboo/adapters/send_grid_adapter.ex b/lib/bamboo/adapters/send_grid_adapter.ex
@@ -397,16 +397,34 @@ defmodule Bamboo.SendGridAdapter do
       attachments
       |> Enum.reverse()
       |> Enum.map(fn attachment ->
-        %{
-          filename: attachment.filename,
-          type: attachment.content_type,
-          content: Base.encode64(attachment.data)
-        }
+        maybe_append_content_id(
+          %{
+            filename: attachment.filename,
+            type: attachment.content_type,
+            content: Base.encode64(attachment.data),
+            disposition: attachment_disposition(attachment)
+          },
+          attachment
+        )
       end)
 
     Map.put(body, :attachments, transformed)
   end
 
+  defp maybe_append_content_id(map, %{content_id: nil}) do
+    map
+  end
+
+  defp maybe_append_content_id(map, %{content_id: content_id}) do
+    Map.put(map, :content_id, content_id)
+  end
+
+  defp attachment_disposition(%Bamboo.Attachment{content_id: cid}) when is_binary(cid) do
+    "inline"
+  end
+
+  defp attachment_disposition(_), do: "attachment"
+
   defp put_addresses(body, _, []), do: body
 
   defp put_addresses(body, field, addresses),

diff --git a/test/lib/bamboo/adapters/send_grid_adapter_test.exs b/test/lib/bamboo/adapters/send_grid_adapter_test.exs
@@ -161,7 +161,43 @@ defmodule Bamboo.SendGridAdapterTest do
              %{
                "type" => "text/plain",
                "filename" => "attachment.txt",
-               "content" => "VGVzdCBBdHRhY2htZW50Cg=="
+               "content" => "VGVzdCBBdHRhY2htZW50Cg==",
+               "disposition" => "attachment"
+             }
+           ]
+  end
+
+  test "deliver/2 sends from, html and text body, subject, headers and inline attachment" do
+    email =
+      [
+        from: {"From", "[email protected]"},
+        subject: "My Subject",
+        text_body: "TEXT BODY",
+        html_body: "HTML BODY <img src='cid:myimg' />"
+      ]
+      |> new_email()
+      |> Email.put_header("Reply-To", "[email protected]")
+      |> Email.put_attachment(Path.join(__DIR__, "../../../support/attachment.txt"), content_id: "myimg")
+
+    SendGridAdapter.deliver(email, @config)
+
+    assert SendGridAdapter.supports_attachments?()
+    assert_receive {:fake_sendgrid, %{params: params, req_headers: headers}}
+
+    assert params["from"]["name"] == elem(email.from, 0)
+    assert params["from"]["email"] == elem(email.from, 1)
+    assert params["subject"] == email.subject
+    assert Enum.member?(params["content"], %{"type" => "text/plain", "value" => email.text_body})
+    assert Enum.member?(params["content"], %{"type" => "text/html", "value" => email.html_body})
+    assert Enum.member?(headers, {"authorization", "Bearer #{@config[:api_key]}"})
+
+    assert params["attachments"] == [
+             %{
+               "type" => "text/plain",
+               "filename" => "attachment.txt",
+               "content" => "VGVzdCBBdHRhY2htZW50Cg==",
+               "disposition" => "inline",
+               "content_id" => "myimg"
              }
            ]
   end