-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
[Mailer] Fixed and clarified custom Content-ID feature documentation #19946
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Hey! Oh no, it looks like you have made this PR towards a branch that is not maintained anymore. :/ Cheers! Carsonbot |
Okay, so I changed the base to 6.4 as 6.3 is no longer maintained. |
There's no need for more than one PR. We always merge lower branches up into all maintained branches so that each change will eventually land in all still maintained doc versions. |
@@ -658,16 +658,18 @@ images inside the HTML contents:: | |||
->html('... <div background="cid:footer-signature"> ... </div> ...') |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we replace the ID in this code example too?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That cid relates to the filename prop of the DataPart and symfony will replace it with a generated hash in the source. The example is correct.
Andrej, thanks a congrats on your first Symfony Docs contribution 🎉 |
The documentation is incorrect, as it shows calls to
DataPart::setContentId
with strings that are rejected by the method's implementation, because they do not contain a required@
character.I also added a sentence clarifying that the actual Content-ID value will be ramdom-generated by Symfony when not using a custom Content-ID.
This feature has been added in
v6.3
(according to the documentation) and the documentation is incorrect throughout versions6.3
,6.4
,7.0
,7.1
and7.2
.I'm not sure how to distribute this PR to all other branches - should I create separate PRs for each?