sptec/gmail-api-mailer-bundle

Symfony Mailer Transport for Gmail API including Google OAuth2 authentication.

dev-main 2022-10-23 16:44 UTC

Requires

• php: >=7.4
• google/apiclient: ^2.0
• symfony/config: ^5.4|^6.0
• symfony/dependency-injection: ^5.4|^6.0
• symfony/mailer: ^5.4|^6.0

Requires (Dev)

• phpstan/extension-installer: ^1.1
• phpstan/phpstan: ^1.8
• phpstan/phpstan-symfony: ^1.2
• phpunit/phpunit: ^9.5
• symfony/http-client: ^5.4|^6.0
• symfony/phpunit-bridge: ^5.4|^6.0
• symplify/easy-coding-standard: ^11.1

MIT

• Stefan Poensgen

• mailer
• symfony
• gmail

README

Symfony Mailer Transport for Gmail API including Google OAuth2 authentication.

Requirements

• Symfony >= 5.4

Installation

Step 1: Download the Bundle

Use Composer to install this bundle:

composer require sptec/gmail-api-mailer-bundle

Step 2: Enable the Bundle

// config/bundles.php

return [
    // ...
    Sptec\GmailApiMailerBundle\SptecGmailApiMailerBundle => ['all' => true],
];

Configuration

Google API Client

If you don't use Symfony Flex you have create the following configuration

# config/packages/google_apiclient.yaml
services:
  Google_Client:
    class: Google_Client
    calls:
      - [setClientId, ['%env(GOOGLE_CLIENT_ID)%']]
      - [setClientSecret, ['%env(GOOGLE_CLIENT_SECRET)%']]

.env

###> google/apiclient ###
GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=
###< google/apiclient ###

###> symfony/mailer ###
MAILER_DSN=gmail+api://null
###< symfony/mailer ###

Usage

bin/console sptec:google:auth

Your Google access token will be stored as json environment variable GOOGLE_ACCESS_TOKEN by using Symfony's secrets management system.

Google Credentials

1. Open the Google Cloud console.
2. At the top-left, click Menu menu > APIs & Services > Credentials.
3. Click Create Credentials > OAuth client ID.
4. Click Application type > Web application.
5. Enter a name for the OAuth client ID. (e.g. Symfony Gmail API Mailer)
6. Add authorized redirect URIs. (default: http://localhost)
7. Click Create.