Skip to main content

Gmail API Wrapper - Python Client

Project description

Gmail API Wrapper For Python
============================

This is a wrapper for the `google-api-python-client` library by Google.


Behind the scenes
----------------

* *Language*: Python_
* *Testing*: Tox_, Pytest_, Coverage_, Flake8_
* *Deploying*: Ansible_
* *CI*: CircleCI_
* *Code*: Github_


Installation
------------

.. code:: bash

pip install --upgrade gmail-api-wrapper


Setup
-----

`gmail-api-wrapper` uses OAuth authentication

Generate a client ID and client secret Here_ under section
**Step 1: Turn on the Gmail API**. Follow steps **a** to **h**.

After you have downloaded the `client_secret.json` file,
move it to the `~/.credentials/` directory in your home directory.


Env Variables
----------------------------------------------

Set the following `env` variables.

- Get scopes from GMAIL_SCOPES_

.. code:: bash

# Space delimited string
export GAW_SCOPES="'gmail-scopes-1 'gmail-scope-2'"

# client_secret json file path

# If you're using custom SSL certs, set GAW_CA_CERTS_PEM_FILE env variable
export GAW_CA_CERTS_PEM_FILE=<path-to-custom-pem-ssl-cert>

# The user Id to use. Default to 'me'. A special identifier for gmail
# that refers to the email address used to do OAuth2 handshake
export GAW_USER_ID=<your@gmail.address>

# Your preferred application name. Defaults to 'Gmail API Wrapper'
export GAW_APPLICATION_NAME=<your-preferred-application-name>

# Disable ssl certs validation. Defaults to False
export GAW_DISABLE_SSL_CERTS=True


- View the permissions_granted_ to you application



Usage - READ
------------

.. code:: python

from gmail_api_wrapper.crud.read import GmailAPIReadWrapper


gmail_api = GmailAPIReadWrapper()


# Check unread messages. Returns a list of dicts in the below format
gmail_api.check_new_mail()

>>> [

{
'subject': 'Sample Subject',
'base64_msg_body': 'base64string',
'from:' 'exapmle@mail_server.com'
'date': '2017-09-16T10:57:12.4323'
},
]

# Check new mail from specific sender. Returns a list of dicts above
gmail_api.check_new_mail(sender='example@mail_server.com')



# Alternatively, you get all unread messages from a specific sender
gmail_api.get_unread_messages(sender='example@mail_server.com')

>>> [

{
'subject': 'Sample Subject',
'base64_msg_body': 'base64string',
'from:' 'exapmle@mail_server.com'
'date': '2017-09-16T10:57:12.4323'
},
]




# Get all labels present. Returns a list of strings
gmail_api.get_labels()

>>> ['INBOX', 'UNREAD', 'SPAM', 'DRAFTS']



# Get total message count. Returns a formatted json object
gmail_api.get_total_messages()

>>> {
'Total Messages': 2017,
'Total Threads': 123,
'Email Address': 'example@mail_server.com'
}


# Get a list of messages. Defaults to INBOX if no label is specified
gmail_api.list_messages()

>>> [

{
'subject': 'Sample Subject',
'base64_msg_body': 'base64string',
'from:' 'exapmle@mail_server.com'
'date': '2017-09-16T10:57:12.4323'
},
]


# Get a list of messages in DRAFTS and SPAM
gmail_api.list_messages(labels=['DRAFTS', 'SPAM'])

>>> [

{
'subject': 'Sample Subject',
'base64_msg_body': 'base64string',
'from:' 'exapmle@mail_server.com'
'date': '2017-09-16T10:57:12.4323'
},
]


# Get a specific message. `message_id` passed must be a google message id object
gmail_api.get_message('message_id')


Usage - WRITE
-------------

.. code:: python

from gmail_api_wrapper.crud.write import GmailAPIWriteWrapper

api = GmailAPIWriteWrapper()


# compose new mail
api.compose_mail(subject='API Wrapper', body='Py client', to='email1,email2')

>>> {
'id': 'blah-blah',
'labelsIds': ['INBOX', 'SENT', 'UNREAD'],
'threadId': 'blah-blah'
}

# compose new mail with cc and bcc
api.compose_mail(subject='API Wrapper', body='Py client', to='email1,email2', cc='email1,email2', bcc='email1,email2')

>>> {
'id': 'blah-blah',
'labelsIds': ['INBOX', 'SENT', 'UNREAD'],
'threadId': 'blah-blah'
}

# create new label
api.create_label(name='Integrations')

>>> {
'id': 'blah-blah',
'labelListVisibility': 'labelShow',
'messageListVisibility': 'show',
'name': 'Integrations'
}


Authors
-------

* yoda <dee.caranja@gmail.com>


.. _Python: https://www.python.org/
.. _Tox: https://tox.readthedocs.io/en/latest/
.. _Pytest: http://doc.pytest.org/en/latest/
.. _Coverage: https://coverage.readthedocs.io/en/coverage-4.2/
.. _Flake8: http://flake8.pycqa.org/en/latest/
.. _Ansible: http://docs.ansible.com/ansible/index.html
.. _CircleCI: https://circleci.com/gh/yoda-yoda/gmail-api-wrapper
.. _Github: https://github.com/yoda-yoda/gmail-api-wrapper
.. _Here: https://developers.google.com/gmail/api/quickstart/python
.. _GMAIL_SCOPES: https://developers.google.com/gmail/api/auth/scopes/
.. _permissions_granted: https://accounts.google.com/b/0/IssuedAuthSubTokens


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for gmail-api-wrapper, version 0.1.1a3
Filename, size File type Python version Upload date Hashes
Filename, size gmail_api_wrapper-0.1.1a3-py3-none-any.whl (15.0 kB) File type Wheel Python version py3 Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page