[Mailer] add File transport #31947

Kocal · 2019-06-08T07:02:40Z

Q	A
Branch?	4.4
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	#31819
License	MIT
Doc PR	symfony/symfony-docs#11702

This PR add the file transport to the Mailer component which is useful when running integrations tests.

I've taken this idea from SwiftMailer, but without the spool behavior. It just saves messages to the filesystem and nothing else.

It's supposed to be used like this:

# .env.test
MAILER_URL=file://null?path=%kernel.project_dir%/var/emails

Sent message will now be saved in the directory %kernel.project_dir%/var/emails, in a .message file.

What do you think about it?
Thanks!

Kocal · 2019-06-08T07:20:27Z

Hum, I'm not sure how to make it working on Windows since file://C:\Users\appveyor\AppData\Local\Temp\1/symfony/emails is not a valid DNS. 😕

Any ideas?

src/Symfony/Component/Mailer/Transport/FileTransport.php

Kocal · 2019-06-21T11:10:04Z

Status: Needs review

Kocal · 2019-06-27T16:39:53Z

PR has been rebased and conflicts resolved.
However I had to remove a test from #31993 because it tried to create the directory /some/path (which fails), and I don't know any valid scheme that let me not specify a host. :/

Kocal · 2019-06-27T19:22:07Z

Travis/AppVeyor failures are unrelated I think.

Kocal · 2019-07-01T05:29:22Z

Status: Needs review

I've just updated the way we pass a path in order to be compatible with Windows, since file://C:\path/to/symfony-project/var/emails is not a valid DSN.
Now we use path query parameter. WDYT?

Before:

MAILER_URL=file://%kernel.project_dir%/var/emails

After:

MAILER_URL=file://null?path=%kernel.project_dir%/var/emails

Travis & AppVeyor failures are still unrelated.

Kocal · 2019-07-17T08:13:46Z

I've resolved conflicts and squashed everything.
It should be good now.

EDIT: this travis failure seems to be unrelated.

Koc · 2019-07-21T00:52:41Z

Nice to see that you've adopted PR to changes introduced in #31946 .

I've just updated the way we pass a path in order to be compatible with Windows, since file://C:\path/to/symfony-project/var/emails is not a valid DSN. Now we use path query parameter. WDYT?

You should use urls like file:///c:/windows/My%20Documents%20100%2520/foo.txt, it correctly parsed.

Koc · 2019-07-21T00:57:23Z

src/Symfony/Component/Mailer/Transport/FileTransport.php

