[Mailer] Sendgrid mailer transport does not respect custom ports #36224

ftdysa · 2020-03-26T15:51:47Z

Symfony version(s) affected:
symfony/sendgrid-mailer v5.0.5

Description
The Sendgrid Smtp Transport does not respect custom ports provided in the DSN. From Sendgrid's documentation (https://sendgrid.com/docs/for-developers/sending-email/getting-started-smtp/), they suggest the following:

SendGrid accepts unencrypted and TLS connections on ports 25, 587, & 2525. You can also connect via SSL on port 465.

On inspection, it looks like this is how the various Smtp transports are setup so maybe this is an explicit design decision?

Also, it should be noted that you can get around this via something like:

$transport = Transport::fromDsn($dsn);
$transport->getStream()->setPort(587);

but this seems like it'd be nice for the library to handle for you since it already handles DSN parsing well.

How to reproduce
Test script

<?php

use Symfony\Component\Mailer\Bridge\Sendgrid\Transport\SendgridSmtpTransport;
use Symfony\Component\Mailer\Transport;

require 'vendor/autoload.php';

$dsn = 'sendgrid+smtp://apikey:[email protected]:587';
$transport = Transport::fromDsn($dsn);
assert($transport instanceof SendgridSmtpTransport);

var_dump($transport->getStream()->getPort());

Output:

fred@home:~/projects/symfony$ php test.php 
/home/fred/projects/symfony/test.php:13:
int(465)

Possible Solution
Ideally, this should probably be parsed and injected here https://github.com/symfony/sendgrid-mailer/blob/master/Transport/SendgridTransportFactory.php#L36, so that we can pass it down to EsmtpTransport which handles the defaults (https://github.com/symfony/mailer/blob/master/Transport/Smtp/EsmtpTransport.php) but that doesn't really leave us with a lovely constructor for SendgridSmtpTransport.

The text was updated successfully, but these errors were encountered:

jpjoao · 2020-03-28T15:15:27Z

I've created a PR based on the report that adds a unit test that reproduces this issue. (it aims branch 5.0 as that's where the bug was reported but I can backport it if needed)

I initially thought we could use the same approach as for the SendgridApiTransport and override the port before returning:

symfony/src/Symfony/Component/Mailer/Bridge/Sendgrid/Transport/SendgridTransportFactory.php

Line 32 in f5ff33c

    
           return (new SendgridApiTransport($key, $this->client, $this->dispatcher, $this->logger))->setHost($host)->setPort($port);

Digging into it I spotted this:

symfony/src/Symfony/Component/Mailer/Transport/Smtp/EsmtpTransport.php

Lines 48 to 63 in f5ff33c

    
           if (null === $tls) { 
        
               if (465 === $port) { 
        
                   $tls = true; 
        
               } else { 
        
                   $tls = \defined('OPENSSL_VERSION_NUMBER') && 0 === $port && 'localhost' !== $host; 
        
               } 
        
           } 
        
           if (!$tls) { 
        
               $stream->disableTls(); 
        
           } 
        
           if (0 === $port) { 
        
               $port = $tls ? 465 : 25; 
        
           } 
        
           $stream->setHost($host); 
        
           $stream->setPort($port);

There is a whole validation of tls made based on the port and overriding the port could bring some unwanted behaviour. I believe we would need to move this check to a new function so we can re-trigger it once we allow the port to be overwritten.

What are the thoughts on this? How should I proceed?

carsonbot · 2021-02-19T13:02:13Z

Hey, thanks for your report!
There has not been a lot of activity here for a while. Is this bug still relevant? Have you managed to find a workaround?

carsonbot · 2021-03-05T13:29:35Z

Friendly reminder that this issue exists. If I don't hear anything I'll close this.

Stefan39 · 2021-12-24T08:20:22Z

I don't understand why this bug still not fixed until now nearly 2 years it was add it here!

The same problem i have with gmail (also ignores the port in dsn) and i couldn't use the mailer without the tricky way to change it.

xabbuh · 2021-12-26T15:09:59Z

The answer is as simple as that nobody contributed the needed changes yet. PR welcome

nicolas-grekas · 2022-03-30T14:14:29Z

May I ask why one would need to change the port / tls setting when talking to gmail/sendgrid?

Also, this can already be achieved by using a regular smtp dns, eg
smtp://smtp.gmail.com:25

ftdysa · 2022-03-30T14:45:17Z

smtp://smtp.gmail.com:25

Hi @nicolas-grekas, it does appear that the gmail transport parses things correctly. This is specifically for the sendgrid transport. Here are the docs on which port to use: https://docs.sendgrid.com/for-developers/sending-email/integrating-with-the-smtp-api#smtp-ports.

Minimal test case to reproduce:

<?php

use Symfony\Component\Mailer\Bridge\Sendgrid\Transport\SendgridSmtpTransport;
use Symfony\Component\Mailer\Transport;

require 'vendor/autoload.php';

$dsns = [
    'sendgrid+smtp://apikey:[email protected]:587',
    'smtp://smtp.gmail.com:465',
];

foreach ($dsns as $dsn) {
    $transport = Transport::fromDsn($dsn);
    $port = $transport->getStream()->getPort();

    $clazz = get_class($transport);

    echo sprintf("DSN: %s, Port: %d, Transport: %s\n", $dsn, $port, $clazz);
}

