Jump to content
justb3a

Newsletter Subscription

Recommended Posts

This module allows users to subscribe and unsubscribe to a newsletter, it doesn't handle newsletter creation and delivery (I use a foreign service for this).

There is one method to subscribe (by using a form) and there are two methods to unsubscribe (by using a form or by providing a link in the newsletter). Furthermore you can notify any person e.g. an administator via email when an user has subscribed/unsubscribed.

For detailed information have a look at Github.

  • Like 15

Share this post


Link to post
Share on other sites

I have a question about this module, I've followed the installation steps:
— created first_name and last_name fields
— added those fields to user template
 
Then I created a newsletter template in which I called the module as mentioned:
 

$options = array (
  'markup' => array(
    'InputfieldSelect' => array(
      'item' => "{out}"
    )
  ),
  'classes' => array(
    'form' => 'form  form__super-special-class',
    'InputfieldRadios' => array(
      'item' => 'form__item--options'
    )
  ),
  'prependMarkup' => "<div>{$page->prepend_markup}</div>",
  'appendMarkup' => "<p>{$page->append_markup}</p>"
);
 
echo $modules->get('NewsletterSubscription')->render($options);

Finally I created a newsletter page.
I can then open the page and subscribe, I receive the confirmation email but when I click on the link I get those errors (even though I appear in the users panel in pw): 
 

Error: Exception: Method User::setAndSave does not exist or is not callable in this context (in /home/tenutaxyit/www/wire/core/Wire.php line 350)
 
#0 [internal function]: Wire->___callUnknown('setAndSave', Array)
#1 /home/tenutaxyit/www/wire/core/Wire.php(387): call_user_func_array(Array, Array)
#2 /home/tenutaxyit/www/wire/core/Wire.php(325): Wire->runHooks('callUnknown', Array)
#3 /home/tenutaxyit/www/wire/core/Wire.php(329): Wire->__call('callUnknown', Array)
#4 /home/tenutaxyit/www/wire/core/Wire.php(329): User->callUnknown('setAndSave', Array)
#5 /home/tenutaxyit/www/site/modules/NewsletterSubscription/NewsletterSubscription.module(216): Wire->__call('setAndSave', Array)
#6 /home/tenutaxyit/www/site/modules/NewsletterSubscription/NewsletterSubscription.module(216): User->setAndSave('status', 1)
#7 /home/tenutaxyit/www/site/modules/NewsletterSubscription/NewsletterSubscription.module(93): NewsletterSubscription->validateSubscribeToken()
#8 /home/tenutaxyit/www/site/templates/newsletter.php(22): NewsletterSubscri
Edited by kongondo
wrapped code in code blocks

Share this post


Link to post
Share on other sites

Your ProcessWire version is not new enough. setAndSave was introduced with version 2.6.9, this was one of the reasons why I set the compatibility for this module to 2.7.

  • Like 2

Share this post


Link to post
Share on other sites

Hi,

i followed the installation process and integrated the form in my page.

If i click on Send then i am getting following error:

Error: Call to undefined method WireInput::text() (line 367 of /xxxxxxxxx/site/modules/NewsletterSubscription/NewsletterSubscription.module)

This error message was shown because you are logged in as a Superuser. Error has been logged.

 

What can i do?

Share this post


Link to post
Share on other sites

Hi, sorry for taking that long to answer. 

I made a silly mistake that slipped through regarding sanitizing input. It's fixed. Thanks for reporting.

Share this post


Link to post
Share on other sites
On 9/26/2016 at 0:22 PM, benbyf said:

could this modudke be used with third party email senders? link mailchimp etc?

You're able to send an email to any service you want to after successful subscription / unsubscription.  Calling an api endpoint isn't implemented yet (there are too much different services). If you miss a hookable function just let me know, I'll go ahead and add it. If everything works out (if the customer agrees to use ProcessWire), perhaps I'll soon be given an opportunity to implement a connection to mailchimp by myself.

  • Like 2

Share this post


Link to post
Share on other sites
On 26/09/2016 at 11:22 AM, benbyf said:

could this modudke be used with third party email senders? link mailchimp etc?

