Skip to content

[Mailer] rename SmtpEnvelope to Envelope #33562

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Sep 13, 2019
Merged

[Mailer] rename SmtpEnvelope to Envelope #33562

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/Symfony/Component/Mailer/Bridge/Amazon/Transport/SesApiTransport.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
namespace Symfony\Component\Mailer\Bridge\Amazon\Transport;

use Psr\Log\LoggerInterface;
use Symfony\Component\Mailer\Envelope;
use Symfony\Component\Mailer\Exception\HttpTransportException;
use Symfony\Component\Mailer\SmtpEnvelope;
use Symfony\Component\Mailer\Transport\AbstractApiTransport;
use Symfony\Component\Mime\Email;
use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
Expand Down Expand Up @@ -48,7 +48,7 @@ public function __toString(): string
return sprintf('ses+api://%s@%s', $this->accessKey, $this->getEndpoint());
}

protected function doSendApi(Email $email, SmtpEnvelope $envelope): ResponseInterface
protected function doSendApi(Email $email, Envelope $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));
Expand Down Expand Up @@ -81,7 +81,7 @@ private function getSignature(string $string): string
return base64_encode(hash_hmac('sha256', $string, $this->secretKey, true));
}

private function getPayload(Email $email, SmtpEnvelope $envelope): array
private function getPayload(Email $email, Envelope $envelope): array
{
if ($email->getAttachments()) {
return [
Expand Down
8 changes: 4 additions & 4 deletions src/Symfony/Component/Mailer/Bridge/Mailchimp/Transport/MandrillApiTransport.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
namespace Symfony\Component\Mailer\Bridge\Mailchimp\Transport;

use Psr\Log\LoggerInterface;
use Symfony\Component\Mailer\Envelope;
use Symfony\Component\Mailer\Exception\HttpTransportException;
use Symfony\Component\Mailer\SmtpEnvelope;
use Symfony\Component\Mailer\Transport\AbstractApiTransport;
use Symfony\Component\Mime\Email;
use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
Expand Down Expand Up @@ -41,7 +41,7 @@ public function __toString(): string
return sprintf('mandrill+api://%s', $this->getEndpoint());
}

protected function doSendApi(Email $email, SmtpEnvelope $envelope): ResponseInterface
protected function doSendApi(Email $email, Envelope $envelope): ResponseInterface
{
$response = $this->client->request('POST', 'https://'.$this->getEndpoint().'/api/1.0/messages/send.json', [
'json' => $this->getPayload($email, $envelope),
Expand All @@ -64,7 +64,7 @@ private function getEndpoint(): ?string
return ($this->host ?: self::HOST).($this->port ? ':'.$this->port : '');
}

private function getPayload(Email $email, SmtpEnvelope $envelope): array
private function getPayload(Email $email, Envelope $envelope): array
{
$payload = [
'key' => $this->key,
Expand Down Expand Up @@ -105,7 +105,7 @@ private function getPayload(Email $email, SmtpEnvelope $envelope): array
return $payload;
}

protected function getRecipients(Email $email, SmtpEnvelope $envelope): array
protected function getRecipients(Email $email, Envelope $envelope): array
{
$recipients = [];
foreach ($envelope->getRecipients() as $recipient) {
Expand Down
6 changes: 3 additions & 3 deletions src/Symfony/Component/Mailer/Bridge/Mailgun/Transport/MailgunApiTransport.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
namespace Symfony\Component\Mailer\Bridge\Mailgun\Transport;

use Psr\Log\LoggerInterface;
use Symfony\Component\Mailer\Envelope;
use Symfony\Component\Mailer\Exception\HttpTransportException;
use Symfony\Component\Mailer\SmtpEnvelope;
use Symfony\Component\Mailer\Transport\AbstractApiTransport;
use Symfony\Component\Mime\Email;
use Symfony\Component\Mime\Part\Multipart\FormDataPart;
Expand Down Expand Up @@ -46,7 +46,7 @@ public function __toString(): string
return sprintf('mailgun+api://%s?domain=%s', $this->getEndpoint(), $this->domain);
}

protected function doSendApi(Email $email, SmtpEnvelope $envelope): ResponseInterface
protected function doSendApi(Email $email, Envelope $envelope): ResponseInterface
{
$body = new FormDataPart($this->getPayload($email, $envelope));
$headers = [];
Expand All @@ -72,7 +72,7 @@ protected function doSendApi(Email $email, SmtpEnvelope $envelope): ResponseInte
return $response;
}

private function getPayload(Email $email, SmtpEnvelope $envelope): array
private function getPayload(Email $email, Envelope $envelope): array
{
$headers = $email->getHeaders();
$html = $email->getHtmlBody();
Expand Down
6 changes: 3 additions & 3 deletions src/Symfony/Component/Mailer/Bridge/Postmark/Transport/PostmarkApiTransport.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
namespace Symfony\Component\Mailer\Bridge\Postmark\Transport;

use Psr\Log\LoggerInterface;
use Symfony\Component\Mailer\Envelope;
use Symfony\Component\Mailer\Exception\HttpTransportException;
use Symfony\Component\Mailer\SmtpEnvelope;
use Symfony\Component\Mailer\Transport\AbstractApiTransport;
use Symfony\Component\Mime\Email;
use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
Expand Down Expand Up @@ -41,7 +41,7 @@ public function __toString(): string
return sprintf('postmark+api://%s', $this->getEndpoint());
}

protected function doSendApi(Email $email, SmtpEnvelope $envelope): ResponseInterface
protected function doSendApi(Email $email, Envelope $envelope): ResponseInterface
{
$response = $this->client->request('POST', 'https://'.$this->getEndpoint().'/email', [
'headers' => [
Expand All @@ -60,7 +60,7 @@ protected function doSendApi(Email $email, SmtpEnvelope $envelope): ResponseInte
return $response;
}

private function getPayload(Email $email, SmtpEnvelope $envelope): array
private function getPayload(Email $email, Envelope $envelope): array
{
$payload = [
'From' => $envelope->getSender()->toString(),
Expand Down
6 changes: 3 additions & 3 deletions src/Symfony/Component/Mailer/Bridge/Sendgrid/Transport/SendgridApiTransport.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
namespace Symfony\Component\Mailer\Bridge\Sendgrid\Transport;

use Psr\Log\LoggerInterface;
use Symfony\Component\Mailer\Envelope;
use Symfony\Component\Mailer\Exception\HttpTransportException;
use Symfony\Component\Mailer\SmtpEnvelope;
use Symfony\Component\Mailer\Transport\AbstractApiTransport;
use Symfony\Component\Mime\Address;
use Symfony\Component\Mime\Email;
Expand Down Expand Up @@ -42,7 +42,7 @@ public function __toString(): string
return sprintf('sendgrid+api://%s', $this->getEndpoint());
}

protected function doSendApi(Email $email, SmtpEnvelope $envelope): ResponseInterface
protected function doSendApi(Email $email, Envelope $envelope): ResponseInterface
{
$response = $this->client->request('POST', 'https://'.$this->getEndpoint().'/v3/mail/send', [
'json' => $this->getPayload($email, $envelope),
Expand All @@ -58,7 +58,7 @@ protected function doSendApi(Email $email, SmtpEnvelope $envelope): ResponseInte
return $response;
}

private function getPayload(Email $email, SmtpEnvelope $envelope): array
private function getPayload(Email $email, Envelope $envelope): array
{
$addressStringifier = function (Address $address) {return ['email' => $address->toString()]; };

Expand Down
2 changes: 2 additions & 0 deletions src/Symfony/Component/Mailer/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ CHANGELOG
4.4.0
-----

* [BC BREAK] renamed `SmtpEnvelope` to `Envelope`, renamed `DelayedSmtpEnvelope` to
`DelayedEnvelope`
* [BC BREAK] changed the syntax for failover and roundrobin DSNs

Before:
Expand Down
2 changes: 1 addition & 1 deletion .../Component/Mailer/DelayedSmtpEnvelope.php → ...fony/Component/Mailer/DelayedEnvelope.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
*
* @internal
*/
final class DelayedSmtpEnvelope extends SmtpEnvelope
final class DelayedEnvelope extends Envelope
{
private $senderSet = false;
private $recipientsSet = false;
Expand Down
4 changes: 2 additions & 2 deletions ...Symfony/Component/Mailer/SmtpEnvelope.php → src/Symfony/Component/Mailer/Envelope.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
/**
* @author Fabien Potencier <fabien@symfony.com>
*/
class SmtpEnvelope
class Envelope
{
private $sender;
private $recipients = [];
Expand All @@ -39,7 +39,7 @@ public static function create(RawMessage $message): self
throw new LogicException('Cannot send a RawMessage instance without an explicit Envelope.');
}

return new DelayedSmtpEnvelope($message);
return new DelayedEnvelope($message);
}

public function setSender(Address $sender): void
Expand Down
4 changes: 2 additions & 2 deletions src/Symfony/Component/Mailer/Event/MessageEvent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
namespace Symfony\Component\Mailer\Event;

use Symfony\Component\EventDispatcher\Event;
use Symfony\Component\Mailer\SmtpEnvelope;
use Symfony\Component\Mailer\Envelope;
use Symfony\Component\Mime\RawMessage;

/**
Expand All @@ -27,7 +27,7 @@ final class MessageEvent extends Event
private $transport;
private $queued;

public function __construct(RawMessage $message, SmtpEnvelope $envelope, string $transport, bool $queued = false)
public function __construct(RawMessage $message, Envelope $envelope, string $transport, bool $queued = false)
{
$this->message = $message;
$this->envelope = $envelope;
Expand Down
4 changes: 2 additions & 2 deletions src/Symfony/Component/Mailer/Mailer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public function __construct(TransportInterface $transport, MessageBusInterface $
$this->dispatcher = $dispatcher;
}

public function send(RawMessage $message, SmtpEnvelope $envelope = null): void
public function send(RawMessage $message, Envelope $envelope = null): void
{
if (null === $this->bus) {
$this->transport->send($message, $envelope);
Expand All @@ -44,7 +44,7 @@ public function send(RawMessage $message, SmtpEnvelope $envelope = null): void

if (null !== $this->dispatcher) {
$message = clone $message;
$envelope = null !== $envelope ? clone $envelope : SmtpEnvelope::create($message);
$envelope = null !== $envelope ? clone $envelope : Envelope::create($message);
$event = new MessageEvent($message, $envelope, (string) $this->transport, true);
$this->dispatcher->dispatch($event);
}
Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Component/Mailer/MailerInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,5 @@ interface MailerInterface
/**
* @throws TransportExceptionInterface
*/
public function send(RawMessage $message, SmtpEnvelope $envelope = null): void;
public function send(RawMessage $message, Envelope $envelope = null): void;
}
6 changes: 3 additions & 3 deletions src/Symfony/Component/Mailer/Messenger/SendEmailMessage.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

namespace Symfony\Component\Mailer\Messenger;

use Symfony\Component\Mailer\SmtpEnvelope;
use Symfony\Component\Mailer\Envelope;
use Symfony\Component\Mime\RawMessage;

/**
Expand All @@ -25,7 +25,7 @@ class SendEmailMessage
/**
* @internal
*/
public function __construct(RawMessage $message, SmtpEnvelope $envelope = null)
public function __construct(RawMessage $message, Envelope $envelope = null)
{
$this->message = $message;
$this->envelope = $envelope;
Expand All @@ -36,7 +36,7 @@ public function getMessage(): RawMessage
return $this->message;
}

public function getEnvelope(): ?SmtpEnvelope
public function getEnvelope(): ?Envelope
{
return $this->envelope;
}
Expand Down
4 changes: 2 additions & 2 deletions src/Symfony/Component/Mailer/SentMessage.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ class SentMessage
/**
* @internal
*/
public function __construct(RawMessage $message, SmtpEnvelope $envelope)
public function __construct(RawMessage $message, Envelope $envelope)
{
$message->ensureValidity();

Expand All @@ -46,7 +46,7 @@ public function getOriginalMessage(): RawMessage
return $this->original;
}

public function getEnvelope(): SmtpEnvelope
public function getEnvelope(): Envelope
{
return $this->envelope;
}
Expand Down
28 changes: 14 additions & 14 deletions ...mponent/Mailer/Tests/SmtpEnvelopeTest.php → ...y/Component/Mailer/Tests/EnvelopeTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,71 +12,71 @@
namespace Symfony\Component\Mailer\Tests;

use PHPUnit\Framework\TestCase;
use Symfony\Component\Mailer\Envelope;
use Symfony\Component\Mailer\Exception\LogicException;
use Symfony\Component\Mailer\SmtpEnvelope;
use Symfony\Component\Mime\Address;
use Symfony\Component\Mime\Header\Headers;
use Symfony\Component\Mime\Message;
use Symfony\Component\Mime\RawMessage;

class SmtpEnvelopeTest extends TestCase
class EnvelopeTest extends TestCase
{
public function testConstructorWithAddressSender()
{
$e = new SmtpEnvelope(new Address('fabien@symfony.com'), [new Address('thomas@symfony.com')]);
$e = new Envelope(new Address('fabien@symfony.com'), [new Address('thomas@symfony.com')]);
$this->assertEquals(new Address('fabien@symfony.com'), $e->getSender());
}

public function testConstructorWithNamedAddressSender()
{
$e = new SmtpEnvelope(new Address('fabien@symfony.com', 'Fabien'), [new Address('thomas@symfony.com')]);
$e = new Envelope(new Address('fabien@symfony.com', 'Fabien'), [new Address('thomas@symfony.com')]);
$this->assertEquals(new Address('fabien@symfony.com'), $e->getSender());
}

public function testConstructorWithAddressRecipients()
{
$e = new SmtpEnvelope(new Address('fabien@symfony.com'), [new Address('thomas@symfony.com'), new Address('lucas@symfony.com', 'Lucas')]);
$e = new Envelope(new Address('fabien@symfony.com'), [new Address('thomas@symfony.com'), new Address('lucas@symfony.com', 'Lucas')]);
$this->assertEquals([new Address('thomas@symfony.com'), new Address('lucas@symfony.com')], $e->getRecipients());
}

public function testConstructorWithNoRecipients()
{
$this->expectException(\InvalidArgumentException::class);
$e = new SmtpEnvelope(new Address('fabien@symfony.com'), []);
$e = new Envelope(new Address('fabien@symfony.com'), []);
}

public function testConstructorWithWrongRecipients()
{
$this->expectException(\InvalidArgumentException::class);
$e = new SmtpEnvelope(new Address('fabien@symfony.com'), ['lucas@symfony.com']);
$e = new Envelope(new Address('fabien@symfony.com'), ['lucas@symfony.com']);
}

public function testSenderFromHeaders()
{
$headers = new Headers();
$headers->addPathHeader('Return-Path', new Address('return@symfony.com', 'return'));
$headers->addMailboxListHeader('To', ['from@symfony.com']);
$e = SmtpEnvelope::create(new Message($headers));
$e = Envelope::create(new Message($headers));
$this->assertEquals(new Address('return@symfony.com', 'return'), $e->getSender());

$headers = new Headers();
$headers->addMailboxHeader('Sender', new Address('sender@symfony.com', 'sender'));
$headers->addMailboxListHeader('To', ['from@symfony.com']);
$e = SmtpEnvelope::create(new Message($headers));
$e = Envelope::create(new Message($headers));
$this->assertEquals(new Address('sender@symfony.com', 'sender'), $e->getSender());

$headers = new Headers();
$headers->addMailboxListHeader('From', [new Address('from@symfony.com', 'from'), 'some@symfony.com']);
$headers->addMailboxListHeader('To', ['from@symfony.com']);
$e = SmtpEnvelope::create(new Message($headers));
$e = Envelope::create(new Message($headers));
$this->assertEquals(new Address('from@symfony.com', 'from'), $e->getSender());
}

public function testSenderFromHeadersWithoutFrom()
{
$headers = new Headers();
$headers->addMailboxListHeader('To', ['from@symfony.com']);
$e = SmtpEnvelope::create($message = new Message($headers));
$e = Envelope::create($message = new Message($headers));
$message->getHeaders()->addMailboxListHeader('From', [new Address('from@symfony.com', 'from')]);
$this->assertEquals(new Address('from@symfony.com', 'from'), $e->getSender());
}
Expand All @@ -88,7 +88,7 @@ public function testRecipientsFromHeaders()
$headers->addMailboxListHeader('To', [new Address('to@symfony.com')]);
$headers->addMailboxListHeader('Cc', [new Address('cc@symfony.com')]);
$headers->addMailboxListHeader('Bcc', [new Address('bcc@symfony.com')]);
$e = SmtpEnvelope::create(new Message($headers));
$e = Envelope::create(new Message($headers));
$this->assertEquals([new Address('to@symfony.com'), new Address('cc@symfony.com'), new Address('bcc@symfony.com')], $e->getRecipients());
}

Expand All @@ -99,14 +99,14 @@ public function testRecipientsFromHeadersWithNames()
$headers->addMailboxListHeader('To', [new Address('to@symfony.com', 'to')]);
$headers->addMailboxListHeader('Cc', [new Address('cc@symfony.com', 'cc')]);
$headers->addMailboxListHeader('Bcc', [new Address('bcc@symfony.com', 'bcc')]);
$e = SmtpEnvelope::create(new Message($headers));
$e = Envelope::create(new Message($headers));
$this->assertEquals([new Address('to@symfony.com', 'to'), new Address('cc@symfony.com', 'cc'), new Address('bcc@symfony.com', 'bcc')], $e->getRecipients());
}

public function testFromRawMessages()
{
$this->expectException(LogicException::class);

SmtpEnvelope::create(new RawMessage('Some raw email message'));
Envelope::create(new RawMessage('Some raw email message'));
}
}
Loading