diogo
/
symfony
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[Mailer] added debug info for HTTP mailers

This commit is contained in:
Fabien Potencier 2019-07-17 16:15:07 +02:00
parent 6f78ad8d68
commit d2f33d2cfe
12 changed files with 103 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/Symfony/Component/Mailer/Bridge/Amazon/Http/Api/SesTransport.php
View File

@ -12,12 +12,13 @@
namespace Symfony\Component\Mailer\Bridge\Amazon\Http\Api;
use Psr\Log\LoggerInterface;
use Symfony\Component\Mailer\Exception\TransportException;
use Symfony\Component\Mailer\Exception\HttpTransportException;
use Symfony\Component\Mailer\SmtpEnvelope;
use Symfony\Component\Mailer\Transport\Http\Api\AbstractApiTransport;
use Symfony\Component\Mime\Email;
use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
use Symfony\Contracts\HttpClient\HttpClientInterface;
use Symfony\Contracts\HttpClient\ResponseInterface;
/**
* @author Kevin Verschaeve
@ -42,7 +43,7 @@ class SesTransport extends AbstractApiTransport
parent::__construct($client, $dispatcher, $logger);
}
protected function doSendEmail(Email $email, SmtpEnvelope $envelope): void
protected function doSendApi(Email $email, SmtpEnvelope $envelope): ResponseInterface
{
$date = gmdate('D, d M Y H:i:s e');
$auth = sprintf('AWS3-HTTPS AWSAccessKeyId=%s,Algorithm=HmacSHA256,Signature=%s', $this->accessKey, $this->getSignature($date));
@ -60,8 +61,10 @@ class SesTransport extends AbstractApiTransport
if (200 !== $response->getStatusCode()) {
$error = new \SimpleXMLElement($response->getContent(false));
throw new TransportException(sprintf('Unable to send an email: %s (code %s).', $error->Error->Message, $error->Error->Code));
throw new HttpTransportException(sprintf('Unable to send an email: %s (code %s).', $error->Error->Message, $error->Error->Code), $response);
}
return $response;
}
private function getSignature(string $string): string

9
src/Symfony/Component/Mailer/Bridge/Amazon/Http/SesTransport.php
View File

@ -12,11 +12,12 @@
namespace Symfony\Component\Mailer\Bridge\Amazon\Http;
use Psr\Log\LoggerInterface;
use Symfony\Component\Mailer\Exception\TransportException;
use Symfony\Component\Mailer\Exception\HttpTransportException;
use Symfony\Component\Mailer\SentMessage;
use Symfony\Component\Mailer\Transport\Http\AbstractHttpTransport;
use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
use Symfony\Contracts\HttpClient\HttpClientInterface;
use Symfony\Contracts\HttpClient\ResponseInterface;
/**
* @author Kevin Verschaeve
@ -41,7 +42,7 @@ class SesTransport extends AbstractHttpTransport
parent::__construct($client, $dispatcher, $logger);
}
protected function doSend(SentMessage $message): void
protected function doSendHttp(SentMessage $message): ResponseInterface
{
$date = gmdate('D, d M Y H:i:s e');
$auth = sprintf('AWS3-HTTPS AWSAccessKeyId=%s,Algorithm=HmacSHA256,Signature=%s', $this->accessKey, $this->getSignature($date));
@ -61,8 +62,10 @@ class SesTransport extends AbstractHttpTransport
if (200 !== $response->getStatusCode()) {
$error = new \SimpleXMLElement($response->getContent(false));
throw new TransportException(sprintf('Unable to send an email: %s (code %s).', $error->Error->Message, $error->Error->Code));
throw new HttpTransportException(sprintf('Unable to send an email: %s (code %s).', $error->Error->Message, $error->Error->Code), $response);
}
return $response;
}
private function getSignature(string $string): string

11
src/Symfony/Component/Mailer/Bridge/Mailchimp/Http/Api/MandrillTransport.php
View File

@ -12,12 +12,13 @@
namespace Symfony\Component\Mailer\Bridge\Mailchimp\Http\Api;
use Psr\Log\LoggerInterface;
use Symfony\Component\Mailer\Exception\TransportException;
use Symfony\Component\Mailer\Exception\HttpTransportException;
use Symfony\Component\Mailer\SmtpEnvelope;
use Symfony\Component\Mailer\Transport\Http\Api\AbstractApiTransport;
use Symfony\Component\Mime\Email;
use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
use Symfony\Contracts\HttpClient\HttpClientInterface;
use Symfony\Contracts\HttpClient\ResponseInterface;
/**
* @author Kevin Verschaeve
@ -35,7 +36,7 @@ class MandrillTransport extends AbstractApiTransport
parent::__construct($client, $dispatcher, $logger);
}
protected function doSendEmail(Email $email, SmtpEnvelope $envelope): void
protected function doSendApi(Email $email, SmtpEnvelope $envelope): ResponseInterface
{
$response = $this->client->request('POST', self::ENDPOINT, [
'json' => $this->getPayload($email, $envelope),
@ -44,11 +45,13 @@ class MandrillTransport extends AbstractApiTransport
if (200 !== $response->getStatusCode()) {
$result = $response->toArray(false);
if ('error' === ($result['status'] ?? false)) {
throw new TransportException(sprintf('Unable to send an email: %s (code %s).', $result['message'], $result['code']));
throw new HttpTransportException(sprintf('Unable to send an email: %s (code %s).', $result['message'], $result['code']), $response);
}
throw new TransportException(sprintf('Unable to send an email (code %s).', $result['code']));
throw new HttpTransportException(sprintf('Unable to send an email (code %s).', $result['code']), $response);
}
return $response;
}
private function getPayload(Email $email, SmtpEnvelope $envelope): array

11
src/Symfony/Component/Mailer/Bridge/Mailchimp/Http/MandrillTransport.php
View File

@ -12,11 +12,12 @@
namespace Symfony\Component\Mailer\Bridge\Mailchimp\Http;
use Psr\Log\LoggerInterface;
use Symfony\Component\Mailer\Exception\TransportException;
use Symfony\Component\Mailer\Exception\HttpTransportException;
use Symfony\Component\Mailer\SentMessage;
use Symfony\Component\Mailer\Transport\Http\AbstractHttpTransport;
use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
use Symfony\Contracts\HttpClient\HttpClientInterface;
use Symfony\Contracts\HttpClient\ResponseInterface;
/**
* @author Kevin Verschaeve
@ -33,7 +34,7 @@ class MandrillTransport extends AbstractHttpTransport
parent::__construct($client, $dispatcher, $logger);
}
protected function doSend(SentMessage $message): void
protected function doSendHttp(SentMessage $message): ResponseInterface
{
$envelope = $message->getEnvelope();
$response = $this->client->request('POST', self::ENDPOINT, [
@ -48,10 +49,12 @@ class MandrillTransport extends AbstractHttpTransport
if (200 !== $response->getStatusCode()) {
$result = $response->toArray(false);
if ('error' === ($result['status'] ?? false)) {
throw new TransportException(sprintf('Unable to send an email: %s (code %s).', $result['message'], $result['code']));
throw new HttpTransportException(sprintf('Unable to send an email: %s (code %s).', $result['message'], $result['code']), $response);
}
throw new TransportException(sprintf('Unable to send an email (code %s).', $result['code']));
throw new HttpTransportException(sprintf('Unable to send an email (code %s).', $result['code']), $response);
}
return $response;
}
}

9
src/Symfony/Component/Mailer/Bridge/Mailgun/Http/Api/MailgunTransport.php
View File

@ -12,13 +12,14 @@
namespace Symfony\Component\Mailer\Bridge\Mailgun\Http\Api;
use Psr\Log\LoggerInterface;
use Symfony\Component\Mailer\Exception\TransportException;
use Symfony\Component\Mailer\Exception\HttpTransportException;
use Symfony\Component\Mailer\SmtpEnvelope;
use Symfony\Component\Mailer\Transport\Http\Api\AbstractApiTransport;
use Symfony\Component\Mime\Email;
use Symfony\Component\Mime\Part\Multipart\FormDataPart;
use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
use Symfony\Contracts\HttpClient\HttpClientInterface;
use Symfony\Contracts\HttpClient\ResponseInterface;
/**
* @author Kevin Verschaeve
@ -40,7 +41,7 @@ class MailgunTransport extends AbstractApiTransport
parent::__construct($client, $dispatcher, $logger);
}
protected function doSendEmail(Email $email, SmtpEnvelope $envelope): void
protected function doSendApi(Email $email, SmtpEnvelope $envelope): ResponseInterface
{
$body = new FormDataPart($this->getPayload($email, $envelope));
$headers = [];
@ -58,8 +59,10 @@ class MailgunTransport extends AbstractApiTransport
if (200 !== $response->getStatusCode()) {
$error = $response->toArray(false);
throw new TransportException(sprintf('Unable to send an email: %s (code %s).', $error['message'], $response->getStatusCode()));
throw new HttpTransportException(sprintf('Unable to send an email: %s (code %s).', $error['message'], $response->getStatusCode()), $response);
}
return $response;
}
private function getPayload(Email $email, SmtpEnvelope $envelope): array

9
src/Symfony/Component/Mailer/Bridge/Mailgun/Http/MailgunTransport.php
View File

@ -12,13 +12,14 @@
namespace Symfony\Component\Mailer\Bridge\Mailgun\Http;
use Psr\Log\LoggerInterface;
use Symfony\Component\Mailer\Exception\TransportException;
use Symfony\Component\Mailer\Exception\HttpTransportException;
use Symfony\Component\Mailer\SentMessage;
use Symfony\Component\Mailer\Transport\Http\AbstractHttpTransport;
use Symfony\Component\Mime\Part\DataPart;
use Symfony\Component\Mime\Part\Multipart\FormDataPart;
use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
use Symfony\Contracts\HttpClient\HttpClientInterface;
use Symfony\Contracts\HttpClient\ResponseInterface;
/**
* @author Kevin Verschaeve
@ -39,7 +40,7 @@ class MailgunTransport extends AbstractHttpTransport
parent::__construct($client, $dispatcher, $logger);
}
protected function doSend(SentMessage $message): void
protected function doSendHttp(SentMessage $message): ResponseInterface
{
$body = new FormDataPart([
'to' => implode(',', $this->stringifyAddresses($message->getEnvelope()->getRecipients())),
@ -59,7 +60,9 @@ class MailgunTransport extends AbstractHttpTransport
if (200 !== $response->getStatusCode()) {
$error = $response->toArray(false);
throw new TransportException(sprintf('Unable to send an email: %s (code %s).', $error['message'], $response->getStatusCode()));
throw new HttpTransportException(sprintf('Unable to send an email: %s (code %s).', $error['message'], $response->getStatusCode()), $response);
}
return $response;
}
}

9
src/Symfony/Component/Mailer/Bridge/Postmark/Http/Api/PostmarkTransport.php
View File

@ -12,12 +12,13 @@
namespace Symfony\Component\Mailer\Bridge\Postmark\Http\Api;
use Psr\Log\LoggerInterface;
use Symfony\Component\Mailer\Exception\TransportException;
use Symfony\Component\Mailer\Exception\HttpTransportException;
use Symfony\Component\Mailer\SmtpEnvelope;
use Symfony\Component\Mailer\Transport\Http\Api\AbstractApiTransport;
use Symfony\Component\Mime\Email;
use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
use Symfony\Contracts\HttpClient\HttpClientInterface;
use Symfony\Contracts\HttpClient\ResponseInterface;
/**
* @author Kevin Verschaeve
@ -35,7 +36,7 @@ class PostmarkTransport extends AbstractApiTransport
parent::__construct($client, $dispatcher, $logger);
}
protected function doSendEmail(Email $email, SmtpEnvelope $envelope): void
protected function doSendApi(Email $email, SmtpEnvelope $envelope): ResponseInterface
{
$response = $this->client->request('POST', self::ENDPOINT, [
'headers' => [
@ -48,8 +49,10 @@ class PostmarkTransport extends AbstractApiTransport
if (200 !== $response->getStatusCode()) {
$error = $response->toArray(false);
throw new TransportException(sprintf('Unable to send an email: %s (code %s).', $error['Message'], $error['ErrorCode']));
throw new HttpTransportException(sprintf('Unable to send an email: %s (code %s).', $error['Message'], $error['ErrorCode']), $response);
}
return $response;
}
private function getPayload(Email $email, SmtpEnvelope $envelope): array

9
src/Symfony/Component/Mailer/Bridge/Sendgrid/Http/Api/SendgridTransport.php
View File

@ -12,13 +12,14 @@
namespace Symfony\Component\Mailer\Bridge\Sendgrid\Http\Api;
use Psr\Log\LoggerInterface;
use Symfony\Component\Mailer\Exception\TransportException;
use Symfony\Component\Mailer\Exception\HttpTransportException;
use Symfony\Component\Mailer\SmtpEnvelope;
use Symfony\Component\Mailer\Transport\Http\Api\AbstractApiTransport;
use Symfony\Component\Mime\Address;
use Symfony\Component\Mime\Email;
use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
use Symfony\Contracts\HttpClient\HttpClientInterface;
use Symfony\Contracts\HttpClient\ResponseInterface;
/**
* @author Kevin Verschaeve
@ -36,7 +37,7 @@ class SendgridTransport extends AbstractApiTransport
parent::__construct($client, $dispatcher, $logger);
}
protected function doSendEmail(Email $email, SmtpEnvelope $envelope): void
protected function doSendApi(Email $email, SmtpEnvelope $envelope): ResponseInterface
{
$response = $this->client->request('POST', self::ENDPOINT, [
'json' => $this->getPayload($email, $envelope),
@ -46,8 +47,10 @@ class SendgridTransport extends AbstractApiTransport
if (202 !== $response->getStatusCode()) {
$errors = $response->toArray(false);
throw new TransportException(sprintf('Unable to send an email: %s (code %s).', implode('; ', array_column($errors['errors'], 'message')), $response->getStatusCode()));
throw new HttpTransportException(sprintf('Unable to send an email: %s (code %s).', implode('; ', array_column($errors['errors'], 'message')), $response->getStatusCode()), $response);
}
return $response;
}
private function getPayload(Email $email, SmtpEnvelope $envelope): array

15
src/Symfony/Component/Mailer/Exception/HttpTransportException.php
View File

@ -11,9 +11,24 @@
namespace Symfony\Component\Mailer\Exception;
use Symfony\Contracts\HttpClient\ResponseInterface;
/**
* @author Fabien Potencier <fabien@symfony.com>
*/
class HttpTransportException extends TransportException
{
private $response;
public function __construct(string $message = null, ResponseInterface $response, int $code = 0, \Exception $previous = null)
{
parent::__construct($message, $code, $previous);
$this->response = $response;
}
public function getResponse(): ResponseInterface
{
return $this->response;
}
}