wow just read this back, and its amazingly badly typed, sorry. Yes mailchimp, I'm looking into it so will post back my implementation when done.

  • Like 1

Share this post


Link to post
Share on other sites

Could I use a plain html form with this module, instead of using the render() tag? I want to have more control over style etc. without having to use the complicated classes and markup overwrite methods.

What would I have to add to a plain html form to let the module take care of processing the data?

My html output of the tag looks like this:

Spoiler

<form id="subscribe-form" class=" form InputfieldForm" name="subscribe-form" method="post" action="./" data-colspacing="1">
	<div class='form__item form__item--fullname' id='wrap_Inputfield_fullname'>

		<label class='form__item--label' for='Inputfield_fullname'>Full name</label><input id="Inputfield_fullname" class="InputfieldMaxWidth" name="fullname" type="text" maxlength="2048" />
	</div>
	<div class='form__item form__item--email field--required' id='wrap_Inputfield_email'>

		<label class='form__item--label' for='Inputfield_email'>E-Mail Address</label><input id="Inputfield_email" name="email" class="FieldtypeEmail required" type="email" size="70" maxlength="255" />
	</div>
	<div class='form__item form__item--submit' id='wrap_Inputfield_submit'>
<button id="Inputfield_submit" class="button" name="submit" value="Send" type="submit"><span class='ui-button-text'>Send</span></button>
	</div>
<input type='hidden' name='TOKEN1009186866X1485168757' value='qqpdZc2cDDarCajU/Ns/VlbjtZtavbjX' class='_post_token' /></form></div>

 

Could I just use a restyled version of this form? Minus the input with the TOKEN# I guess and plus some PHP magic?

Another issue:

The 'success' message replaces the form, but not the text I had added above the form. How can I make that added text disappear/go display:none along with the form?

If I could use plain html, I could just include the intro within the form tag.

 

 

Share this post


Link to post
Share on other sites

hi, it's not possible (out of the box) to use a plain form instead of the render() tag. The processing of the form includes several error checks and a lot of additional logic. I solved it this way because my experience has shown that it's really difficult to support plain html. Most users break the form which leads to increased overhead. I'm not a fan of generated content therefore I added all possible options to customize the output. 

How did you add the content above the form? Do you use the option `prependMarkup`? If the content above is still there after submitting the form, this is ProcessWire Core behaviour I don't want to change. Just use `display: none` to hide the content (there should be a parent element containing a class which indicates that the form has been submitted successfully. If not, please let me know,  I'll add such a class).

  • Like 1

Share this post


Link to post
Share on other sites

Thanks justb3a. I will use the module as is.

1. To change the subject line of the emails sent to the user I had to edit the the module file. Is that correct or did I miss an edit option in the admin area somewhere?

2. There are ways to turn labels into placeholders via CSS...

https://css-tricks.com/float-labels-css/

...but they require <label> to come after <input> or/and have 'required' in the input tag. This would also require editing the module - and I can't figure out where/how.

Share this post


Link to post
Share on other sites

 

7 hours ago, modifiedcontent said:

2. There are ways to turn labels into placeholders via CSS...

https://css-tricks.com/float-labels-css/

...but they require <label> to come after <input> or/and have 'required' in the input tag. This would also require editing the module - and I can't figure out where/how.

 @modifiedcontent Actually it's pretty funny you're asking this right now. Some hours ago I opened a feature request regarding this because at the moment it's not possible to swap the order without using regex.

  • Like 1

Share this post


Link to post
Share on other sites
On 06/03/2017 at 11:15 AM, modifiedcontent said:

1. To change the subject line of the emails sent to the user I had to edit the the module file. Is that correct or did I miss an edit option in the admin area somewhere?

The subject is translatable. So even if the page is not multi-lingual, you can overwrite the subject this way.

  • Like 1

Share this post


Link to post
Share on other sites

@justb3a, I have started researching how to build forms - with generous help from fbg13 - because my employer/client wants more fields in the newsletter signup.

Wouldn't it be better to store newsletter subscribers under a new page instead of in users/access management?

