tap-gmail - Meltano Hub

GMail

tap-gmail (meltanolabs variant)🥇

Email service provided by Google

The tap-gmail extractor pulls data from GMail that can then be sent to a destination using a loader.

Alternate Implementations

Mashey
Meltano (default)🥇

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

Installation and configuration

Add the tap-gmail extractor to your project using
```
meltano add
```
:

meltano add extractor tap-gmail

Configure the tap-gmail settings using

meltano config

:

meltano config tap-gmail set --interactive

Test that extractor settings are valid using

meltano config

:

meltano config tap-gmail test

Next steps

Follow the remaining steps of the Getting Started guide:

If you run into any issues, learn how to get help.

Capabilities

The current capabilities for tap-gmail may have been automatically set when originally added to the Hub. Please review the capabilities when using this extractor. If you find they are out of date, please consider updating them by making a pull request to the YAML file that defines the capabilities for this extractor.

This plugin has the following capabilities:

about
catalog
discover
schema-flattening
state
stream-maps

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-gmail settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

messages.include_spam_trash
messages.q
oauth_credentials.client_id
oauth_credentials.client_secret
oauth_credentials.refresh_token
user_id

Expand To Show SDK Settings

flattening_enabled
flattening_max_depth
stream_map_config
stream_maps

You can also list these settings using

meltano config

with the list subcommand:

meltano config tap-gmail list

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

Messages Include Spam Trash (messages.include_spam_trash)

Environment variable: TAP_GMAIL_MESSAGES_INCLUDE_SPAM_TRASH
Default Value: false

Include messages from SPAM and TRASH in the results.

Configure this setting directly using the following Meltano command:

meltano config tap-gmail set messages include_spam_trash [value]

Messages Q (messages.q)

Environment variable: TAP_GMAIL_MESSAGES_Q

Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid:somemsgid@example.com is:unread". Parameter cannot be used when accessing the api using the gmail. Metadata scope. https://developers.google.com/gmail/api/reference/rest/v1/users.messages/list#query-parameters

Configure this setting directly using the following Meltano command:

meltano config tap-gmail set messages q [value]

OAuth Credentials Client ID (oauth_credentials.client_id)

Environment variable: TAP_GMAIL_OAUTH_CREDENTIALS_CLIENT_ID

Your google client_id

Configure this setting directly using the following Meltano command:

meltano config tap-gmail set oauth_credentials client_id [value]

OAuth Credentials Client Secret (oauth_credentials.client_secret)

Environment variable: TAP_GMAIL_OAUTH_CREDENTIALS_CLIENT_SECRET

Your google client_secret

Configure this setting directly using the following Meltano command:

meltano config tap-gmail set oauth_credentials client_secret [value]

OAuth Credentials Refresh Token (oauth_credentials.refresh_token)

Environment variable: TAP_GMAIL_OAUTH_CREDENTIALS_REFRESH_TOKEN

Your google refresh token

Configure this setting directly using the following Meltano command:

meltano config tap-gmail set oauth_credentials refresh_token [value]

User ID (user_id)

Environment variable: TAP_GMAIL_USER_ID

Your Gmail User ID

Configure this setting directly using the following Meltano command:

meltano config tap-gmail set user_id [value]

Expand To Show SDK Settings

Flattening Enabled (flattening_enabled)

Environment variable: TAP_GMAIL_FLATTENING_ENABLED

'True' to enable schema flattening and automatically expand nested properties.

Configure this setting directly using the following Meltano command:

meltano config tap-gmail set flattening_enabled [value]

Flattening Max Depth (flattening_max_depth)

Environment variable: TAP_GMAIL_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.

Configure this setting directly using the following Meltano command:

meltano config tap-gmail set flattening_max_depth [value]

Stream Map Config (stream_map_config)

Environment variable: TAP_GMAIL_STREAM_MAP_CONFIG

User-defined config values to be used within map expressions.

Configure this setting directly using the following Meltano command:

meltano config tap-gmail set stream_map_config [value]

Stream Maps (stream_maps)

Environment variable: TAP_GMAIL_STREAM_MAPS

Config object for stream maps capability. For more information check out Stream Maps.

Configure this setting directly using the following Meltano command:

meltano config tap-gmail set stream_maps [value]

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the tap-gmail extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the

#plugins-general

channel.

Install

meltano add extractor tap-gmail

Maintenance Status

Repo

https://github.com/MeltanoLabs/tap-gmail

Maintainer

Meltano Stats

PyPI Stats

Keywords