Gmail API Client Libraries

The Gmail API is built on HTTP and JSON, so any standard HTTP client can send requests to it and parse the responses.

However, the Google APIs client libraries provide better language integration, improved security, and support for making calls that require user authorization. The client libraries are available in a number of programming languages; by using them you can avoid the need to manually set up HTTP requests and parse the responses.

Go

Get the latest Gmail API client library for Go (alpha). Read the client library's developer's guide.

Java

This page contains information about getting started with the Gmail API by using the Google API Client Library for Java. For more information, see the following documentation:

Browse the Javadoc reference for the Gmail API.
Read the Developer's Guide for the Google API Client Library for Java.

Add the client library to your project

Select your build environment (Maven or Gradle) from the following tabs:

Maven

Add the following to your pom.xml file:

See all versions available on the Maven Central Repository.

Gradle

Add the following to your build.gradle file:

See all versions available on the Maven Central Repository.

JavaScript

Read the client library's developer's guide.

.NET

This page contains information about getting started with the Gmail API by using the Google API Client Library for .NET. For more information, see the following documentation:

Browse the .NET reference documentation for the Gmail API.
Read the Developer's guide for the Google API Client Library for .NET.

Downloading the library

Install the NuGet package: Google.Apis.

Python

This page contains information about getting started with the Gmail API by using the Google API Client Library for Python. For more information, see the following documentation:

Browse the PyDoc reference for the Gmail API.
Read the Developer's guide for the Google API Client Library for Python.

System requirements

Operating systems:
- Linux
- macOS X
- Windows
Python 2.7, or 3.4 or higher

Install the client library

You can either use a package manager or manually download and install the Python client library:

Managed install

Use pip or setuptools to manage your installation. You might need to run sudo first.

pip (preferred):

pip install --upgrade google-api-python-client

Setuptools:

easy_install --upgrade google-api-python-client

Manual install

Download the latest client library for Python.
Unpack the code.
Install:
```
python setup.py install
```

App Engine

Because the Python client libraries aren't installed in the App Engine Python runtime environment, you must copy them into your application just like third-party libraries.

Ruby

This page contains information about getting started with the Gmail API by using the Google API Client Library for Ruby. For more information, see the following documentation:

Read the Get started guide for the Google API Client Library for Ruby.

Install the `google-api-client` gem

Depending on your system, you might need to prepend these commands with sudo.

If you haven't installed the Google API Client Library for Ruby before, install by using RubyGems:

gem install google-api-client

If you already have the gem installed, update to the latest version:

gem update -y google-api-client

Get started with the Google API Client Library for Ruby

To learn how to make your first request, see the Get started guide.