From fa8f5b191bf11cd1c8e29f56fea743855d597e54 Mon Sep 17 00:00:00 2001
From: Alexander Hofbauer <a.hofbauer@fify.at>
Date: Thu, 17 Apr 2025 09:15:22 +0200
Subject: [PATCH] [Mailer] Document email.image name parameter

---
 mailer.rst | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/mailer.rst b/mailer.rst
index a6b5eb819d8..034f9bdfe97 100644
--- a/mailer.rst
+++ b/mailer.rst
@@ -1093,6 +1093,14 @@ the email contents:
     <h1>Welcome {{ email.toName }}!</h1>
     {# ... #}
 
+By default this will create an attachment using the file path as filename:
+``Content-Disposition: inline; name="cid..."; filename="@images/logo.png"``.
+This behavior can be overridden by passing a name (the third argument):
+
+.. code-block:: html+twig
+
+    <img src="{{ email.image('@images/logo.png', name: 'my-logo.png') }}" alt="My Logo">
+
 .. _mailer-inline-css:
 
 Inlining CSS Styles