Output:

DSN: sendgrid+smtp://apikey:[email protected]:587, Port: 465, Transport: Symfony\Component\Mailer\Bridge\Sendgrid\Transport\SendgridSmtpTransport
DSN: smtp://smtp.gmail.com:465, Port: 465, Transport: Symfony\Component\Mailer\Transport\Smtp\EsmtpTransport

Probably just a matter of setting the port here: https://github.com/symfony/sendgrid-mailer/blob/5.4/Transport/SendgridTransportFactory.php#L36-L38.

nicolas-grekas · 2022-03-30T15:27:23Z

for sendgrid, something like this should work:
smtp://apikey:[email protected]:587

but I'd still like an answer to my previous question: why?

ftdysa · 2022-03-30T15:31:31Z

for sendgrid, something like this should work: smtp://apikey:[email protected]:587

This does appear to work, still seems like a gap IMO though.

but I'd still like an answer to my previous question: why?

Because this is the port that the doc I linked to recommends?

SMTP ports
For an unencrypted or a TLS connection, use port 25, 2525, or 587.

nicolas-grekas · 2022-03-30T15:35:19Z

This argument looks very weak to me. If everything works already with the current default, we shouldn't be looking for a problem.

I think we should close this issue (and the related PRs) as invalid.

ftdysa · 2022-03-30T15:45:29Z

This argument looks very weak to me. If everything works already with the current default, we shouldn't be looking for a problem.

I think we should close this issue (and the related PRs) as invalid.

🤷‍♂️ . Attempting to deviate from the default here: https://symfony.com/doc/current/mailer.html#using-a-3rd-party-transport will not work as expected. I can't remember exactly why this was the case when I originally opened this issue, but the default was not an option for me at the time.

nicolas-grekas · 2022-03-30T15:47:07Z

Thanks for your understanding.

I can't remember exactly why this was the case when I originally opened this issue, but the default was not an option for me at the time.

To anyone that wants us to reconsider closing this issue, please help answer this question first.

…ailer transport DSN (dreadnip) This PR was submitted for the 6.3 branch but it was merged into the 5.4 branch instead. Discussion ---------- Add note about custom port being ignored by specific mailer transport DSN See symfony/symfony#49768 Seems like there has been some confusion about this: * symfony/symfony#46979 * symfony/symfony#44794 People start with the default they're given by the docs, e.g. `sendgrid+smtp` and then try to append `:<port>` to configure it, which doesn't work. As far as I know, the official recommendation is to use the regular `smtp` transport instead when using custom config: symfony/symfony#36224 (comment) Commits ------- b39027f Add note about custom port configuration being ignored by specific mailer transport DSN

ftdysa added the Bug label Mar 26, 2020

carsonbot added the Status: Needs Review label Mar 26, 2020

xabbuh added the Mailer label Mar 27, 2020

jpjoao added a commit to jpjoao/symfony that referenced this issue Mar 28, 2020

Add UT to reproduce symfony#36224

2b6f9c9

jpjoao mentioned this issue Mar 28, 2020

WIP: Ports being ignored when for Sendgrip DSN configuration #36250

Closed

carsonbot added the Stalled label Feb 19, 2021

xabbuh added Feature Keep open and removed Stalled labels Mar 13, 2021

Stefan39 mentioned this issue Dec 26, 2021

[Mailer] Change Gmail & Sendgrid to use custom ports #44800

Closed

ftdysa closed this as completed Mar 30, 2022

sanderdlm mentioned this issue Mar 25, 2023

Add note about custom port being ignored by specific mailer transport DSN symfony/symfony-docs#18118

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Mailer] Sendgrid mailer transport does not respect custom ports #36224

[Mailer] Sendgrid mailer transport does not respect custom ports #36224

ftdysa commented Mar 26, 2020

jpjoao commented Mar 28, 2020

carsonbot commented Feb 19, 2021

carsonbot commented Mar 5, 2021

Stefan39 commented Dec 24, 2021

xabbuh commented Dec 26, 2021

nicolas-grekas commented Mar 30, 2022

ftdysa commented Mar 30, 2022

nicolas-grekas commented Mar 30, 2022

ftdysa commented Mar 30, 2022

nicolas-grekas commented Mar 30, 2022

ftdysa commented Mar 30, 2022

nicolas-grekas commented Mar 30, 2022

[Mailer] Sendgrid mailer transport does not respect custom ports #36224

[Mailer] Sendgrid mailer transport does not respect custom ports #36224

Comments

ftdysa commented Mar 26, 2020

jpjoao commented Mar 28, 2020

carsonbot commented Feb 19, 2021

carsonbot commented Mar 5, 2021

Stefan39 commented Dec 24, 2021

xabbuh commented Dec 26, 2021

nicolas-grekas commented Mar 30, 2022

ftdysa commented Mar 30, 2022

nicolas-grekas commented Mar 30, 2022

ftdysa commented Mar 30, 2022

nicolas-grekas commented Mar 30, 2022

ftdysa commented Mar 30, 2022

nicolas-grekas commented Mar 30, 2022