Mailgun

tap-mailgun from streetteam

Transactional Email API Service

The tap-mailgun extractor pulls data from Mailgun 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:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

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

Next steps

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

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.

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/.

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.

User Agent (user_agent)

  • Environment variable: TAP_MAILGUN_USER_AGENT

The user agent to send with requests.

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.

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.

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

Maintenance Status

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

Maintainer

  • Pollen

Keywords

  • api