Skip to content

Latest commit

 

History

History
168 lines (132 loc) · 6.37 KB

README.md

File metadata and controls

168 lines (132 loc) · 6.37 KB

MailChimp.Net - A Mail Chimp 3.0 Wrapper

Backers on Open Collective Sponsors on Open Collective

License

MailChimp.Net is licensed under the MIT license.

Quick Start

Install the NuGet package from the package manager console:

Install-Package MailChimp.Net.V3

Using it in code

using MailChimp.Net;
using MailChimp.Net.Interfaces;

IMailChimpManager manager = new MailChimpManager(apiKey); //if you have it in code

<add key="MailChimpApiKey" value="apiKEY" />
IMailChimpManager manager = new MailChimpManager(); //if you have it in config

Hint: MailChimp needs at least TLS 1.2. To use this library you have to set TLS 1.2 in ServicePointManager

ServicePointManager.SecurityProtocol = ServicePointManager.SecurityProtocol | SecurityProtocolType.Tls12;

Examples

// Instantiate new manager
IMailChimpManager mailChimpManager = new MailChimpManager(apiKey);
Getting all lists:
var mailChimpListCollection = await this.mailChimpManager.Lists.GetAllAsync().ConfigureAwait(false);
Getting 50 Lists:
var mailChimpListCollection = await this.mailChimpManager.Lists.GetAllAsync(new ListRequest
                                                               {
                                                                   Limit = 50
                                                               }).ConfigureAwait(false);
Getting Users from List:
var listId = "TestListId";
await this.mailChimpManager.Members.GetAllAsync(listId).ConfigureAwait(false);
Adding New User To List
var listId = "TestListId";
// Use the Status property if updating an existing member
var member = new Member { EmailAddress = $"[email protected]", StatusIfNew = Status.Subscribed };
member.MergeFields.Add("FNAME", "HOLY");
member.MergeFields.Add("LNAME", "COW");
await this.mailChimpManager.Members.AddOrUpdateAsync(listId, member);
Updating An Existing User
// Get reference to existing user if you don't already have it
var listId = "TestListId";
var members = await this.mailChimpManager.Members.GetAllAsync(listId).ConfigureAwait(false);
var member = members.First(x => x.EmailAddress == "[email protected]");

// Update the user
member.MergeFields.Add("FNAME", "New first name");
member.MergeFields.Add("LNAME", "New last name");
await this.mailChimpManager.Members.AddOrUpdateAsync(listId, member);
Adding/Removing a Tag From a User
Tags tags = new Tags();
tags.MemberTags.Add(new Tag() { Name = "Awesome Person", Status = "active" });
await this.mailChimpManager.Members.AddTagsAsync(listId, "[email protected]", tags);

To remove the tag, use "inactive" as the Status.

Status

Progress on full implementation

  • API 100%
  • Authorized Apps 100%
  • Automations 100%
  • Batch Operations 100%
  • Campaigns 100%
  • Campaign Content 100%
  • Campaing Feedback 100%
  • Campaign Folders 100%
  • Campaing Send Checklist 100%
  • Conversations 100%
  • Conversations Messages 100%
  • ECommerce Stores 100%
  • File Manager Files 100%
  • File Manager Folders 100%
  • Lists 100%
  • List Abuse Reports 100%
  • List Activity 100%
  • List Clients 100%
  • List Growth History 100%
  • List Interest Categories 100%
  • List Members 100%
  • List Segments 100%
  • List Web Hooks 100%
  • Template Folders 100%
  • Templates 100%
  • Template Default Content 100%
  • Reports 100%
  • Report Click Reports 100%
  • Report Domain Performance 100%
  • Report EepURL Reports 100%
  • Report Email Activity 100%
  • Report Location 100%
  • Report Sent To 100%
  • Report Sub-Reports 100%
  • Report Unsubscribes 100%
  • ECommerce Carts 100%
  • ECommerce Customers 100%
  • ECommerce Orders 100%
  • ECommerce Order Lines 100%
  • ECommerce Products 100%
  • ECommerce Product Variants 100%

Total 100%

Contributors

This project exists thanks to all the people who contribute. [Contribute].

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]