I guess roles etc. would not be available if you have a custom members/subscribers table as a page? That could be a problem if the signup is for a community/social network, but not so much for a basic newsletter.

Btw, I used a SuperLabels jquery plugin to turn your labels into pseudo-placeholders. It's actually a nice-looking solution.

 

Share this post


Link to post
Share on other sites
24 minutes ago, modifiedcontent said:

because my employer/client wants more fields in the newsletter signup.

The module offers the possibility to add as many fields as you want. Why not using this in-build functionality?

Sure, you can store newsletter subscribers under another page or inside of a repeater or in a pagetable or ... There are a lot of options. For my use case it was the easiest solution to store them as a user with a specific role. Users are pages as well! If you want to change this behaviour, you need to rewrite a lot.

29 minutes ago, modifiedcontent said:

Btw, I used a SuperLabels jquery plugin to turn your labels into pseudo-placeholders. It's actually a nice-looking solution.

I wrote a few lines of JavaScript myself to achieve this. This project has no jQuery dependency. Furthermore I do not swap the order, I just need to know, whether the input is empty, focused or filled to be able to set the desired styling. See it in action!

  • Like 1

Share this post


Link to post
Share on other sites

@justb3a thanks for providing this module!

Before starting to use it to collect new subscribers, I had to import a list of existing newsletter subscribers from our old system.

The list is just a text file with one email address per line.

The amazing BCE didn't help in this case because PW users - while still pages - are somewhat special.

I came up with a little script which can be invoked from a browser window:

<?php namespace ProcessWire;

include("../index.php"); // bootstrap PW

/*
 * import newsletter subscribers
 * from a file 'subscribers.txt'
*/

$file = fopen("subscribers.txt", "r");

$i = 0;

while(!feof($file)) {
    $line = fgets($file);
    if($line == '') {
        continue;
    }
    $email = $sanitizer->email($line);
    if($email == '') {
        echo 'misformed email rejected: ' . $line . '<br>';
        continue;
    }
    $name = 'zzz-import-' . sprintf('%05d', $i);

    $u = new User();
    $u->of(false);
    $u->name = $name;
    $u->email = $email;
    $u->addRole('newsletter');
    $u->save();

    $log->save('newsletter', "User {$u->name} has been successfully subscribed with email {$u->email}");
    $i++;
}

fclose($file);

echo "<br>{$i} subscribers imported.<br>";

I am not sure if a lot of other poeple need something like that as well - if so, maybe adding an "import" feature for the NewsletterSubscription module would make sense.

Thanks for considering and greetings from the neighborhood!

Share this post


Link to post
Share on other sites

Hey there,

 

Great module. Thanks for the functionality.

I am using checkboxes of a multi-lang page reference field in the subscription form and I was wondering if multi-lang fields are supported by default, because the checkboxes are not translated. The Label of the field is translated correctly, but not the rest.

Thanks for some information.

Share this post


Link to post
Share on other sites

Sorry I didn’t get how to make work the unsubscribe link inside the newsletter. Does anyone have an example how to implement it?

Share this post


Link to post
Share on other sites

You can define an unsubscribe messge In the module config (E-Mail Messages section), for example:
 

To unsubscribe from this newsletter please follow this link:
%link%

 

Share this post


Link to post
Share on other sites

I wonder how the module can be made GDPR conform.
As far as I can see only the unsubscription proccedure needs some tweaks in the private function validateUnsubscribeToken():

$this->users->delete($user);
$this->log->save('messages', "User has been successfully deleted with id `{$user->id}`.");

First line: Can anyone confirm, that the whole entry is fully deleted and cannot be restored? (At the moment I have no testsystem to check it)
Second line: Switching the log from email to id, as the id is no personal data. But the id could be used as unique identifyer for deleted users when syncing with / exporting to other systems . Maybe adding a timestamp also would be good.

Another point to consider is neutralizing the optional email notifications to the admin.
Any other issue?

Share this post


Link to post
Share on other sites

Hello @justb3a,

first of thank you for this and your other modules. 😃

