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
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-gmail-csv extractor to your
project using
:meltano add -
Configure the tap-gmail-csv
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-gmail-csvmeltano config tap-gmail-csv set --interactivemeltano config tap-gmail-csv testNext 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-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.
Settings
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 also list these settings using
with the meltano configlist
subcommand:
meltano config tap-gmail-csv 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.
Email Address (email_address)
-
Environment variable:
TAP_GMAIL_CSV_EMAIL_ADDRESS
The Gmail account you're connecting to.
Configure this setting directly using the following Meltano command:
meltano config tap-gmail-csv set email_address [value]Gmail Label (gmail_label)
-
Environment variable:
TAP_GMAIL_CSV_GMAIL_LABEL
The gmail label to search against.
Configure this setting directly using the following Meltano command:
meltano config tap-gmail-csv set gmail_label [value]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: me+finance@gmail.com"
Configure this setting directly using the following Meltano command:
meltano config tap-gmail-csv set gmail_search_query [value]Pickle Base64 Encoded (pickle_base64_encoded)
-
Environment variable:
TAP_GMAIL_CSV_PICKLE_BASE64_ENCODED
A Google generated pickle file encoded in base64 for authentication.
Configure this setting directly using the following Meltano command:
meltano config tap-gmail-csv set pickle_base64_encoded [value]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.
Configure this setting directly using the following Meltano command:
meltano config tap-gmail-csv set start_date [value]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.
Configure this setting directly using the following Meltano command:
meltano config tap-gmail-csv set tables [value]Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-general
