Ballerina MailChimp Marketing Emails connector

Overview

Mailchimp Marketing Email is a powerful and user-friendly platform provided by Intuit Mailchimp, designed for creating, managing, and optimizing targeted email campaigns. It enables businesses to engage customers with personalized marketing emails, automated workflows, and insightful analytics to drive growth and build lasting relationships.

The ballerinax/mailchimp.marketing package provides APIs to connect and interact with the Mailchimp Marketing API v3.0.85, enabling seamless integration with applications to manage marketing email sending, templates, messages, and more.

Setup guide

To use the Mailchimp Marketing Email connector, you need to have a Mailchimp account and access to a API key. Follow the steps below to set up your account and generate the required API key.

Step 1: Create a Mailchimp Account

1. Go to the Mailchimp Sign Up Page and create a Mailchimp account.

2. Once signed in, click on your profile icon in the bottom-left corner to access the account menu.

   

Step 2: Generate a API Key

1. In the menu, go to Extras section and click on API keys.

   

2. Choose Create A Key (not the Mandril API key). You will be redirected to the API Key Generate Dashboard.

   

3. In the API Key dashboard, add a API key name and click Generate Key to generate your key.

   

4. Copy the generated API key. You will need this to authenticate your connector.

Quickstart

To use the Mailchimp Marketing connector in your Ballerina application, update the .bal file as follows:

Step 1: Import the module

Import the mailchimp.marketing module.

import ballerinax/mailchimp.marketing;

Step 2: Configure the API Key

Create a Config.toml file and add your API key obtained from the setup process:

mailchimpApiKey = "<your-mailchimp-marketing-access-token>"

Step 3: Run the Ballerina application

bal run

Examples

The MailChimp Marketing Emails connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:

1. Add Mailchimp Subscriber – Add a new subscriber to a specific Mailchimp audience list.
2. List Mailchimp Audiences – Fetch and display a list of all your Mailchimp audience lists.

Build from the source

Setting up the prerequisites

1. Download and install Java SE Development Kit (JDK) version 21. You can download it from either of the following sources:

   • Oracle JDK
   • OpenJDK

   Note: After installation, remember to set the JAVA_HOME environment variable to the directory where JDK was installed.

2. Download and install Ballerina Swan Lake.

3. Download and install Docker.

   Note: Ensure that the Docker daemon is running before executing any tests.

4. Export Github Personal access token with read package permissions as follows,

   export packageUser=<Username>
   export packagePAT=<Personal access token>

Build options

Execute the commands below to build from the source.

1. To build the package:

   ./gradlew clean build

2. To run the tests:

   ./gradlew clean test

3. To build the without the tests:

   ./gradlew clean build -x test

4. To run tests against different environments:

   ./gradlew clean test -Pgroups=<Comma separated groups/test cases>

5. To debug the package with a remote debugger:

   ./gradlew clean build -Pdebug=<port>

6. To debug with the Ballerina language:

   ./gradlew clean build -PbalJavaDebug=<port>

7. Publish the generated artifacts to the local Ballerina Central repository:

   ./gradlew clean build -PpublishToLocalCentral=true

8. Publish the generated artifacts to the Ballerina Central repository:

   ./gradlew clean build -PpublishToCentral=true

Contribute to Ballerina

As an open-source project, Ballerina welcomes contributions from the community.

For more information, go to the contribution guidelines.

Code of conduct

All the contributors are encouraged to read the Ballerina Code of Conduct.

Useful links

• For more information go to the mailchimp.marketing package.
• For example demonstrations of the usage, go to Ballerina By Examples.
• Chat live with us via our Discord server.
• Post all technical questions on Stack Overflow with the #ballerina tag.