Jump to content
daniels

Subscribe To Mailchimp

Recommended Posts

This is a lightweight alternative to other newsletter & newsletter-subscription modules.

You can find the Module in the Modules directory and on Github

It can subscribe, update, unsubscribe & delete a user in a list in Mailchimp with MailChimp API 3.0. It does not provide any forms or validation, so you can feel free to use your own. To protect your users, it does not save any user data in logs or sends them to an admin.

This module fits your needs if you...

  • ...use Mailchimp as your newsletter / email-automation tool
  • ...want to let users subscribe to your newsletter on your website
  • ...want to use your own form, validation and messages (with or without the wire forms)
  • ...don't want any personal user data saved in any way in your ProcessWire environment (cf. EU data regulation terms)
  • ...like to subscribe, update, unsubscribe or delete users to/from different lists
  • ...like the Mailchimp UI for creating / sending / reviewing email campaigns

*I have only tested it with PHP 7.x so far, so use on owners risk :)

EDIT:

I've updated the module to 0.0.4. I removed the instructions from this forum, so I don't have to maintain it on multiple places. Just checkout the readme on github 🙂

If you have questions or like to contribute, just post a reply or create an issue or pr on github. 

  • Like 14

Share this post


Link to post
Share on other sites

Thanks for sharing Daniels!

It would be a good idea to make it backwards compatible with PHP 5.5 so that it works on older installations otherwise mention that it has PHP 7 dependency.

Regards!

  • Like 2

Share this post


Link to post
Share on other sites

I made it work with PHP 5.x just by changing one line.

SubscribeToMailchimp.module - Line 23 - before:

public function subscribe(string $email, array $data = [], string $list = "") {

SubscribeToMailchimp.module - Line 23 - after:

public function subscribe( $email,  $data = [],  $list = "") {

This works without any problems so far.

  • Like 3

Share this post


Link to post
Share on other sites

Hey, thanks for the feedback @giannisok and for the solution @wbmnfktr.

I have just updated to version 0.0.2 with the ability to unsubscribe and delete users. I also removed the 'string' type declarations, hope it works now with your PHP version @giannisok .

When I have the time I'll change my dev machine setup, so I can test with different PHP versions. But since I use Valet, I think I can only downgrade to php5.6 anyway.

  • Like 3

Share this post


Link to post
Share on other sites

Hi, Daniels,

thanks for sharing this! I have just ran into an issue while testing:

After successful initial subscription of an user, I could unsubscribe him again, but after that no more subscription of the same user would work.

Is this due to a limitation of Mailchimp?

Share this post


Link to post
Share on other sites

@Mikel Pretty sure you can’t subscribe to a list you previously unsubscribed from. It’s a Mailchimp “feature”. 

  • Like 1

Share this post


Link to post
Share on other sites

Hey @Mikel, seams like with the original mailchimp subscribe forms, it is possible (and in my opinion it should be) to resubscribe. I will have a look on that! Thanks for the input. 

 

Meanwhile (e.g. for testing) you can use the delete method to completely delete and resubscribe a user. That is working for me with the current version.

  • Like 2

Share this post


Link to post
Share on other sites
Just now, jacmaes said:

@Mikel Pretty sure you can’t subscribe to a list you previously unsubscribed from. It’s a Mailchimp “feature”. 

Ok, thanks, I was not sure, so, in my special use case it will be better not to unsubscribe the user, but to delete him.

So if he likes to subscribe again in the future, he will get added again. 

Share this post


Link to post
Share on other sites
Just now, daniels said:

Hey @Mikel, seams like with the original mailchimp subscribe forms, it is possible (and in my opinion it should be) to resubscribe. I will have a look on that! Thanks for the input. 

 

Meanwhile (e.g. for testing) you can use the delete method to completely delete and resubscribe a user. That is working for me with the current version.

Thanks, thats just what I implemented and testet this moment. Working flawless :-)

Share this post


Link to post
Share on other sites

Hi @daniels,

many thanks for that great module! As a little helper, I added a checkbox to the modules config page that can test the current settings.

If you don't mind, I sent you a pull request.

Spoiler

screen_mc_01.jpg.2942d7d8e600e4daffe012203cd77e63.jpg

screen_mc_02.thumb.jpg.2126b3c5a773e0a2364b89ef9a86f053.jpg

screen_mc_03.thumb.jpg.72d7f8a7ecf98c847901d8f2d3da8d64.jpg

screen_mc_04.thumb.jpg.816fadabfb86e4b59baa044490efc5f5.jpg

 

  • Like 3

Share this post


Link to post
Share on other sites

@horst this is awesome!! Thank you, I will totally merge it in. It looks really great and is super helpful. I didn't even know, that this is possible via the module settings 😃

I also had a look at the issue mentioned by @Mikel . To resubscribe users (and I think this is indispensable) I had to add a getStatus method and change how the subscription method works. Now if a user resubscribes, he will get the double-opt-in mail again.

I made a PR for this too, maybe you can take a look. I will merge both PRs than to version 0.0.3 (and hopefully don't mess it up .... :D) later this week. 

https://github.com/danielstieber/SubscribeToMailchimp/pull/2

  • Like 3

Share this post


Link to post
Share on other sites

Thank you for the modules. it's so great!
I don't know if some one have already try but, Is it possible to integrate this in the loginRegister module?
I try to looking in the validation process of the module but I think at moment need make an hook to ___processRegisterForm, is it correct? If yes How I can do the hook?

thank you.

Share this post


Link to post
Share on other sites

Thank you for the feedback  @MarcoPLY 

I've not worked with loginRegister and hooks yet. If you or someone finds a solution, please share it in here 🙂

  • Like 1

Share this post


Link to post
Share on other sites

I've created an issue regarding features of MailChimp, that currently can't be used with the module. Also I'd like to make it more flexible, if Mailchimp roles out new stuff.

My question to you:

Do you currently use this MailChimp features or would like to have it in the module?

- Groups (Interests) (Setup up 

- VIP

- manually fill IP, Language and/or Location

  • Like 1

Share this post


Link to post
Share on other sites
25 minutes ago, daniels said:

manually fill IP, Language and/or Location

Not IP, but language / gender + location

  • Thanks 1

Share this post


Link to post
Share on other sites

I've just rolled out version 0.0.3 - checkout the changelog .

You should be able to update without any changes in your code. 

  • Like 3
  • Thanks 1

Share this post


Link to post
Share on other sites

Updated to version 0.0.4  - checkout the changelog .

The Github user ml-s fixed a major issue, where you could not use a Mailchimp core function, the ADDRESS mergefield.

  • Like 3
  • Thanks 1

Share this post


Link to post
Share on other sites

How can I use this moule for all users who are saved with a specific category?

I'm not sure which Class and method need to use and also maybe I not get the correct fields.

wire()->addHookAfter('Pages::saved', function($event) {
	$page = $event->arguments(0);

	if($page->template == "user"){

		if ($user->hasRole('login-facebook')) {

			$mc = $modules->get("SubscribeToMailchimp");
			$email = $page->email;
			$subscriber = [
				'FNAME' => $page->pad_firstname,
				'MMERGE4' => $page->$country_title,
			];
			$mc->subscribe($email, $subscriber);

		}

	}

});

 

 

 

Share this post


Link to post
Share on other sites

Hey @MarcoPLY ,

not sure if I get it right, but do you want to add user to specific categories?

In the API naming, groups are called 'interests'. You can add them as additional parameters as in the example below.

To get the interest IDs is a little pain-in-the-ass but I'll try to guide you:

1. Go to  https://api.mailchimp.com/playground/ and enter your API key.

2. Click on 'Lists' and choose 'interest-categories' from the 'Subcategories' of your related list.

3. Choose 'interest' from 'Subcategories' of your related interest category

4. Now you can click on each interest and you'll get the id which should be the ID that you have to use in the 'interests' part of the example below.

 

Please let me know if this works for you! When I find some time, I'll add a way to get these ids in the module Settings in PW admin.

 

Example from the docs:

// Work with additional parameters (not merge_field values!)
$mc->subscribe('john.doe@example.com', NULL, NULL, [
	'language' => 'en', // find language list here: https://kb.mailchimp.com/lists/manage-contacts/view-and-edit-contact-languages#Language-Codes
	'vip' => true, // boolean vip status
	'location' => [ // geo location based on lat/log coordinates 
		'latitude' => '48.8722344',
		'longitude', => '2.7736192'
	],
	'interests' => [ // subscribe user to interest categories / groups based on group id
		'32fec3561e' => true, 
		'63mel4395m' => false
	]
]);

 

Share this post


Link to post
Share on other sites

Ok @MarcoPLY , I think I got your question completely wrong 😄 I leave my reply anyway if someone needs it one day...

Have you tried to var_dump the subscriber? What do you get there?

Is the $ before country_title intentional?

  • Like 1

Share this post


Link to post
Share on other sites

Hi @daniels, thank you for your reapply! eheh, yes you have right. I explain better what I have to do

In addition to the  loginRegister module I also use the registration via Facebook. This registration bypasses the registration form and don't send the data to mailchimp. 

I thought about making a hook for all the users that are registered, regardless of the method. Then use Pages::saved (I'm not sure it's right) and pass data to mailchimp when the user's page is created.

But the attempts I tried don't work, I'm probably wrong the way I access the data. Do you know how can I create this action, to send the data to mailchimp when the users page it's created?

(Sorry, I have thought just now that maybe this was a question to put in general)

Share this post


Link to post
Share on other sites

No worries 🙂 I suggest testing the subscribe function in a normal doc with test data. If this works (which should :)) try to dump your real data wherever you want to implement the subscription. If you can var_dump the right data there, you should be able to perform the subscription there 🙂

Let me know if you have questions regarding the module itself or run into errors there.

  • Like 1

Share this post


Link to post
Share on other sites

Hello,

my first time using this module and need some help.

I created a new list an setup everything in module settings. But not sure how to create a subscribe form on frontend of my site. 

Any help is appreciated

Thank you

R

Share this post


Link to post
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.


  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By Mike Rockett
      Jumplinks for ProcessWire
      Release: 1.5.56
      Composer: rockett/jumplinks
      Jumplinks is an enhanced version of the original ProcessRedirects by Antti Peisa.
      The Process module manages your permanent and temporary redirects (we'll call these "jumplinks" from now on, unless in reference to redirects from another module), useful for when you're migrating over to ProcessWire from another system/platform. Each jumplink supports wildcards, shortening the time needed to create them.
      Unlike similar modules for other platforms, wildcards in Jumplinks are much easier to work with, as Regular Expressions are not fully exposed. Instead, parameters wrapped in curly braces are used - these are described in the documentation.
      Under Development: 2.0, to be powered by FastRoute
      As of version 1.5.0, Jumplinks requires at least ProcessWire 2.6.1 to run.
      View on GitLab
      Download via the Modules Directory
      Read the docs
      Features
      The most prominent features include:
      Basic jumplinks (from one fixed route to another) Parameter-based wildcards with "Smart" equivalents Mapping Collections (for converting ID-based routes to their named-equivalents without the need to create multiple jumplinks) Destination Selectors (for finding and redirecting to pages containing legacy location information) Timed Activation (activate and/or deactivate jumplinks at specific times) 404-Monitor (for creating jumplinks based on 404 hits) Additionally, the following features may come in handy:
      Stale jumplink management Legacy domain support for slow migrations An importer (from CSV or ProcessRedirects) Feedback & Feature Requests
      I’d love to know what you think of this module. Please provide some feedback on the module as a whole, or even regarding smaller things that make it whole. Also, please feel free to submit feature requests and their use-cases.
      Note: Features requested so far have been added to the to-do list, and will be added to 2.0, and not the current dev/master branches.
      Open Source

      Jumplinks is an open-source project, and is free to use. In fact, Jumplinks will always be open-source, and will always remain free to use. Forever. If you would like to support the development of Jumplinks, please consider making a small donation via PayPal.
      Enjoy! :)
    • By BitPoet
      As threatened in Ryan's announcement for 3.0.139, I built a little module for sliding toggles as a replacement for checkboxes. Styling of the input is CSS3 only (with all the usual caveats about older browsers), no JS necessary, and may still be a bit "rough around the edges", so to speak, since I didn't have much time for testing on different devices or brushing things up enough so I'd feel comfortable pushing it to the module directory. But here's the link to the GitHub repo for now:
      InputfieldSlideToggle
      Fieldtype and Inputfield that implements smartphone-style toggles as replacement for checkbox inputs. The visualization is CSS-only, no additional JS necessary.
      Status
      Still very alpha, use with caution!
      Features / Field Settings
      Size
      You can render the toggles in four different sizes: small, medium, large and extra large.
      Off Color
      Currently, "unchecked" toggles can be displayed either in grey (default) or red.
      On Color
      "Checked" toggles can be rendered in one of these colors: blue (default), black, green, grey, orange or red.
      Screenshots

      Some examples with checkbox label


      View all Size and Color Combinations
      Small toggles Medium toggles Big toggles Extra big toggles  









    • By Orkun
      Hi Guys
      I needed to add extended functionalities for the InputfieldDatetime Module (module is from processwire version 2.7.3) because of a Request of Customer.
      So I duplicated the module and placed it under /site/modules/.
      I have added 3 new Settings to the InputfieldDatetime Module.
      1. Day Restriction - Restrict different days based on weekdays selection (e.g. saturday, sunday) - WORKING

       
      2. Time Slots - Define Time slots based on custom Integer Value (max is 60 for 1 hour) - WORKING

       
      3. Time Range Rules per Weekday - Define a minTime and MaxTime per Weekday (e.g. Opening Hours of a Restaurant) - NOT WORKING PROPERLY

       
      The Problem
      Time Slots and Day Restriction working fine so far. But the Time Range Rules per Weekday doesn't work right.
      What should happen is, that when you click on a date, it should update the minTime and maxTime of the Time Select.
      But the change on the select only happens if you select a date 2 times or when you select a date 1 time and then close the datepicker and reopen it again.
      The time select doesn't get change when you select a date 1 time and don't close the picker.
      Here is the whole extended InputfieldDatetime Module.
      The Files that I have changed:
      InputfieldDatetime.module InputfieldDatetime.js jquery-ui-timepicker-addon.js (https://trentrichardson.com/examples/timepicker/) - updated it to the newest version, because minTime and maxTime Option was only available in the new version  
      Thats the Part of the JS that is not working correctly:
      if(datetimerules && datetimerules.length){ options.onSelect = function(date, inst) { var day = $(this).datetimepicker("getDate").getDay(); day = day.toString(); var mintime = $(this).attr('data-weekday'+day+'-mintime'); var maxtime = $(this).attr('data-weekday'+day+'-maxtime'); console.log("weekday: "+day); console.log("minTime: "+mintime); console.log("maxTime: "+maxtime); var optionsAll = $(this).datetimepicker( "option", "all" ); optionsAll.minTime = mintime; optionsAll.maxTime = maxtime; $(this).datetimepicker('destroy'); $(this).datetimepicker(optionsAll); $(this).datetimepicker('refresh'); //$.datepicker._selectDate($(this).attr("id"),date); //$.datepicker._base_getDateDatepicker(); // var inst = $.datepicker._getInst($(this)); // $.datepicker._updateDatepicker(inst); /*$(this).datetimepicker('destroy'); InputfieldDatetimeDatepicker($(this), mintime, maxtime); $(this).datetimepicker('refresh'); */ // $(this).datetimepicker('option', {minTime: mintime, maxTime: maxtime}); } } Can you have a look and find out what the Problem is?
      InputfieldDatetime.zip
       
      Kind Regards
      Orkun
    • By teppo
      This module tracks changes, additions, removals etc. of public (as in "not under admin") pages of your site. Like it's name says, it doesn't attempt to be a version control system or anything like that - just a log of what's happened.
      At the moment it's still a work in progress and will most likely be a victim of many ruthless this-won't-work-let's-try-that-instead cycles, but I believe I've nailed basic functionality well enough to post it here.. so, once again, I'll be happy to hear any comments you folks can provide
      https://modules.processwire.com/modules/process-changelog/
      https://github.com/teppokoivula/ProcessChangelog
      How does it work?
      Exactly like it's (sort of) predecessor, Process Changelog actually consists of two modules: Process Changelog and Process Changelog Hooks. Hooks module exists only to serve main module by hooking into various functions within Pages class, collecting data of performed operations, refining it and keeping up a log of events in it's own custom database table (process_changelog.) Visible part is managed by Process Changelog, which provides users a (relatively) pretty view of the contents of said log table.
      How do you use it?
      When installed this module adds new page called Changelog under Admin > Setup which provides you with a table view of collected data and basic filtering tools See attached screenshots to get a general idea about what that page should look like after a while.
      For detailed installation instructions etc. see README.md.
       


    • By Gadgetto
      Status update links (inside this thread) for SnipWire development will be always posted here:
      2019-08-08
      2019-06-15
      2019-06-02
      2019-05-25
      If you are interested, you can test the current state of development:
      https://github.com/gadgetto/SnipWire
      Please note that the software is not yet intended for use in a production system (alpha version).
      If you like, you can also submit feature requests and suggestions for improvement. I also accept pull requests.
      ---- INITIAL POST FROM 2019-05-25 ----
      I wanted to let you know that I am currently working on a new ProcessWire module that fully integrates the Snipcart Shopping Cart System into ProcessWire. (this is a customer project, so I had to postpone the development of my other module GroupMailer).
      The new module SnipWire offers full integration of the Snipcart Shopping Cart System into ProcessWire.
      Here are some highlights:
      simple setup with (optional) pre-installed templates, product fields, sample products (quasi a complete shop system to get started immediately) store dashboard with all data from the snipcart system (no change to the snipcart dashboard itself required) Integrated REST API for controlling and querying snipcart data webhooks to trigger events from Snipcart (new order, new customer, etc.) multi currency support self-defined/configurable tax rates etc. Development is already well advanced and I plan to release the module in the next 2-3 months.
      I'm not sure yet if this will be a "Pro" module or if it will be made available for free.
      I would be grateful for suggestions and hints!
      (please have a look at the screenshots to get an idea what I'm talking about)
       




×
×
  • Create New...