I wanted to ask if it is possible for subscribers to let them change their preferences after the initial subscription? In my use-case I want to build a website, where subscribers can choose different newsletter channels via checkboxes (page field) on the initial subscription. This part is working fine, but after the subscription it is only possible for subscribers to change their preferences, if they unsubscribe and then re-subscribe.

Could I provide a link with the ID or token and maybe a timestamp in the subscription email to a custom front-end form, where they can change and save their settings? It should be a verified and save address, so that no other user could guess the url and change settings of other users.

I would be happy about some inspiration. 😉

Regards, Andreas

Share this post


Link to post
Share on other sites

Hey, Great module just wondering if you table to rename the submit button value? or do I need to do this within the module files?

Share this post


Link to post
Share on other sites

Hey @justb3a I can tell you've done an interesting module and even though I did not test it yet, I could see it already fitting to my needs. Since I see that the module development is discontinued, does anyone know of existing issues for some basic user subscription? I am building a profile for a tech support company and the client would like to collect client's name, email and eventually phone number in order to broadcast occasionally some promotions, discounts, new services etc. Since the client is located in North America, it won't be that much of a problem if GDPR is not fully operational (as far as I understood from the earlier questions), however I would see how to make it work so that any European client does not fall through and complain of non-EU-GDPR-compliant website 😉

