The author selected the Open Source Initiative to receive a donation as part of the Write for DOnations program.
Introduction
Laravel is a free, open source PHP framework, based on Symfony and used for creating web applications. SendGrid is a cloud-based SMTP provider that allows you to send email without having to maintain email servers.
Having a contact form on your website makes it easier for your visitors to contact you directly. For your contact form to work correctly and send out emails, you need an SMTP server. This tutorial will use SendGrid and their free SMTP service to deliver the emails sent out from the website contact form to an email inbox.
In this tutorial, you’ll add a contact form to an existing Laravel application and configure it to send emails via SMTP using SendGrid.
Prerequisites
If you don’t already have a Laravel application set up, you will need the following:
- Access to an Ubuntu 20.04 server as a non-root user with sudo privileges, and an active firewall installed on your server. To set these up, please refer to our Initial Server Setup Guide for Ubuntu 20.04.
- The LEMP stack installed on your server by following the How to Install Nginx, MySQL and PHP on Ubuntu 20.04.
- Composer to install Laravel and its dependencies. You can install Composer by following our guide on How to Install Composer on Ubuntu 20.04.
- Laravel installed and configured on your server. If you don’t have Laravel already installed, you can follow our How To Install and Configure Laravel with Nginx on Ubuntu 20.04 tutorial.
After you have set up your Laravel application, you’ll also need the following:
- A SendGrid account. You can visit the SendGrid registration page to sign up for a free SendGrid account.
- A fully registered domain name pointed to your server. This tutorial will use
your_domainthroughout. You can purchase a domain name on Namecheap, get one for free on Freenom, or use the domain registrar of your choice. For DigitalOcean, you can follow this introduction to DigitalOcean DNS for details on how to add them.
Step 1 — Creating the Sender Identity
SendGrid requires you to verify the ownership of your domain name before allowing you to start sending emails. In order to verify your domain name, go to your SendGrid account, then go to the Dashboard and click on Authenticate your Domain.
This will take you to a page where you will need to specify your DNS host and choose if you would like to brand the links for your domain. Email link branding allows you to set all of the links used for click-tracking in your emails to your domain instead of from sendgrid.net.
Then click Next and on the next page, specify your domain name.
Finally, you will need to add the DNS records provided by SendGrid to complete their verification process. For more information on how to manage your DNS records, you can read this tutorial on How to Create, Edit, and Delete DNS Records.
Once you have added the DNS records to your DNS zone, go back to SendGrid and hit the Verify button.
With your SendGrid Identity verified, you need to generate an API key, which you will use in your Laravel .env file.
From the menu on the left, click on API Keys and then click on the Create API Key button. For security, set the API Key Permissions to Restricted Access.
After that, scroll down and add the Mail Send permissions.
Finally, click on the Create View button to get your API key. The API key will only be visible once, so be sure to take note of it in a secure place.
Now that you’ve configured your domain with SendGrid and generated your API key, you’ll configure the SMTP details for your Laravel application.
Step 2 — Configuring the SMTP Details
The .env file in Laravel is used to store various configuration options for your application environment. Since there is usually some sensitive information in the .env file, like your database connection details, you should not commit the .env file to source control.
If you completed the prerequisite tutorial, you’ll need to be in the /var/www/travellist directory to access your .env file:
- cd /var/www/travellist
After that, use your favorite text editor open the .env file:
- nano .env
There are many configuration variables in the .env file—in this tutorial you’ll only change the MAIL variables.
To do so, find the MAIL_ settings and configure the variables as following, adding in your copied API key to sendgrid_api_key and updating the other highlighted fields as necessary:
.env
. . .MAIL_MAILER=smtpMAIL_HOST=smtp.sendgrid.netMAIL_PORT=587MAIL_USERNAME=apikeyMAIL_PASSWORD=sendgrid_api_keyMAIL_ENCRYPTION=tls. . .The following list contains an overview of the variables that have to be updated in order for your Laravel application to start using the SendGrid SMTP server:
MAIL_HOST: The SendGrid SMTP hostname, which will be used for sending out emails.MAIL_PORT: The SendGrid secure TLS SMTP port.MAIL_USERNAME: Your SendGrid username. By default, it isapikeyfor all accounts.MAIL_PASSWORD: Your SendGrid API Key.MAIL_ENCRYPTION: The mail encryption protocol. In this case you will use TLS as it secures the email content during the transfer between the servers.
Save and exit the file.
With your SMTP settings in place, you are ready to proceed and configure your contact controller.
Step 3 — Creating the Controller
Next you’ll create a controller that will handle your POST and GET requests for your contact form page.
You’ll use the GET route to return the HTML page containing your contact form, and the POST route will handle the contact form submissions.
In order to create a controller called ContactController in Laravel, use the following artisan command:
- php artisan make:controller ContactController
After running the command, you will get the following output:
OutputController created successfully.This command will create a new controller at app/Http/Controllers/ContactController.php.
Run the following to edit the ContactController.php file:
- nano app/Http/Controllers/ContactController.php
First, you’ll include the Laravel Mail facade so that you can use the mail functionality in your new controller. A facade in Laravel is a class that provides access to different Laravel features. For more information about Laravel facades, take a look at the official Laravel Facades documentation.
To include the Laravel Mail facade add the following:
app/Http/Controllers/ContactController.php
?phpnamespace AppHttpControllers;use IlluminateHttpRequest;use Mail;. . .Then add the method that will handle your GET requests and return the contact page view:
app/Http/Controllers/ContactController.php
. . .class ContactController extends Controller{ public function contact(){ return view('contact'); }}Finally, let’s add a method that will handle the POST requests and send out the emails:
app/Http/Controllers/ContactController.php
...class ContactController extends Controller{ public function contact(){ return view('contact'); } public function contactPost(Request $request){ $this-validate($request, [ 'name' = 'required', 'email' = 'required|email', 'comment' = 'required' ]); Mail::send('email', [ 'name' = $request-get('name'), 'email' = $request-get('email'), 'comment' = $request-get('comment') ], function ($message) { $message-from('youremail@your_domain'); $message-to('youremail@your_domain', 'Your Name') -subject('Your Website Contact Form'); }); return back()-with('success', 'Thanks for contacting me, I will get back to you soon!'); }}Within the highlighted lines, you’ll need to change some of the variables, like so:
-
$message-from('youremail@your_domain');: Change theyouremail@your_domainwith your actual email address. -
$message-to('youremail@your_domain', 'Your Name'): The$message-toand the$message-fromdo not necessarily need to match. You can also change the$message-tovalue with another email address to which you would like to receive all of your contact form inquiries. -
subject('Your Website Contact Form');: You can also change the email subject by editing the message inside thesubjectmethod.
Note: the $message-from('youremail@your_domain'); address needs to match the domain name that you used with SendGrid.
Once you’ve finished these edits, the following will be your full ContactController.php file:
app/Http/Controllers/ContactController.php
?phpnamespace AppHttpControllers;use IlluminateHttpRequest;use Mail;class ContactController extends Controller{ public function contact(){ return view('contact'); } public function contactPost(Request $request){ $this-validate($request, [ 'name' = 'required', 'email' = 'required|email', 'comment' = 'required' ]); Mail::send('email', [ 'name' = $request-get('name'), 'email' = $request-get('email'), 'comment' = $request-get('comment') ], function ($message) { $message-from('youremail@your_domain'); $message-to('youremail@your_domain', 'Your Name') -subject('Your Website Contact Form'); }); return back()-with('success', 'Thanks for contacting me, I will get back to you soon!'); }}Save and exit your file once you’ve finished your edits.
Your Contact Controller has two methods:
contact(): This method returns your contact Blade view template, which will hold your HTML page that has the HTML layout for your contact form. Blade is the templating engine that comes with Laravel. In your Blade template views, you can add your HTML structure along with PHP code and Blade syntax.contactPost(): This method handles all of the contact form submissions—where you handle the input validation and send out the emails.
You handle the validation inside the contactPost() method with the $this-validate() method. Inside the validation method, you specify that the name, email, and comment are required. That way, your users will not be able to submit empty or incomplete contact form inquiries. For more information on how the Laravel validation works, take a look at the official Laravel Validation documentation.
When validation is successful, the Mail::send() method constructs your email body and subject and then sends out the email.
Finally, if the email was sent successfully, you return a success message that displays to your users.
You’ve set up your contact controller and can now move on to GET and POST routes.
Step 4 — Creating the Routes
Laravel routes allow you to create SEO-friendly URLs for your application. By using Laravel routes, you can route your application requests to specific controllers, where you handle your application logic.
You’ll create two routes in your routes/web.php file to use the methods you set up in the previous step.
You will first create a GET route that maps to your contact method in your ContactController. This method only returns your contact Blade view. Open routes/web.php with the following command:
- nano routes/web.php
Add the GET route at the bottom of the file:
Note: If you followed the prerequisites, you’ll have different content in you routes/web.php file. You can add your routes to the end of this file as per the instructions in this tutorial.
routes/web.php
?phpuse IlluminateSupportFacadesRoute;/*|--------------------------------------------------------------------------| Web Routes|--------------------------------------------------------------------------|| Here is where you can register web routes for your application. These| routes are loaded by the RouteServiceProvider within a group which| contains the "web" middleware group. Now create something great!|*/Route::get('/contact', 'ContactController@contact')-name('contact');You’ll now add a POST route and map it to your contactPost method, which will handle your user contact form submissions:
routes/web.php
?phpuse IlluminateSupportFacadesRoute;/*|--------------------------------------------------------------------------| Web Routes|--------------------------------------------------------------------------|| Here is where you can register web routes for your application. These| routes are loaded by the RouteServiceProvider within a group which| contains the "web" middleware group. Now create something great!|*/Route::get('/contact', 'ContactController@contact')-name('contact');Route::post('/contact', 'ContactController@contactPost')-name('contactPost');Once you have your Controller and Route ready, you can save and exit your file then proceed to the next step where you will prepare your Blade views.
Step 5 — Creating the Blade Views
In this step you will start by creating a view in the application that will hold your HTML contact form. It will have three input fields:
- Input field with type text for the email address of the user
- Input field with type text for the name of the user
- Text area for the comment
Create a file called resources/views/contact.blade.php:
- nano resources/views/contact.blade.php
Then add the following content:
resources/views/contact.blade.php
!DOCTYPE htmlhtmlhead meta charset="UTF-8" meta name="viewport" content="width=device-width, initial-scale=1.0" titleContact Form with Laravel and SendGrid/title link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/css/bootstrap.min.css" integrity="sha384-JcKb8q3iqJ61gNV9KGb8thSsNjpSL0n8PARn9HuZOnIxN0hoP+VmmDGMN5t9UJ0Z" crossorigin="anonymous"/headbody div @if(session('success')) div {{ session('success') }} /div @endif form method="POST" action="/contact" @csrf div label for="email"Email address/label input name="email" type="email" aria-describedby="emailHelp" placeholder="Enter your email" span{{ $errors-first('email') }}/span /div div label for="name"Name/label input name="name" type="text" aria-describedby="name" placeholder="Your name" span{{ $errors-first('name') }}/span /div div label for="exampleInputPassword1"Comment/label textarea name="comment" rows="3"/textarea span{{ $errors-first('comment') }}/span /div button type="submit"Submit/button /form /div/body/htmlThis is an HTML form with a POST method to the /contact route. When someone fills out the contact form, it’ll be handled by your contactPost method.
The link tag inside the head tag is used to include Bootstrap. You’re using some styling for the HTML form. You can change the style of the form so that it matches the design of your website. For more information on how to style your website, you can take a look at our CSS resources page.
The form is wrapped up in different div tags with classes from Bootstrap. You’re using the div tags to create the structure of the contact form. For more information on how the div tags work, check out the How To Use a div, the HTML Content Division Element tutorial.
Save and exit this file.
The next view that you’ll create is your email view.
Open the resources/views/email.blade.php file:
- nano resources/views/email.blade.php
Then add the following content:
resources/views/email.blade.php
Inquiry from: {{ $name }}p Email: {{ $email }} /pp Message: {{ $comment }} /pThis contains the email content that will be sent to users that complete your contact form. Save and exit the file.
With the styling and views complete, you’re ready to go ahead and test the contact form.
Step 6 — Testing the Contact Form
To test the contact form, visit http://your_domain/contact via your browser.
You’ll see the Bootstrap HTML form that you created in the previous step.
Complete all of the required fields and hit the Submit button. You will receive a green notification that the message was sent successfully.
You can test the form by submitting it without filling any of the fields. The validation that you added in your controller will catch that and it’ll inform you that the fields must not be empty.
Finally, you can check your email account and make sure that you’ve received the test email and you can see it in your inbox.
Conclusion
You have now successfully added a contact form to your existing Laravel website.
You can also find more information in the official Laravel documentation.
To make sure that your contact form is secure, you can install an SSL certificate for your website by following our guide on How To Secure Nginx with Let’s Encrypt.
To learn more about Laravel, check out our collection of Laravel resources.