https://github.com/treasure-data/embulk-output-mailchimp
Embulk output plugin for Mailchimp
https://github.com/treasure-data/embulk-output-mailchimp
Last synced: 11 months ago
JSON representation
Embulk output plugin for Mailchimp
- Host: GitHub
- URL: https://github.com/treasure-data/embulk-output-mailchimp
- Owner: treasure-data
- License: mit
- Created: 2015-11-17T08:16:08.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-11-08T17:31:30.000Z (over 1 year ago)
- Last Synced: 2025-04-23T13:59:13.888Z (about 1 year ago)
- Language: Java
- Homepage: https://docs.treasuredata.com/articles/result-into-mailchimp
- Size: 357 KB
- Stars: 6
- Watchers: 90
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Mailchimp output plugin for Embulk
[](https://coveralls.io/github/treasure-data/embulk-output-mailchimp?branch=master)
[](https://travis-ci.org/treasure-data/embulk-output-mailchimp?branch=master)
add e-mail to List in MailChimp.
## Overview
* **Plugin type**: output
* **Load all or nothing**: no
* **Resume supported**: no
* **Cleanup supported**: no
## Configuration
- **auth_method**: MailChimp auth method (string, `api_key` or `oauth`, default: `api_key`)
- **apikey**: MailChimp API key (string, required if `auth_method` is `api_key`)
- **access_token**: MailChimp access token (string, required if `auth_method` is `oauth`)
- **list_id**: MailChimp List id (string, required)
- **email_column**: column name for email (string, default: 'email')
- **fname_column**: column name for first name (string, default: 'fname')
- **lname_column**: column name for last name(string, default: 'lname')
- **update_existing**: control whether to update members that are already subscribed to the list or to return an error (boolean, default: false)
- **merge_fields**: Array for additional merge fields/ TAG in MailChimp dashboard (array, optional, default: nil)
- **grouping_columns**: Array for group names in MailChimp dashboard(array, default: nil)
- **language_column**: column name for language (string, optional, default: nil)
- **double_optin**: control whether to send an opt-in confirmation email (boolean, default: true)
- **atomic_upsert** : Control the atomicity for the job. Job will be marked as success only when there is no error from Mailchimp. Default as false.
- **max_records_per_request**: The max records per batch request. MailChimp API enables max records is 500 per batch request (int, default: 500)
- **sleep_between_requests_millis**: The time to sleep between requests to avoid flood MailChimp API (int, default: 3000)
## Example
```yaml
out:
type: mailchimp
auth_method: api_key
apikey: 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-XXX'
list_id: 'XXXXXXXXXX'
update_existing: false
double_optin: false
atomic_upsert: false
email_column: e-mail
fname_column: first name
lname_column: lname
merge_fields:
- website
grouping_columns:
- interests
- location
replace_interests: true
```
## Build
```
$ ./gradlew gem
```