Skip to content

[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

Merged
merged 1 commit into from
Jun 10, 2024
Merged

Conversation

dakujem
Copy link
Contributor

@dakujem dakujem commented Jun 7, 2024

Addresses symfony/symfony #54162

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.

image

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 versions 6.3, 6.4, 7.0, 7.1 and 7.2.
I'm not sure how to distribute this PR to all other branches - should I create separate PRs for each?

@carsonbot
Copy link
Collaborator

Hey!

Oh no, it looks like you have made this PR towards a branch that is not maintained anymore. :/
Could you update the PR base branch to target one of these branches instead? 5.4, 6.4, 7.0, 7.1, 7.2.

Cheers!

Carsonbot

@carsonbot carsonbot added this to the 6.3 milestone Jun 7, 2024
@dakujem dakujem changed the base branch from 6.3 to 6.4 June 7, 2024 07:57
@dakujem
Copy link
Contributor Author

dakujem commented Jun 7, 2024

Okay, so I changed the base to 6.4 as 6.3 is no longer maintained.

@xabbuh xabbuh modified the milestones: 6.3, 6.4 Jun 7, 2024
@xabbuh
Copy link
Member

xabbuh commented Jun 7, 2024

I'm not sure how to distribute this PR to all other branches - should I create separate PRs for each?

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> ...')
Copy link
Member

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?

Copy link
Contributor Author

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.

@javiereguiluz javiereguiluz merged commit 90140b4 into symfony:6.4 Jun 10, 2024
3 checks passed
@javiereguiluz
Copy link
Member

Andrej, thanks a congrats on your first Symfony Docs contribution 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants