Welcome to Django GSuite Email’s documentation!

This package allows to use Django’s send_mail command to send emails through GSuite account.

It requires a serviceaccount credential created in Google coud console, The crendential file need to have https://www.googleapis.com/auth/gmail.send scope.

Follow this tutorial to create the credentials file, make sure to add https://www.googleapis.com/auth/gmail.send scope.

Installing

Install Django GSuite Email with

pip install django-gsuite-email

Usage

  1. Add to installed apps in setings.py:

    INSTALLED_APPS = [
    ...
    'django_gsuite_email',
    ...
]

  2. Set the Email EMAIL_BACKEND setting:

    EMAIL_BACKEND = 'django_gsuite_email.GSuiteEmailBackend'

  3. Send emails:

    from django.core.mail import send_mail

send_mail(
    'Subject here',
    'Here is the message.',
    'from@example.com',
    ['to@example.com'],
    fail_silently=False,
)

Indices and tables