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 Robin S
      A community member raised a question and I thought a new sanitizer method for the purpose would be useful, hence...
      Sanitizer Transliterate
      Adds a transliterate method to $sanitizer that performs character replacements as defined in the module config. The default character replacements are based on the defaults from InputfieldPageName, but with uppercase characters included too.
      Usage
      Install the Sanitizer Transliterate module.
      Customise the character replacements in the module config as needed.
      Use the sanitizer on strings like so:
      $transliterated_string = $sanitizer->transliterate($string);
       
      https://github.com/Toutouwai/SanitizerTransliterate
      https://modules.processwire.com/modules/sanitizer-transliterate/
       
    • By dimitrios
      Hello,
      this module can publish content of a Processwire page on a Facebook page, triggered by saving the Processwire page.
      To set it up, configure the module with a Facebook app ID, secret and a Page ID. Following is additional configuration on Facebook for developers:
      Minimum Required Facebook App configuration:
      on Settings -> Basics, provide the App Domains, provide the Site URL, on Settings -> Advanced, set the API version to 2.10, add Product: Facebook Login, on Facebook Login -> Settings, set Client OAuth Login: Yes, set Web OAuth Login: Yes, set Enforce HTTPS: Yes, add "http://www.example.com/processwire/page/" to field Valid OAuth Redirect URIs. This module is configurable as follows:
      Templates: posts can take place only for pages with the defined templates. On/Off switch: specify a checkbox field that will not allow the post if checked. Specify a message and/or an image for the post.
      Usage
      edit the desired PW page and save; it will post right after the initial Facebook log in and permission granting. After that, an access token is kept.
       
      Download
      PW module directory: http://modules.processwire.com/modules/auto-fb-post/ Github: https://github.com/kastrind/AutoFbPost   Note: Facebook SDK for PHP is utilized.


    • By thomasaull
      I created a little helper module to trigger a CI pipeline when your website has been changed. It's quite simple and works like this: As soon as you save a page the module sets a Boolean via a pages save after hook. Once a day via LazyCron the module checks if the Boolean is set and sends a POST Request to a configurable Webhook URL.
      Some ideas to extend this:
      make request type configurable (GET, POST) make the module trigger at a specified time (probably only possible with a server cronjob) trigger manually Anything else? If there's interest, I might put in some more functionality. Let me know what you're interested in. Until then, maybe it is useful for a couple of people 🙂
      Github Repo: https://github.com/thomasaull/CiTrigger
    • By Robin S
      I created this module a while ago and never got around to publicising it, but it has been outed in the latest PW Weekly so here goes the support thread...
      Unique Image Variations
      Ensures that all ImageSizer options and focus settings affect image variation filenames.

      Background
      When using methods that produce image variations such as Pageimage::size(), ProcessWire includes some of the ImageSizer settings (height, width, cropping location, etc) in the variation filename. This is useful so that if you change these settings in your size() call a new variation is generated and you see this variation on the front-end.
      However, ProcessWire does not include several of the other ImageSizer settings in the variation filename:
      upscaling cropping, when set to false or a blank string interlace sharpening quality hidpi quality focus (whether any saved focus area for an image should affect cropping) focus data (the top/left/zoom data for the focus area) This means that if you change any of these settings, either in $config->imageSizerOptions or in an $options array passed to a method like size(), and you already have variations at the requested size/crop, then ProcessWire will not create new variations and will continue to serve the old variations. In other words you won't see the effect of your changed ImageSizer options on the front-end until you delete the old variations.
      Features
      The Unique Image Variations module ensures that any changes to ImageSizer options and any changes to the focus area made in Page Edit are reflected in the variation filename, so new variations will always be generated and displayed on the front-end.
      Installation
      Install the Unique Image Variations module.
      In the module config, set the ImageSizer options that you want to include in image variation filenames.
      Warnings
      Installing the module (and keeping one or more of the options selected in the module config) will cause all existing image variations to be regenerated the next time they are requested. If you have an existing website with a large number of images you may not want the performance impact of that. The module is perhaps best suited to new sites where image variations have not yet been generated.
      Similarly, if you change the module config settings on an existing site then all image variations will be regenerated the next time they are requested.
      If you think you might want to change an ImageSizer option in the future (I'm thinking here primarily of options such as interlace that are typically set in $config->imageSizerOptions) and would not want that change to cause existing image variations to be regenerated then best to not include that option in the module config after you first install the module.
       
      https://github.com/Toutouwai/UniqueImageVariations
      https://modules.processwire.com/modules/unique-image-variations/
    • By Sebi
      I've created a small module which lets you define a timestamp after which a page should be accessible. In addition you can define a timestamp when the release should end and the page should not be accessable any more.
      ProcessWire-Module: http://modules.processwire.com/modules/page-access-releasetime/
      Github: https://github.com/Sebiworld/PageAccessReleasetime
      Usage
      PageAccessReleasetime can be installed like every other module in ProcessWire. Check the following guide for detailed information: How-To Install or Uninstall Modules
      After that, you will find checkboxes for activating the releasetime-fields at the settings-tab of each page. You don't need to add the fields to your templates manually.
      Check e.g. the checkbox "Activate Releasetime from?" and fill in a date in the future. The page will not be accessable for your users until the given date is reached.
      If you have $config->pagefileSecure = true, the module will protect files of unreleased pages as well.
      How it works
      This module hooks into Page::viewable to prevent users to access unreleased pages:
      public function hookPageViewable($event) { $page = $event->object; $viewable = $event->return; if($viewable){ // If the page would be viewable, additionally check Releasetime and User-Permission $viewable = $this->canUserSee($page); } $event->return = $viewable; } To prevent access to the files of unreleased pages, we hook into Page::isPublic and ProcessPageView::sendFile.
      public function hookPageIsPublic($e) { $page = $e->object; if($e->return && $this->isReleaseTimeSet($page)) { $e->return = false; } } The site/assets/files/ directory of pages, which isPublic() returns false, will get a '-' as prefix. This indicates ProcessWire (with activated $config->pagefileSecure) to check the file's permissions via PHP before delivering it to the client.
      The check wether a not-public file should be accessable happens in ProcessPageView::sendFile. We throw an 404 Exception if the current user must not see the file.
      public function hookProcessPageViewSendFile($e) { $page = $e->arguments[0]; if(!$this->canUserSee($page)) { throw new Wire404Exception('File not found'); } } Additionally we hook into ProcessPageEdit::buildForm to add the PageAccessReleasetime fields to each page and move them to the settings tab.
      Limitations
      In the current version, releasetime-protected pages will appear in wire('pages')->find() queries. If you want to display a list of pages, where pages could be releasetime-protected, you should double-check with $page->viewable() wether the page can be accessed. $page->viewable() returns false, if the page is not released yet.
      If you have an idea how unreleased pages can be filtered out of ProcessWire selector queries, feel free to write an issue, comment or make a pull request!
×
×
  • Create New...