The tap-mailgun extractor pulls data from Mailgun that can then be sent to a destination using a loader.
Alternate Implementations
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-mailgun extractor to your
project using
:meltano add -
Configure the tap-mailgun
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-mailgunmeltano config tap-mailgun set --interactivemeltano config tap-mailgun 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-mailgun
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-mailgun 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-mailgun 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.
Base Url (base_url)
-
Environment variable:
TAP_MAILGUN_BASE_URL
All API calls start with a base URL. Mailgun allows the ability to send and receive email in either US region or EU region. Be sure to use the appropriate base URL based on which region you've created your domain in. Default https://api.mailgun.net/v3/.
Configure this setting directly using the following Meltano command:
meltano config tap-mailgun set base_url [value]Event Lookback (event_lookback)
-
Environment variable:
TAP_MAILGUN_EVENT_LOOKBACK
Amount of hours to subtract from the state timestamp, to catch any late-arriving events. Default 1.
Configure this setting directly using the following Meltano command:
meltano config tap-mailgun set event_lookback [value]Full Suppression Sync (full_suppression_sync)
-
Environment variable:
TAP_MAILGUN_FULL_SUPPRESSION_SYNC
If true, suppressions (bounces, unsubscribes and complaints) will be synced in full regardless of start_date. Default, False.
Configure this setting directly using the following Meltano command:
meltano config tap-mailgun set full_suppression_sync [value]Private Key (private_key)
-
Environment variable:
TAP_MAILGUN_PRIVATE_KEY
Authentication is required when using the Mailgun API, you can find your private key inside your Mailgun Control Panel.
Configure this setting directly using the following Meltano command:
meltano config tap-mailgun set private_key [value]Start Date (start_date)
-
Environment variable:
TAP_MAILGUN_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-mailgun set start_date [value]User Agent (user_agent)
-
Environment variable:
TAP_MAILGUN_USER_AGENT
The user agent to send with requests.
Configure this setting directly using the following Meltano command:
meltano config tap-mailgun set user_agent [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
-136-c0c0c4){kind=icon}
-3-c0c0c4){kind=icon}
