Skip to content

[Mailer] Document the optional HttpClient dependency #18386

Closed
@derrabus

Description

@derrabus

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    MailerhasPRA Pull Request has already been submitted for this issue.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions