GMail CSV/Excel Attachments

tap-gmail-csv from food-spotter

CSV/Excel attachments/urls from a GMail Mailbox

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

Getting Started


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

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

  1. Add the tap-gmail-csv extractor to your project using
    meltano add
  2. meltano add extractor tap-gmail-csv
  3. Configure the tap-gmail-csv settings using
    meltano config
  4. meltano config tap-gmail-csv set --interactive
  5. Test that extractor settings are valid using
    meltano config
  6. meltano config tap-gmail-csv test

Next steps

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


The current capabilities for tap-gmail-csv 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:

  • catalog
  • discover
  • state

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


The tap-gmail-csv 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:

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.

Pickle Base64 Encoded (pickle_base64_encoded)

  • Environment variable: TAP_GMAIL_CSV_PICKLE_BASE64_ENCODED

A Google generated pickle file encoded in base64 for authentication.

Start Date (start_date)

  • Environment variable: TAP_GMAIL_CSV_START_DATE

Determines how much historical data will be extracted. Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.

Tables (tables)

  • Environment variable: TAP_GMAIL_CSV_TABLES

An array of table configurations including - name, pattern, key_properties, format (csv or excel), source_type (attachment, url), and see the config contract for more details on optional table configs available.

Email Address (email_address)

  • Environment variable: TAP_GMAIL_CSV_EMAIL_ADDRESS

The Gmail account you're connecting to.

Gmail Search Query (gmail_search_query)

  • Environment variable: TAP_GMAIL_CSV_GMAIL_SEARCH_QUERY

Your search query to apply. The date-time filter is auto applied at runtime. E.g. "to:"

Gmail Label (gmail_label)

  • Environment variable: TAP_GMAIL_CSV_GMAIL_LABEL

The gmail label to search against.

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-csv 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


meltano add extractor tap-gmail-csv

Maintenance Status

  • Maintenance Status
  • Stars
  • Forks
  • Open Issues
  • Open PRs
  • Contributors
  • License


  • food-spotter

Meltano Stats

  • Projects (Last 3 Months)


  • api