+    protected function doSend(SentMessage $message): void
+    {
+        $file = $this->path.'/'.uniqid().'.message';
+        $serializedMessage = serialize($message);


How integration test will looks like? Why not save in .eml format?

I didn't know about .eml files. In my project, we exposed a endpoint only available in dev/test env that list *.message file and which display message details like from, to, subject and body. It was consumed by Cypress and it worked well.

But if it can be easily parsed with PHP or JS, why not.

src/Symfony/Component/Mailer/Transport/FileTransportFactory.php

Kocal · 2019-07-21T05:40:22Z

You should use urls like file:///c:/windows/My%20Documents%20100%2520/foo.txt, it correctly parsed.

Indeed that better, but it means there is no actual solution to make it usable in Windows with a symfony parameter like this MAILER_URL=file://%kernel.project_dir%/var/emails? 🤔

This PR was merged into the 4.4 branch. Discussion ---------- [Mailer] Add message events logger | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | yes | BC breaks? | no  | Deprecations? | no  | Tests pass? | yes  | Fixed tickets | refs #31592, refs #32409, refs #31947, refs #31747 | License | MIT | Doc PR | n/a To allow testing emails and for the web profiler, we need a way to store all sent/queued messages. Commits ------- 7642178 [Mailer] added message events logger

fabpot · 2019-08-04T18:39:27Z

I think that testing emails is orthogonal to the transport. See #32930 for an implementation that allows to receive the email AND test it at the same time in functional tests.

Kocal · 2019-08-05T03:50:15Z

If you use PHPUnit for functional tests yes, but I'm actually using Cypress (JavaScript) for E2E tests (like a password-reset functionality + email).

That's why it was nice to have emails persisted in the filesystem (or somewhere else in fact), with a Symfony controller for displaying sent emails, Cypress were actually able to see them (and click on a button inside the mail, for example).

But since #31946 has been merged, I will be able to re-implement the file transport.

…for the Mailer (fabpot) This PR was merged into the 4.4 branch. Discussion ---------- [Mailer][Mime] Add PHPUnit constraints and assertions for the Mailer | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | yes | BC breaks? | no  | Deprecations? | no  | Tests pass? | yes  | Fixed tickets | refs #31592, closes #32409, closes #31947, closes #31747, closes #30850 | License | MIT | Doc PR | n/a This PR introduces PHPUnit constraints and assertions to ease testing emails in functional tests: ```php <?php namespace App\Tests; use Symfony\Bundle\FrameworkBundle\Test\WebTestCase; class MailerAssertionsTraitsTest extends WebTestCase { public function testSomething() { $client = static::createClient(); $client->request('GET', '/'); $this->assertEmailCount(2); $this->assertEmailIsQueued($this->getMailerEvent(0)); $email = $this->getMailerMessage(0); $this->assertEmailHasHeader($email, 'To'); $this->assertEmailHeaderSame($email, 'To', 'fabien@symfony.com'); $this->assertEmailTextBodyContains($email, 'Bar'); $this->assertEmailHtmlBodyContains($email, 'Foo'); $this->assertEmailAttachementCount($email, 1); } } ``` Commits ------- 23f237b added PHPUnit constraints and assertions for the Mailer

carsonbot added Status: Needs Review Feature labels Jun 8, 2019

OskarStark approved these changes Jun 8, 2019

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Jun 8, 2019

Kocal mentioned this pull request Jun 8, 2019

[Mailer] document FileTransport symfony/symfony-docs#11702

Closed

nicolas-grekas added this to the next milestone Jun 8, 2019

noniagriconomie reviewed Jun 8, 2019

View reviewed changes

src/Symfony/Component/Mailer/Transport/FileTransport.php Outdated Show resolved Hide resolved

src/Symfony/Component/Mailer/Transport/FileTransport.php Show resolved Hide resolved

Koc suggested changes Jun 11, 2019

View reviewed changes

src/Symfony/Component/Mailer/Transport/FileTransport.php Outdated Show resolved Hide resolved

carsonbot added Status: Needs Work and removed Status: Reviewed labels Jun 11, 2019

OskarStark reviewed Jun 12, 2019

View reviewed changes

src/Symfony/Component/Mailer/Transport/FileTransport.php Show resolved Hide resolved

carsonbot added Status: Needs Review and removed Status: Needs Work Status: Needs Review labels Jun 21, 2019

noniagriconomie approved these changes Jun 27, 2019

View reviewed changes

carsonbot added the Status: Reviewed label Jun 27, 2019

carsonbot added Status: Needs Review and removed Status: Reviewed labels Jul 1, 2019

fabpot added the Mailer label Jul 9, 2019

Koc reviewed Jul 21, 2019

View reviewed changes

src/Symfony/Component/Mailer/Transport/FileTransportFactory.php Show resolved Hide resolved

Koc mentioned this pull request Jul 24, 2019

[Mailer][DX][RFC] Rename mailer bridge transport classes #32609

Merged

feat(mailer): add File Transport

006c4d2

fabpot mentioned this pull request Aug 4, 2019

[Mailer] Add message events logger #32927

Merged

fabpot mentioned this pull request Aug 4, 2019

[Mailer][Mime] Add PHPUnit constraints and assertions for the Mailer #32930

Merged

fabpot closed this Aug 4, 2019

romaricdrigon mentioned this pull request Sep 13, 2019

[Mailer] Adding a "file" transport #33563

Closed

nicolas-grekas modified the milestones: next, 4.4 Oct 27, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Mailer] add File transport #31947

[Mailer] add File transport #31947

Kocal commented Jun 8, 2019 •

edited

Loading

Kocal commented Jun 8, 2019

Kocal commented Jun 21, 2019

Kocal commented Jun 27, 2019

Kocal commented Jun 27, 2019

Kocal commented Jul 1, 2019 •

edited

Loading

Kocal commented Jul 17, 2019 •

edited

Loading

Koc commented Jul 21, 2019

Koc Jul 21, 2019

Kocal Jul 21, 2019 •

edited

Loading

Kocal commented Jul 21, 2019

fabpot commented Aug 4, 2019

Kocal commented Aug 5, 2019

[Mailer] add File transport #31947

[Mailer] add File transport #31947

Conversation

Kocal commented Jun 8, 2019 • edited Loading

Kocal commented Jun 8, 2019

Kocal commented Jun 21, 2019

Kocal commented Jun 27, 2019

Kocal commented Jun 27, 2019

Kocal commented Jul 1, 2019 • edited Loading

Kocal commented Jul 17, 2019 • edited Loading

Koc commented Jul 21, 2019

Koc Jul 21, 2019

Choose a reason for hiding this comment

Kocal Jul 21, 2019 • edited Loading

Choose a reason for hiding this comment

Kocal commented Jul 21, 2019

fabpot commented Aug 4, 2019

Kocal commented Aug 5, 2019

Kocal commented Jun 8, 2019 •

edited

Loading

Kocal commented Jul 1, 2019 •

edited

Loading

Kocal commented Jul 17, 2019 •

edited

Loading

Kocal Jul 21, 2019 •

edited

Loading