Skip to content
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

[9.x] Add mail/notification tags & metadata docs #7791

Merged
merged 2 commits into from Mar 10, 2022

Conversation

kbond
Copy link
Contributor

@kbond kbond commented Mar 9, 2022

@taylorotwell
Copy link
Member

I feel like it would be good to flesh out a bit what these actually do. Once I tag something, then what? How does it help me on my email provider?

@kbond
Copy link
Contributor Author

kbond commented Mar 9, 2022

Perhaps something similar to when we have in the Symfony docs:

"Certain 3rd party transports support email tags and metadata, which can be used for grouping, tracking and workflows. You can add these to your Mailable. If your transport supports metadata/tags, they will be converted to their appropriate format."

Maybe with links to different drivers docs on the feature?

@taylorotwell
Copy link
Member

@kbond and, to clarify, what SES refers to as "tags" in their documentation you would actually use the "metadata" Laravel method for... and it is available next Tuesday on our release day since your PR was just merged?

@kbond
Copy link
Contributor Author

kbond commented Mar 10, 2022

what SES refers to as "tags" in their documentation you would actually use the "metadata" Laravel method for

Correct as their "tags" have a key and a value. Our "tags" just have a value.

and it is available next Tuesday on our release day since your PR was just merged?

Yes, all the drivers Laravel has documented support both tags and metadata with the exception of SES, which just supports metadata.

can you point me to where "tags" and "metadata" are clearly defined from Symfony mailer's perspective? What is the purpose of a tag and what is the purpose of metadata? It feels like it would be great to have documentation on what each type (tag / metadata) does for each driver. (laravel/framework#41422 (comment))

Does my above comment provide this?

@taylorotwell
Copy link
Member

@kbond yeah I think we're good. I'll take it from here - thanks!

@taylorotwell taylorotwell merged commit 947a4a7 into laravel:9.x Mar 10, 2022
@kbond kbond deleted the mail-tags-metadata branch March 10, 2022 18:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants