Skip to content

TTMSFNCCloudMailChimpMarketing

Usage

A component that provides access to the MailChimp Marketing API. It allows the user to manage & send campaigns, create audiences and add members to it.

Authorization information

API Key

Properties

Property name Description
Lists a TObjectList containing all lists, is filled using the GetLists Method
Members a TObjectList containing all members for a list on the current page, is filled using all the different GetMembers Method
Campaigns a TObjectList containing all Campaigns, is filled using the GetCampaigns Method

Methods

Method name Description
GetLists(ACount: Integer = 100; ANextPage: boolean = true) Fetches all mailing lists with information
GetListInfo(AListID: string) Fetches the information of one list
AddList(AList: TTMSFNCCloudMailChimpSubscriberList) Add a mailing list with the information provided in AList
UpdateList(AList: TTMSFNCCloudMailChimpSubscriberList) Update A list with new settings
DeleteList(Alist: TTMSFNCCloudMailChimpSubscriberList) Delete A list
GetMembers(AList: TTMSFNCCloudMailChimpSubscriberList; ACount: Integer = 100; AOffset: Integer = 0) Fetches members from a List
GetAllMembers(AList: TTMSFNCCloudMailChimpSubscriberList; ACount: Integer = 100; ANextPage: boolean = true) Fetches ALL members from a list
GetNextMembers(AList: TTMSFNCCloudMailChimpSubscriberList; ACount: Integer = 100) Fetches the next page of members
GetPreviousMembers(AList: TTMSFNCCloudMailCHimpSubscriberList; ACount: Integer = 100) Fetches the previous page of members
GetCurrentMembers(AList: TTMSFNCCloudMailCHimpSubscriberList; ACount: Integer = 100) fetches the current page of members
GetFirstMembers(Alist: TTMSFNCCloudMailChimpSubscriberList; ACount: Integer = 100) fetches the first page of members
GetMemberInfo(AListID: String; AMemberEmail: string) get the detailed information about a member
AddMember(AListID: string; AMember: TTMSFNCCloudMailChimpListMember; ASkipMergeValidation: Boolean = false) add a member defined in AMember
UpdateMember(AMember: TTMSFNCCloudMailChimpListMember; ASkipMergeValidation: Boolean = false) Update the member with the settings in AMember
ArchiveMember(AMember: TTMSFNCCloudMailChimpListMember) Archive a member but do not delete it from the list
DeleteMember(AMember: TTMSFNCCloudMailChimpListMember) Delete a member completly
GetCampaigns(ACount: Integer = 100; AList: TTMSFNCCloudMailChimpSubscriberList = nil; ANextPage: boolean = true) Fetches all campaigns. IF Alist is defined, only the campaigns for that list
AddCampaign(ACampaign: TTMSFNCCloudMailChimpCampaign) Add A campaign
GetCampaignInfo(ACampaignID: string) Get the information about a certain campaign
GetCampaignContent(ACampaign: TTMSFNCCloudMailChimpCampaign) Get the content for the email campaign
SetCampaignContent(ACampaign: TTMSFNCCloudMailChimpCampaign; AHTML: string; APlainText: string = '') Update the content for the email campaign. Plaintext will be auto generated when not defined
UpdateCampaignSettings(ACampaign: TTMSFNCCloudMailChimpCampaign) Update the settings for the campaign
DeleteCampaign(ACampaign: TTMSFNCCloudMailChimpCampaign) Delete a campaign
SendCampaign(ACampaign: TTMSFNCCloudMailChimpCampaign) Send the campaign to all subscribers

Code Snippets

Adding a list

var
  L: TTMSFNCCloudMailChimpSubscriberList;
begin
  L := TTMSFNCCloudMailChimpSubscriberList.Create;
  L.Contact.Company := CompanyEdit.Text;
  L.Contact.Address1 := AdressEdit.Text;
  L.Contact.Country := CountryEdit.Text;
  L.Contact.City := CityEdit.Text;
  L.PermissionReminder := PermissionReminderEdit.Text;
  L.CampaignDefaults.Language := LanguageEdit.Text;
  L.CampaignDefaults.FromEmail := FromEmailEdit.Text;
  L.CampaignDefaults.FromName := FromNameEdit.Text;
  L.CampaignDefaults.Subject := SubjectEdit.Text;
  L.ListName := ListNameEdit.Text;
  L.Contact.Zip := ZipEdit.Text;
  TMSFNCCloudMailChimpMarketing1.AddList(L);

Updating a list

var
  L: TTMSFNCCloudMailChimpSubscriberList;
begin
  L := TMSFNCCloudMailChimpMarketing1.Lists[0];
  L.Contact.Company := CompanyEdit.Text;
  L.Contact.Address1 := AdressEdit.Text;
  L.Contact.Country := CountryEdit.Text;
  L.Contact.Zip := ZipEdit.Text;
  L.Contact.City := CityEdit.Text;
  L.PermissionReminder := PermissionReminderEdit.Text;
  L.CampaignDefaults.Language := LanguageEdit.Text ;
  L.CampaignDefaults.FromEmail := FromEmailEdit.Text;
  L.CampaignDefaults.FromName := FromNameEdit.Text;
  L.CampaignDefaults.Subject := SubjectEdit.Text;
  L.ListName := ListNameEdit.Text;

  TMSFNCCloudMailChimpMarketing1.UpdateList( L);