Email backend for Django which sends email via the Gmail API through a JSON credential
Project description
django-gmailapi-json-backend
Email backend for Django which sends email via the Gmail API through a JSON credential
The simple SMTP protocol is disabled by default for Gmail users, since this is included in the Less Secure Apps (LSA) category. This package implements the Gmail API directly with a JSON Google service account as a Django email backend and can be used with 'django-mailer'.
Requirements
Python 3.9+
Installation
The package is available through pip. To easily install or upgrade it, do
pip install --upgrade django-gmailapi-json-backend
Configuration
In your settings.py
:
- Add the module into the INSTALLED_APPS
INSTALLED_APPS = [ ... 'gmailapi_backend', ... ]
- Set the email backend
EMAIL_FROM = 'Company<your-email@domain.com>' GMAIL_USER = 'your-email@domain.com' EMAIL_BACKEND = "gmailapi_backend.service.GmailApiBackend" GMAIL_SCOPES = ['https://www.googleapis.com/auth/gmail.send'] GOOGLE_SERVICE_ACCOUNT = '{ "type": "service_account", "project_id": "your-project", "private_key_id": ... }'
If you use django-mailer as email backend you can send through gmail API as follow:EMAIL_BACKEND = "mailer.backend.DbBackend" MAILER_EMAIL_BACKEND = "gmailapi_backend.service.GmailApiBackend"
How to create the Google service account
- Create a project on the developer console at https://console.cloud.google.com (it must be a Google Workspace account, not a simple gmail account)
- Enable the gmail api from the library menu
- On API and services > Credentials, create a new service account as a JSON you should use for GOOGLE_SERVICE_ACCOUNT
- Copy your client id from the menu IAM and administration > service account. Click on the service you have just created, find the unique id and copy it.
- Move to the administrator console at https://admin.google.com/ and choose your user (i.e. EMAIL_FROM)
- Go to Security > Data access and control > API controls > Delegation at domain level and add a new one with your client id and the services you need like https://www.googleapis.com/auth/gmail.send to send email through API.
Usage
Use the native EmailMessage
class in Django. Just a sample:
message = render_to_string('email/ordine_pagato.html', {
'ordine': ordine,
})
mail_subject = _('This is just a sample')
email = EmailMessage(
mail_subject, message, settings.EMAIL_FROM, to=['recipient@domain.com']
)
email.content_subtype = "html"
email.attach(sample_file.file.name, sample_file.file.read(), 'application/pdf')
email.send()
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for django_gmailapi_json_backend-1.10.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 004e152428a0d766a6a25b1ef983948c15bdf3909ea60c5fa167af1885232851 |
|
MD5 | 94cd3359fb251a88bc1aa61e556e9abb |
|
BLAKE2b-256 | 19657411bdce243eadda6fd35c479099ad06a4b959daadd791e38c0adaef1042 |
Close
Hashes for django_gmailapi_json_backend-1.10-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 58ae00130e0616a930b57bda2e3f146ea23dea3b535fbeb0a3fcfbba4d6e22ae |
|
MD5 | a54acb275198dc6e10a1d0f6577d0cd7 |
|
BLAKE2b-256 | 79c56bf2036be1bbb4d5648fc671f2f29c13a88ca351dda4606d391b1a8d39ce |