So any known issues I should be aware before I implement the module?

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 Gadgetto
      SnipWire - Snipcart integration for ProcessWire
      Snipcart is a powerful 3rd party, developer-first HTML/JavaScript shopping cart platform. SnipWire is the missing link between Snipcart and the content management framework ProcessWire.
      With SnipWire, you can quickly turn any ProcessWire site into a Snipcart online shop. The SnipWire plugin helps you to get your store up and running in no time. Detailed knowledge of the Snipcart system is not required.
      SnipWire is free and open source licensed under Mozilla Public License 2.0! A lot of work and effort has gone into development. It would be nice if you could donate an amount to support further development:

      Status update links (inside this thread) for SnipWire development
      2020-01-21 -- Snipcart v3 - when will the new cart system be implemented? 2020-01-19 -- integrated taxes provider finished (+ very flexible shipping taxes handling) 2020-01-14 -- new date range picker, discount editor, order notifiactions, order statuses, and more ... 2019-11-15 -- orders filter, order details, download + resend invoices, refunds 2019-10-18 -- list filters, REST API improvements, new docs platform, and more ... 2019-08-08 -- dashboard interface, currency selector, managing Orders, Customers and Products, Added a WireTabs, refinded caching behavior 2019-06-15 -- taxes provider, shop templates update, multiCURL implementation, and more ... 2019-06-02 -- FieldtypeSnipWireTaxSelector 2019-05-25 -- SnipWire will be free and open source Plugin Key Features
      Fast and simple store setup Full integration of the Snipcart dashboard into the ProcessWire backend (no need to leave the ProcessWire admin area) Browse and manage orders, customers, discounts, abandoned carts, and more Process refunds and send customer notifications from within the ProcessWire backend Complete Snipcart webhooks integration (all events are hookable via ProcessWire hooks) Integrated taxes provider (which is more flexible then Snipcart own provider) Useful Links
      SnipWire in PW modules directory (alpha version only available via GitHub) SnipWire Docs (please note that the documentation is a work in progress) SnipWire @GitHub (feature requests and suggestions for improvement are welcome - I also accept pull requests) Snipcart Website  
      ---- INITIAL POST FROM 2019-05-25 ----
       
    • By d'Hinnisdaël
      Happy new year, everybody 🥬
      I've been sitting on this Dashboard module I made for a client and finally came around to cleaning it up and releasing it to the wider public. This is how it looks.
      ProcessWire Dashboard

      If anyone is interested in trying this out, please go ahead! I'd love to get some feedback on it. If this proves useful and survives some real-world testing, I'll add this to the module directory.
      Download
      You can find the latest release on Github.
      Documentation
      Check out the documentation to get started. This is where you'll find information about included panel types and configuration options.
      Custom Panels
      My goal was to make it really simple to create custom panels. The easiest way to do that is to use the panel type template and have it render a file in your templates folder. This might be enough for 80% of all use cases. For anything more complex (FormBuilder submissions? Comments? Live chat?), you can add new panel types by creating modules that extend the DashboardPanel base class. Check out the documentation on custom panels or take a look at the HelloWorld panel to get started. I'm happy to merge any user-created modules into the main repo if they might be useful to more than a few people.
       Disclaimer
      This is a pre-release version. Please treat it as such — don't install it on production sites. Just making sure 🍇
      Roadmap
      These are the things I'm looking to implement myself at some point. The wishlist is a lot longer, but those are the 80/20 items that I probably won't regret spending time on.
      Improve documentation & add examples ⚙️ Panel types Google Analytics ⚙️ Add new page  🔥 Drafts 🔥 At a glance / Page counter 404s  Layout options Render multiple tabs per panel panel groups with heading and spacing between ✅ panel wrappers as grid item (e.g. stacked notices) ✅ Admin themes support AdminThemeReno and AdminThemeDefault ✅ Shortcuts panel add a table layout with icon, title & summary ✅ Chart panel add default styles for common chart types ✅ load chart data from JS file (currently passed as PHP array) Collection panel support image columns ✅ add buttons: view all & add new ✅
    • By Robin S
      This module is inspired by and similar to the Template Stubs module. The author of that module has not been active in the PW community for several years now and parts of the code for that module didn't make sense to me, so I decided to create my own module. Auto Template Stubs has only been tested with PhpStorm because that is the IDE that I use.
      Auto Template Stubs
      Automatically creates stub files for templates when fields or fieldgroups are saved.
      Stub files are useful if you are using an IDE (e.g. PhpStorm) that provides code assistance - the stub files let the IDE know what fields exist in each template and what data type each field returns. Depending on your IDE's features you get benefits such as code completion for field names as you type, type inference, inspection, documentation, etc.
      Installation
      Install the Auto Template Stubs module.
      Configuration
      You can change the class name prefix setting in the module config if you like. It's good to use a class name prefix because it reduces the chance that the class name will clash with an existing class name.
      The directory path used to store the stub files is configurable.
      There is a checkbox to manually trigger the regeneration of all stub files if needed.
      Usage
      Add a line near the top of each of your template files to tell your IDE what stub class name to associate with the $page variable within the template file. For example, with the default class name prefix you would add the following line at the top of the home.php template file:
      /** @var tpl_home $page */ Now enjoy code completion, etc, in your IDE.

      Adding data types for non-core Fieldtype modules
      The module includes the data types returned by all the core Fieldtype modules. If you want to add data types returned by one or more non-core Fieldtype modules then you can hook the AutoTemplateStubs::getReturnTypes() method. For example, in /site/ready.php:
      // Add data types for some non-core Fieldtype modules $wire->addHookAfter('AutoTemplateStubs::getReturnTypes', function(HookEvent $event) { $extra_types = [ 'FieldtypeDecimal' => 'string', 'FieldtypeLeafletMapMarker' => 'LeafletMapMarker', 'FieldtypeRepeaterMatrix' => 'RepeaterMatrixPageArray', 'FieldtypeTable' => 'TableRows', ]; $event->return = $event->return + $extra_types; }); Credits
      Inspired by and much credit to the Template Stubs module by mindplay.dk.
       
      https://github.com/Toutouwai/AutoTemplateStubs
      https://modules.processwire.com/modules/auto-template-stubs/
    • By Mike Rockett
      Jumplinks for ProcessWire
      Release: 1.5.60
      Composer: rockett/jumplinks
      ⚠️ NOTICE: 1.5.60 is an important security patch-release for an XSS vulnerability discovered by @phlp. It's HIGHLY RECOMMENDED that all Jumplinks users update to the latest version as soon as possible.
      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 Robin S
      Add Image URLs
      Allows images/files to be added to Image/File fields by pasting URLs.

      Usage
      Install the Add Image URLs module.
      A "Paste URLs" button will be added to all image and file fields. Use the button to show a textarea where URLs may be pasted, one per line. Images/files are added when the page is saved.
       
      https://github.com/Toutouwai/AddImageUrls
      https://modules.processwire.com/modules/add-image-urls/
×
×
  • Create New...