python-gmail-api

Connect to the Gmail API using Python 3.

https://github.com/chris-brown-nz/python-gmail-api

Only works for sending at the moment, but I do plan to add other functionality eventually.

Based on and using code from examples at: https://developers.google.com/gmail/api/

Install

This is a step-by-step guide on how to get a message sender going:

1. Install requirements ($ pip3 install -r requirements.txt)
2. Go to Google APIs: https://console.developers.google.com/iam-admin/projects
3. Go Project > Create project
4. Give the project a name and wait for Google to create the project
5. From the list of APIs in the library, select 'Gmail API' and on the next screen click 'Enable'
6. On the left-hand side, click 'Credentials'
7. Click Create credentials > OAuth client ID
8. Click 'Configure consent screen'
9. Enter a Product Name and click save
10. Under 'client ID' choose other. I'm not sure what this is for, I used my project name
11. Click 'OK' to get rid of the popup
12. Click the download icon and save the file to somewhere in your project - rename it, e.g. 'python_gmail_api_client_secret.json'
13. Add the python-gmail-api code to your project.
14. Modify the following as required: CLIENT_SECRET_FILE, CREDENTIAL_FILE, APPLICATION_NAME, MANUAL_AUTH
15. The first time you call the code, you will be asked to go to a URL and after authenticating, copy the auth code into terminal

Usage

CLI

Call script python_gmail_api.py ($ python3 python_gmail_api.pg) directly to send an email from a CLI:

chris@chris-e440:~/projects/python-gmail-api$ python3 python_gmail_api.py
Sender address: c******@gmail.com
To address: c******@gmail.com
Subject: This is a test message
Body: This is a test message
Sending message, please wait...
Message sent. Message ID: 15905******

From within your project

It's really simple, the only method you should call directly is:

gmail_send(sender_address, to_address, subject, body)

Code example:

from python_gmail_api import PythonGmailAPI
sender_address = 'c******@gmail.com'
to_address = 'c******79@gmail.com'
subject = 'Test subject'
body = 'Test body'
PythonGmailAPI().gmail_send(sender_address, to_address, subject, body)

Output example:

chris@chris-e440:~/projects/sandbox/python-gmail-api-test$ python3 test.py
Sending message, please wait...
Message sent. Message ID: 15905******

Testing

The following API test harness is useful for troubleshooting: https://developers.google.com/apis-explorer/?hl=en_GB#p/gmail/v1/

Contact / Support

Please contact me via the 'Issues' tab at: https://developers.google.com/gmail/api/

I'll do my best to answer any queries and address any bugs / change requests.

Changelog

Date	Description
2016-12-16	Initial release. Tested with Gmail API client v1.5.5, Python 3.5, Ubuntu 16.04 64-bit desktop.