Skip to main content

MailGun

This page contains the setup guide and reference information for the MailGun source connector.

Prerequisites

Api key is mandate for this connector to work, It could be seen at Mailgun dashboard at settings, Navigate through API Keys section and click on the eye icon next to Private API key See reference. Just pass the generated API key for establishing the connection.

Setup guide

Step 1: Set up MailGun connection

  • Generate an API key (Example: 12345)
  • Params (If specific info is needed)
  • Available params
    • Domain Region Code: Domain region code. 'EU' or 'US' are possible values. The default is 'US'.
    • Replication Start Date: UTC date and time in the format 2020-10-01 00:00:00. Any data before this date will not be replicated. If omitted, defaults to 90 days ago.

Step 2: Set up the MailGun connector in Airbyte

For Airbyte Cloud:

  1. Log into your Airbyte Cloud account.
  2. In the left navigation bar, click Sources. In the top-right corner, click +new source.
  3. On the Set up the source page, enter the name for the MailGun connector and select MailGun from the Source type dropdown.
  4. Enter your api_key as private_key.
  5. Enter the optional params configuration if needed. Supported params are: Domain Region Code, Replication Start Date.
  6. Click Set up source.

For Airbyte OSS:

  1. Navigate to the Airbyte Open Source dashboard.
  2. Set the name for your source.
  3. Enter your api_key as pivate_key.
  4. Enter the optional params configuration if needed. Supported params are: Domain Region Code, Replication Start Date.
  5. Click Set up source.

Supported sync modes

The MailGun source connector supports the following sync modes:

FeatureSupported?
Full Refresh SyncYes
Incremental SyncYes
Replicate Incremental DeletesNo
SSL connectionYes
NamespacesNo

Supported Streams

  • domains
  • events

API method example

GET https://api.mailgun.net/v3/domains

Performance considerations

MailGun's API reference has v3 at present and v4 is at development. The connector as default uses v3.

Reference

Config fields reference

Field
Type
Property name
string
private_key
string
domain_region
string
start_date

Changelog

Expand to review
VersionDatePull RequestSubject
0.2.82024-06-0639229[autopull] Upgrade base image to v1.2.2
0.2.72024-05-2838176Make connector compatible with Builder
0.2.62024-05-0237594Change last_recrods to last_record
0.2.52024-04-1937193Updating to 0.80.0 CDK
0.2.42024-04-1837193Manage dependencies with Poetry.
0.2.32024-04-1537193Base image migration: remove Dockerfile and use the python-connector-base image
0.2.22024-04-1237193schema descriptions
0.2.12023-10-1631405Fixed test connection failure if date field is empty
0.2.02023-08-0529122Migrate to Low Code
0.1.12023-02-1322939Specified date formatting in specification
0.1.02021-11-098056New Source: Mailgun