Automate Laravel MailHog capture configuration

[tyler36]

The Issue

Laravel requires additional configuration to work with DDEV's Mailhog.

With current setup, sending an email results in the following exception:

   Symfony\Component\Mailer\Exception\TransportException  Connection could not be established with host "mailpit:1025": stream_socket_client(): php_network_getaddresses: getaddrinfo for mailpit failed: Temporary failure in name resolution.

How This PR Solves The Issue

This PR add MAIL_HOST=127.0.0.1 to the project's .env.

Manual Testing Instructions

1. Follow quickstart guide for a Laravel project. You should see the Laravel "Welcome page"

2. Launch Mailhog to watch for email:

   ddev launch -m

3. Enter "tinker mode" by typing the following command:

   ddev artisan tinker

4. Copy and past (or type) the following command into "tinker mode". This will attempt to send an email which should be caught by Mailhog.:

   Illuminate\Support\Facades\Mail::raw('Hello World!', function($msg) {$msg->to('example@example.com')->subject('Test Email'); });

5. Type exit to exit "tinker mode".

Note: if you make changes to .env (or any php file), you need to exit and re-enter "tinker mode" for changes to apply.

Related Issue Link(s)

Fixes #4821

Release/Deployment Notes

Recent versions of DDEV automate the database settings, so it seems consistent to include the mail server.

Developers are free to opt out of DDEV managing this using currently documented best practises.

[github-actions]

Download the artifacts for this pull request:

• all-ddev-executables.zip
• ddev-linux-amd64.zip
• ddev-linux-arm64.zip
• ddev-macos-amd64.zip
• ddev-macos-arm64.zip
• ddev-windows-amd64-installer.zip

[rfay]

Doesn't it need the port as well, 1025?

[tyler36]

The port is set to 1025 by default.

Composer copies over the .env.example which has the following mail related settings:

MAIL_MAILER=smtp
MAIL_HOST=mailhog
MAIL_PORT=1025
MAIL_USERNAME=null
MAIL_PASSWORD=null
MAIL_ENCRYPTION=null
MAIL_FROM_ADDRESS="hello@example.com"
MAIL_FROM_NAME="${APP_NAME}"

You can see that the default mail host doesn't work OOTB.

[tyler36]

Update PR to include port if you would prefer it in

[rfay]

1025 is an unusual default mail port (25 is normal). Oh, I see, it's already there MAIL_PORT=1025. But we didn't have MAIL_HOST set right. Thanks.

[rfay]

It doesn't look like the "send email" instructions are adequate for a novice like me to manually test. Can you add more detail about how to do it? Thanks!

[tyler36]

I updated the description to try and make it simpler. As long as you have a working Laravel install, you should be able to enter "tinker mode" (REPL). REPL allows you to run PHP commands in a bootstraped environment.

The command in the description tries to send an email; it it should be a simple copy/paste.

Let me know if you are getting a specific error message.

[tyler36]

I have a ddev artisan command in my global commands. It has the #ddev-generated so I assume it's in the standard install right?

[rfay]

Yes, ddev artisan is provided as an official command for projects of type laravel, see https://ddev.readthedocs.io/en/latest/users/usage/cli/#lots-of-other-commands

[rfay]

That also means the quickstart could use it instead of ddev exec

[rfay]

Added

• [docs] Add some missing commands to commands.md #4824

[rfay]

Thanks for tinker mode! Let me know when this is ready for review.

[rfay]

Sorry I haven't tested yet, will get to it!

[rfay]

Works perfectly, code is good, thanks so much. thanks for the good testing instructions.