Symfony
sponsored by SensioLabs
Menu
  • About
  • Documentation
  • Screencasts
  • Cloud
  • Certification
  • Community
  • Businesses
  • News
  • Download
  1. Home
  2. Documentation
  3. Email
  4. How to Use Gmail to Send Emails
  • Documentation
  • Book
  • Reference
  • Bundles
  • Cloud
Search by Algolia
  • Redefining the Default Configuration Parameters

How to Use Gmail to Send Emails

Edit this page

Warning: You are browsing the documentation for Symfony 3.2, which is no longer maintained.

Read the updated version of this page for Symfony 6.2 (the current stable version).

How to Use Gmail to Send Emails

During development, instead of using a regular SMTP server to send emails, you might find using Gmail easier and more practical. The SwiftmailerBundle makes it really easy.

In the development configuration file, change the transport setting to gmail and set the username and password to the Google credentials:

  • YAML
  • XML
  • PHP
1
2
3
4
5
# app/config/config_dev.yml
swiftmailer:
    transport: gmail
    username:  your_gmail_username
    password:  your_gmail_password
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
<!-- app/config/config_dev.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:swiftmailer="http://symfony.com/schema/dic/swiftmailer"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        http://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/swiftmailer
        http://symfony.com/schema/dic/swiftmailer/swiftmailer-1.0.xsd">

    <!-- ... -->
    <swiftmailer:config
        transport="gmail"
        username="your_gmail_username"
        password="your_gmail_password"
    />
</container>
1
2
3
4
5
6
// app/config/config_dev.php
$container->loadFromExtension('swiftmailer', array(
    'transport' => 'gmail',
    'username'  => 'your_gmail_username',
    'password'  => 'your_gmail_password',
));

Tip

It's more convenient to configure these options in the parameters.yml file:

1
2
3
4
5
# app/config/parameters.yml
parameters:
    # ...
    mailer_user:     your_gmail_username
    mailer_password: your_gmail_password
  • YAML
  • XML
  • PHP
1
2
3
4
5
# app/config/config_dev.yml
swiftmailer:
    transport: gmail
    username:  '%mailer_user%'
    password:  '%mailer_password%'
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
<!-- app/config/config_dev.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:swiftmailer="http://symfony.com/schema/dic/swiftmailer"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        http://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/swiftmailer
        http://symfony.com/schema/dic/swiftmailer/swiftmailer-1.0.xsd">

    <!-- ... -->
    <swiftmailer:config
        transport="gmail"
        username="%mailer_user%"
        password="%mailer_password%"
    />
</container>
1
2
3
4
5
6
// app/config/config_dev.php
$container->loadFromExtension('swiftmailer', array(
    'transport' => 'gmail',
    'username'  => '%mailer_user%',
    'password'  => '%mailer_password%',
));

Redefining the Default Configuration Parameters

The gmail transport is simply a shortcut that uses the smtp transport and sets these options:

Option Value
encryption ssl
auth_mode login
host smtp.gmail.com

If your application uses tls encryption or oauth authentication, you must override the default options by defining the encryption and auth_mode parameters.

If your Gmail account uses 2-Step-Verification, you must generate an App password and use it as the value of the mailer_password parameter. You must also ensure that you allow less secure apps to access your Gmail account.

See also

See the Swiftmailer configuration reference for more details.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.
We stand with Ukraine.
Version:
Get your Sylius expertise recognized

Get your Sylius expertise recognized

Measure & Improve Symfony Code Performance

Measure & Improve Symfony Code Performance

↓ Our footer now uses the colors of the Ukrainian flag because Symfony stands with the people of Ukraine.

Avatar of Paulo Rodrigues Pinto, a Symfony contributor

Thanks Paulo Rodrigues Pinto (@regularjack) for being a Symfony contributor

1 commit • 4 lines changed

View all contributors that help us make Symfony

Become a Symfony contributor

Be an active part of the community and contribute ideas, code and bug fixes. Both experts and newcomers are welcome.

Learn how to contribute

Symfony™ is a trademark of Symfony SAS. All rights reserved.

  • What is Symfony?
    • Symfony at a Glance
    • Symfony Components
    • Case Studies
    • Symfony Releases
    • Security Policy
    • Logo & Screenshots
    • Trademark & Licenses
    • symfony1 Legacy
  • Learn Symfony
    • Symfony Docs
    • Symfony Book
    • Reference
    • Bundles
    • Best Practices
    • Training
    • eLearning Platform
    • Certification
  • Screencasts
    • Learn Symfony
    • Learn PHP
    • Learn JavaScript
    • Learn Drupal
    • Learn RESTful APIs
  • Community
    • SymfonyConnect
    • Support
    • How to be Involved
    • Code of Conduct
    • Events & Meetups
    • Projects using Symfony
    • Downloads Stats
    • Contributors
    • Backers
  • Blog
    • Events & Meetups
    • A week of symfony
    • Case studies
    • Cloud
    • Community
    • Conferences
    • Diversity
    • Documentation
    • Living on the edge
    • Releases
    • Security Advisories
    • SymfonyInsight
    • Twig
    • SensioLabs
  • Services
    • SensioLabs services
    • Train developers
    • Manage your project quality
    • Improve your project performance
    • Host Symfony projects
    Deployed on
Follow Symfony
Search by Algolia