Skip to content

[Mailer] Document the optional HttpClient dependency #18386

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

Closed
derrabus opened this issue Jun 8, 2023 · 3 comments
Closed

[Mailer] Document the optional HttpClient dependency #18386

derrabus opened this issue Jun 8, 2023 · 3 comments
Labels
hasPR A Pull Request has already been submitted for this issue. Mailer

Comments

@derrabus
Copy link
Member

derrabus commented Jun 8, 2023

While reviewing symfony/symfony#50598, I searched the docs for any hints about mailer bridges relying on the HTTP Client, but I found none.

In the section on 3rd party transports, I see a list of composer packages that I can install to enable interfacing with those 3rd party services. This might lead to the false conclusion that simply installing the package next to the name of the service I'd like to interface with is enough. However, this is in most cases only true for SMTP-based transports.

If I want to use the web API of a service instead, I might need to install symfony/http-client as well. Not doing so will result in a runtime failure. Taking into account that developers usually rely on MailDev or a similar SMTP-based catcher for local development, that runtime failure might not be discovered until deploying to a staging or production system.

The least we can do here is documenting this optional dependency on the page I've linked above.

@alexandre-daubois
Copy link
Member

Would something like this suit? 🙂

#18387

@derrabus
Copy link
Member Author

derrabus commented Jun 8, 2023

Wow, that was fast. Thanks for picking up this topic so quickly.

@xabbuh xabbuh added the hasPR A Pull Request has already been submitted for this issue. label Jun 8, 2023
javiereguiluz added a commit that referenced this issue Jun 8, 2023
…exandre-daubois)

This PR was merged into the 5.4 branch.

Discussion
----------

[Mailer] Document the optional HttpClient dependency

Resolves #18386

Commits
-------

7ecb253 [Mailer] Document the optional HttpClient dependency
@derrabus
Copy link
Member Author

derrabus commented Jun 8, 2023

Fixed by #18387

@derrabus derrabus closed this as completed Jun 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hasPR A Pull Request has already been submitted for this issue. Mailer
Projects
None yet
Development

No branches or pull requests

4 participants