11
src/Symfony/Component/Mailer/SentMessage.php
View File

@ -22,6 +22,7 @@ class SentMessage
private $original;
private $raw;
private $envelope;
private $debug = '';
/**
* @internal
@ -48,6 +49,16 @@ class SentMessage
return $this->envelope;
}
public function getDebug(): string
{
return $this->debug;
}
public function appendDebug(string $debug): void
{
$this->debug .= $debug;
}
public function toString(): string
{
return $this->raw->toString();

21
src/Symfony/Component/Mailer/Transport/Http/AbstractHttpTransport.php
View File

@ -13,9 +13,12 @@ namespace Symfony\Component\Mailer\Transport\Http;
use Psr\Log\LoggerInterface;
use Symfony\Component\HttpClient\HttpClient;
use Symfony\Component\Mailer\Exception\HttpTransportException;
use Symfony\Component\Mailer\SentMessage;
use Symfony\Component\Mailer\Transport\AbstractTransport;
use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
use Symfony\Contracts\HttpClient\HttpClientInterface;
use Symfony\Contracts\HttpClient\ResponseInterface;
/**
* @author Victor Bocharsky <victor@symfonycasts.com>
@ -37,4 +40,22 @@ abstract class AbstractHttpTransport extends AbstractTransport
parent::__construct($dispatcher, $logger);
}
abstract protected function doSendHttp(SentMessage $message): ResponseInterface;
protected function doSend(SentMessage $message): void
{
$response = null;
try {
$response = $this->doSendHttp($message);
} catch (HttpTransportException $e) {
$response = $e->getResponse();
throw $e;
} finally {
if (null !== $response) {
$message->appendDebug($response->getInfo('debug'));
}
}
}
}

31
src/Symfony/Component/Mailer/Transport/Http/Api/AbstractApiTransport.php
View File

@ -11,42 +11,23 @@
namespace Symfony\Component\Mailer\Transport\Http\Api;
use Psr\Log\LoggerInterface;
use Symfony\Component\HttpClient\HttpClient;
use Symfony\Component\Mailer\Exception\RuntimeException;
use Symfony\Component\Mailer\SentMessage;
use Symfony\Component\Mailer\SmtpEnvelope;
use Symfony\Component\Mailer\Transport\AbstractTransport;
use Symfony\Component\Mailer\Transport\Http\AbstractHttpTransport;
use Symfony\Component\Mime\Address;
use Symfony\Component\Mime\Email;
use Symfony\Component\Mime\MessageConverter;
use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
use Symfony\Contracts\HttpClient\HttpClientInterface;
use Symfony\Contracts\HttpClient\ResponseInterface;
/**
* @author Fabien Potencier <fabien@symfony.com>
*/
abstract class AbstractApiTransport extends AbstractTransport
abstract class AbstractApiTransport extends AbstractHttpTransport
{
protected $client;
abstract protected function doSendApi(Email $email, SmtpEnvelope $envelope): ResponseInterface;
public function __construct(HttpClientInterface $client = null, EventDispatcherInterface $dispatcher = null, LoggerInterface $logger = null)
{
$this->client = $client;
if (null === $client) {
if (!class_exists(HttpClient::class)) {
throw new \LogicException(sprintf('You cannot use "%s" as the HttpClient component is not installed. Try running "composer require symfony/http-client".', __CLASS__));
}
$this->client = HttpClient::create();
}
parent::__construct($dispatcher, $logger);
}
abstract protected function doSendEmail(Email $email, SmtpEnvelope $envelope): void;
protected function doSend(SentMessage $message): void
protected function doSendHttp(SentMessage $message): ResponseInterface
{
try {
$email = MessageConverter::toEmail($message->getOriginalMessage());
@ -54,7 +35,7 @@ abstract class AbstractApiTransport extends AbstractTransport
throw new RuntimeException(sprintf('Unable to send message with the "%s" transport: %s', __CLASS__, $e->getMessage()), 0, $e);
}
$this->doSendEmail($email, $message->getEnvelope());
return $this->doSendApi($email, $message->getEnvelope());
}
protected function getRecipients(Email $email, SmtpEnvelope $envelope): array