Jump to content

Newsletter Subscription


justb3a

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
Link to comment
Share on other sites

  • 1 month later...

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
Link to comment
Share on other sites

  • 2 months later...

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?

Link to comment
Share on other sites

  • 2 weeks later...
  • 2 months later...
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
Link to comment
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
Link to comment
Share on other sites

  • 3 months later...

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.

 

 

Link to comment
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
Link to comment
Share on other sites

  • 1 month later...

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.

Link to comment
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
Link to comment
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
Link to comment
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.

 

Link to comment
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
Link to comment
Share on other sites

  • 10 months later...

@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!

Link to comment
Share on other sites

  • 1 month later...

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.

Link to comment
Share on other sites

  • 2 months later...

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?

Link to comment
Share on other sites

  • 1 month later...

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

Link to comment
Share on other sites

  • 11 months later...
  • 6 months later...

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?

Link to comment
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
  • Recently Browsing   0 members

    • No registered users viewing this page.
  • Similar Content

    • By Sebi
      AppApiFile adds the /file endpoint to the AppApi routes definition. Makes it possible to query files via the api. 
      This module relies on the base module AppApi, which must be installed before AppApiFile can do its work.
      Features
      You can access all files that are uploaded at any ProcessWire page. Call api/file/route/in/pagetree?file=test.jpg to access a page via its route in the page tree. Alternatively you can call api/file/4242?file=test.jpg (e.g.,) to access a page by its id. The module will make sure that the page is accessible by the active user.
      The GET-param "file" defines the basename of the file which you want to get.
      The following GET-params (optional) can be used to manipulate an image:
      width height maxwidth maxheight cropX cropY Use GET-Param format=base64 to receive the file in base64 format.
    • By MarkE
      This fieldtype and inputfield bundle was built for storing measurement values within a field, rendering them in a variety of formats and converting them to other units or otherwise modifying them via the API.
      The API consists of a number of predefined functions, some of which include...
      render() for rendering the measurement object, valueAs() for converting the value to another unit value, convertTo() for converting the whole measurement object to different units, and add() and subtract() for for modifying the stored value by the value (converted as required) in another measurement. In the admin the inputfield includes a checkbox (which can be optionally disabled) for converting values on page save. For an example if a value was typed in as centimeters, the unit was changed to metres, and the page saved with this checkbox selected, said value would be automatically converted so that e.g. 170 cm becomes 1.7 m.

      A simple length field using Fieldtype Measurement and Inputfield Measurement.
      Combination units (e.g. feet and inches) are also supported.
      Please note that this module is 'proof of concept' at the moment - there are limited units available and quite a lot of code tidying to do. More units will be added shortly.
      See the GitHub at https://github.com/MetaTunes/FieldtypeMeasurement for full details and updates.
    • By tcnet
      File Manager for ProcessWire is a module to manager files and folders from the CMS backend. It supports creating, deleting, renaming, packing, unpacking, uploading, downloading and editing of files and folders. The integrated code editor ACE supports highlighting of all common programming languages.
      https://github.com/techcnet/ProcessFileManager

      Warning
      This module is probably the most powerful module. You might destroy your processwire installation if you don't exactly know what you doing. Be careful and use it at your own risk!
      ACE code editor
      This module uses ACE code editor available from: https://github.com/ajaxorg/ace

      Dragscroll
      This module uses the JavaScript dragscroll available from: http://github.com/asvd/dragscroll. Dragscroll adds the ability to drag the table horizontally with the mouse pointer.
      PHP File Manager
      This module uses a modified version of PHP File Manager available from: https://github.com/alexantr/filemanager
       
    • By tcnet
      This module implements the website live chat service from tawk.to. Actually the module doesn't have to do much. It just need to inserted a few lines of JavaScript just before the closing body tag </body> on each side. However, the module offers additional options to display the widget only on certain pages.
      Create an account
      Visit https://www.tawk.to and create an account. It's free! At some point you will reach a page where you can copy the required JavaScript-code.

      Open the module settings and paste the JavaScript-code into the field as shown below. Click "Submit" and that's all.

      Open the module settings
      The settings for this module are located int the menu Modules=>Configure=>LiveChatTawkTo.

       
    • By tcnet
      Session Viewer is a module for ProcessWire to list session files and display session data. This module is helpful to display the session data of a specific session or to kick out a logged in user by simply delete his session file. After installation the module is available in the Setup menu.

      The following conditions must be met for the module to work properly:
      Session files
      Session data must be stored in session files, which is the default way in ProcessWire. Sessions stored in the database are not supported by this module. The path to the directory where the session files are stored must be declared in the ProcessWire configuration which is by default: site/assets/sessions.
      Serialize handler
      In order to transform session data easier back to a PHP array, the session data is stored serialized. PHP offers a way to declare a custom serialize handler. This module supports only the default serialize handlers: php, php_binary and php_serialize. WDDX was dropped in PHP 7.4.0 and is therefore not supported by this module as well as any other custom serialize handler. Which serialize handler is actually used you can find out in the module configuration which is available under Modules=>Configure=>SessionViewer.

      Session data
      The session data can be displayed in two different ways. PHP's default output for arrays print_r() or by default for this module nice_r() offered on github: https://github.com/uuf6429/nice_r. There is a setting in the module configuration if someone prefers print_r(). Apart from the better handling and overview of the folded session data the output of nice_r() looks indeed nicer.

      Links
      ProcessWire module directory
      github.com
×
×
  • Create New...