Collect subscriber data
philipnd - March 12, 2007 - 22:50
| Project: | Simplenews |
| Version: | 6.x-1.x-dev |
| Component: | User interface |
| Category: | feature request |
| Priority: | normal |
| Assigned: | Unassigned |
| Status: | active |
Description
I would like to be able to collect other fields when having people subscribe. For example First and Last Name, Zipcode.
#1
Duplicate request. Please add you +1 to issue http://drupal.org/node/73364.
#2
Actually this is different to node/73364. The feature request in node/73364 is about fields that simplenews should generate and store in the DB (time stamp of events). This feature request is about fields that the subscriber should ENTER when they subscribe -- subscriber--attributes, such as the subscribers name, home-country, address, interests, etc. Ideally the webmaster should be able to define these fields. See how phplist http://phplist.com has implemented this feature.
This issue IS however a duplicate of http://drupal.org/node/130483.
#3
+1
and yes, this is not the same as node/73364
Adding at least a full name field for the user would be a good start.
#4
*bump*
*bump*
*bump*
ZIIIIIP COOOOOODES!
Please. If you can build it, I can pay.
#5
I have used a small hack to do this : creating a new Webform component called "simplenews" and a few php lines that handles the subscription.
It's not really elegant, but it works. If someone is interested just send me a message, an I'll send you this. Right now I don't want to publish this here because it needs to be tested (I'm working on it).
#6
Create a file called simplenes.inc in your module/webform/component directory and copy the code below.
You'll have a new Webform component called "simplenews". You can then select which newsletter this field should subscribe to.
This was not heavily tested at all, use it at your own risk.
<?php
function _webform_submit_simplenews(&$data, $component) {
$news_vid = $data[0];
$email = $data[1];
if($email && $news_vid) {
simplenews_subscribe_user($email, $news);
}
}
function _webform_edit_simplenews($currfield) {
if (!module_exists("simplenews")) {
drupal_set_message(t("Using simplenews components in webform requires the <a href='http://drupal.org/project/simplenews'>Simpnews</a> module."), "error");
}
$edit_fields = array();
$options = array();
foreach( taxonomy_get_tree(_simplenews_get_vid()) as $newsletter) {
$options[$newsletter->tid] = $newsletter->name;
}
$edit_fields['extra']['newsletter'] = array(
'#type' => 'select',
'#title' => t("Newsletter"),
'#default_value' => $currfield['extra']['newsletter'],
'#description' => t('Select which newsletter can be chosen'),
'#required' => TRUE,
'#multiple' => FALSE,
'#size' => sizeof($options),
'#options' => $options,
);
$edit_fields['mandatory'] = array(
'#type' => 'hidden',
'#value' => 1,
);
$edit_fields['extra']['description'] = array(); // Hide the description box
return $edit_fields;
}
function _webform_render_simplenews($component) {
$form_item[] = array(
'#type' => 'hidden',
'#value' => $component['extra']['newsletter'],
);
$form_item[] = array(
'#title' => htmlspecialchars($component['name'], ENT_QUOTES),
'#type' => 'textfield',
'#required' => 1,
'#validate' => array('_webform_validate_email' => array('submitted]['. $component['cid'])),
);
$form_item['#weight'] = $component['weight'];
return $form_item;
}
function _webform_submission_display_simplenews($data, $component) {
$form_item = _webform_render_hidden($component);
$form_item['#value'] = $data['value']['0'];
$form_item['#type'] = 'textfield';
$form_item['#title'] = htmlspecialchars($component['name'], ENT_QUOTES) ." (hidden)";
$form_item['#attributes'] = array("disabled" => "disabled");
return $form_item;
}
function _webform_help_simplenews($section) {
switch ($section) {
case 'admin/settings/webform#simplenews_description':
$output = t("Subscribe to newsletters.");
break;
}
return $output;
}
function _webform_analysis_rows_simplenews($component) {
$query = 'SELECT data '.
' FROM {webform_submitted_data} '.
' WHERE nid = %d '.
' AND cid = %d';
$nonblanks = 0;
$submissions = 0;
$wordcount = 0;
$result = db_query($query, $component['nid'], $component['cid']);
while ($data = db_fetch_array($result)) {
if ( strlen(trim($data['data'])) > 0 ) {
$nonblanks++;
$wordcount += str_word_count(trim($data['data']));
}
$submissions++;
}
$rows[0] = array( t('Submissions'), $submissions);
return $rows;
}
function _webform_table_data_simplenews($data) {
return check_plain(empty($data['value']['1']) ? "" : $data['value']['1']);
}
function _webform_csv_headers_simplenews($component) {
$header = array();
$header[0] = '';
$header[1] = '';
$header[2] = $component['name'];
return $header;
}
function _webform_csv_data_simplenews($data) {
return empty($data['value']['1']) ? "" : $data['value']['1'];
}
#7
This sounds like a great idea & is exactly what I need. I have a problem though, the confirmation email just has newsletter/confirm/add, rather than newsletter/confirm/add/xxxxxxxxxxxxx. Does anyone have any ideas as to why this is happening?
Also, do you think it would be possible to put the Webform in a block?
Thanks for your work on this!
#8
I had the same link problem but sadly I can't remember how I solved it :( But first try my new version, I there are a few bugfixes. And about the webform in a block , I have no idea.
Here is my last simplenews.inc :
<?php
function _webform_submit_simplenews(&$data, $component) {
$news_vid = $data[0];
$action = $data[1];
$email = $data[2];
global $user;
$account = _simplenews_user_load($form_values['mail']);
$confirm = $account->uid && $account->uid == $user->uid ? FALSE : TRUE;
if($email && $news_vid) {
if($action == 'subscribe') {
simplenews_subscribe_user($email, $news_vid, $confirm);
}
else {
simplenews_unsubscribe_user($email, $news_vid, $confirm);
}
}
}
function _webform_edit_simplenews($currfield) {
if (!module_exists("simplenews")) {
drupal_set_message(t("Using simplenews components in webform requires the <a href='http://drupal.org/project/simplenews'>Simpnews</a> module."), "error");
}
$edit_fields = array();
$options = array();
foreach( taxonomy_get_tree(_simplenews_get_vid()) as $newsletter) {
$options[$newsletter->tid] = $newsletter->name;
}
$edit_fields['extra']['newsletter'] = array(
'#type' => 'select',
'#title' => t("Newsletter"),
'#default_value' => $currfield['extra']['newsletter'],
'#description' => t('Select which newsletter can be chosen'),
'#required' => TRUE,
'#multiple' => FALSE,
'#size' => sizeof($options),
'#options' => $options,
);
$edit_fields['extra']['newsletter_action'] = array(
'#type' => 'select',
'#title' => t('Newsletter action'),
'#default_value' => $currfield['extra']['newsletter_action'],
'#description' => t('Defines the action to be taken on submit'),
'#required' => TRUE,
'#size' => 2,
'#options' => array('subscribe' => t('subscribe'),
'unsubscribe' => t('unsubscribe')),
);
$edit_fields['mandatory'] = array(
'#type' => 'hidden',
'#value' => 1,
);
$edit_fields['extra']['description'] = array(); // Hide the description box
return $edit_fields;
}
function _webform_render_simplenews($component) {
$form_item[] = array(
'#type' => 'hidden',
'#value' => $component['extra']['newsletter'],
);
$form_item[] = array(
'#type' => 'hidden',
'#value' => $component['extra']['newsletter_action'],
);
$form_item[] = array(
'#title' => htmlspecialchars($component['name'], ENT_QUOTES),
'#type' => 'textfield',
'#required' => 1,
'#validate' => array('_webform_validate_email' => array('submitted]['. $component['cid'])),
);
$form_item['#weight'] = $component['weight'];
return $form_item;
}
function _webform_submission_display_simplenews($data, $component) {
$form_item = _webform_render_hidden($component);
$form_item['#value'] = $data['value']['0'];
$form_item['#type'] = 'textfield';
$form_item['#title'] = htmlspecialchars($component['name'], ENT_QUOTES) ." (hidden)";
$form_item['#attributes'] = array("disabled" => "disabled");
return $form_item;
}
function _webform_help_simplenews($section) {
switch ($section) {
case 'admin/settings/webform#simplenews_description':
$output = t("Subscribe to newsletters.");
break;
}
return $output;
}
function _webform_analysis_rows_simplenews($component) {
$query = 'SELECT data '.
' FROM {webform_submitted_data} '.
' WHERE nid = %d '.
' AND cid = %d';
$nonblanks = 0;
$submissions = 0;
$wordcount = 0;
$result = db_query($query, $component['nid'], $component['cid']);
while ($data = db_fetch_array($result)) {
if ( strlen(trim($data['data'])) > 0 ) {
$nonblanks++;
$wordcount += str_word_count(trim($data['data']));
}
$submissions++;
}
$rows[0] = array( t('Submissions'), $submissions);
return $rows;
}
function _webform_table_data_simplenews($data) {
return check_plain(empty($data['value']['2']) ? "" : $data['value']['2']);
}
function _webform_csv_headers_simplenews($component) {
$header = array();
$header[0] = '';
$header[1] = '';
$header[2] = $component['name'];
return $header;
}
function _webform_csv_data_simplenews($data) {
return empty($data['value']['2']) ? "" : $data['value']['2'];
}
#9
This is close to what I'm trying to do. I'd like to add a check box to the bottom of my webform, that if checked will subscribe their email to a simplenews newsletter. For instance at the bottom of the contact us form it would say: Check here if you would like to join our Mailing List. Any thoughts? Anyway to tweak the above code to do that?
#10
You can do this easily with the above code. Create your contact page as a webform and add a simplenews component (you have to copy the code into simplenews.inc in the webform/component directory).
#11
This worked like a charm! Except for one thing...
function _webform_submission_display_simplenews($data, $component) {$form_item = _webform_render_hidden($component);
$form_item['#value'] = $data['value']['0'];
$form_item['#type'] = 'textfield';
$form_item['#title'] = htmlspecialchars($component['name'], ENT_QUOTES) ." (hidden)";
$form_item['#attributes'] = array("disabled" => "disabled");
return $form_item;
}
I wanted to be able to view the e-mail address of the submitting user along with the additional webform fields. I see it has been obfuscated, so I changed " $form_item['#value'] = $data['value']['0'];" to:
$data['value']['2'];
Now when I look at the webform results, it does give me the e-mail address used to subscribe to simplenews, however, the e-mail notification that is sent through the webform to the admin user responsible for the webform contains all the webform fields EXCEPT the e-mail address subscribing to the newsletter.
Any ideas why?
Also, I think this contribution would be very helpful with regards to extending Simplenews in the manner they are discussing here...
http://drupal.org/node/210846
#12
NOTE: the loading of the user into $account requires the field be named 'mail'
Since it uses the email, and above this line it specifically sets email, I recommend you change the line to the following...
$account = _simplenews_user_load($email);
#13
I have added simplenews inc to sites\all\modules\webform\components, and tried to add a simplenews component to my webform.
I receive this error message:
Call to undefined function _simplenews_get_vid()
Where is this function ( i have done a grep search in modules folder to no avail ) and how do i get this file to see it?
#14
It has been removed as of 6.x-1.x-dev and replaced by variable_get('simplenews_vid', '')
#15
Sorry, I should have mentioned, I'm using Webform 5.x-2.0
#16
Thanks Sutharsan, I tried your suggested change in desperation and it worked. I guess the changes got ported over to 5.x-2.0 as well.
What a shame the client's requirements have changed and I dont need it anymore (well not for this project anyway)
#17
This worked great for me so far. It'd be nice to integrate it in the Webform module by default!
Thanks so much you guys!
#18
@jphelan: Did you find out a way to subscribe a newsletter with a checkbox in a webform?
In my webform i have already an email field with the email component. How can i use this email field for the simplenews component?
The above code use an extra textfield for the email address and validate this with the '_webform_validate_email' function.
Another question Is how can i skip the confirmation mail with the link to subscribe?
#19
I too am trying to accomplish some kind of tighter integration between Webforms and Simplenews (i.e. the ability to include a checkbox in a custom form)...and I have found the effort quite frustrating. It is fairly common practice to include a checkbox on a website contact form offering the option of subscribing to a newsletter. It seems redundant to ask for a user's email address to subscribe to a newsletter, when you have already asked for an email address near the top of the form. I suppose the only other option would be to use the Simplenews textbox as the email box (however, this does not allow people to opt-out of subscribing to the newsletter).
It would seem a fairly simple modification to change the textbox input into a checkbox. However, the problem lies in retrieving the email address value from the specific field in the webform which collects the email address.
At least I know I'm not alone in this frustration...but I'm working on project now that really requires this feature, so that is small comfort.
Has anyone had any luck or even some small inspiration about this?
#20
Hi, Has there been any progress on this for D6?
#21
I am trying to solve this problem too. I made a checkbox and an e-mail field like in yraber's code, but here comes the problem. The preg_match() function wait for a string, and in the _webform_render_simplenews function we have to create a form_item[] array for the textfield, wich contains the e-mail address, for the checkbox that controls the subscribe, and a hidden field with the newsletter taxonomy id. Because of the array, the e-mail doesn't contain the value of the e-mail address field and you can't set up the sender's e-mail address with this component...
Any idea how to solve this?
#22
Has there been any progress on solving this in a more flexible way?
#23
What would you think of creating a new module ("Simplenews Personalize" for example) which could implement these features in a more user-friendly way? This module could then utilize Webform, Token, or whatever to collect user information (anon and registered) and display this in newsletters if desired.
I think this could be very powerful and flexible because it could allow for completely user-defined subscription forms and variables to place in the newsletters. You could then possibly even filter who to send the newsletters to based on this data, etc. I have been looking all over the issues and tons of people want this functionality. I'd love to hear any suggestions and I'd be glad to start working on this myself. Thanks.
#24
Changing status to active
#25
You are very welcome to contribute code, but this should be an new module integrating simplenews with other modules. The feature is highly requested (as you have seen while digging through the issue queue). But be warned, this is not an easy thing to realize. It must be flexible and integrated with a number of different modules. I have some firm ideas on how this can be build. I you are serious to build and contribute this module I will share my ideas with you. Great fame will be your reward ;)
#26
Referencing duplicate: #71710: Extend the Subscriber Form
#27
I may be in over my head, Sutharsan, but I'd love to hear your ideas and possibly get working on this. I'm thinking it would be best to start a new issue to discuss this idea. If you think that's the best way to proceed, I'll start the issue and try to get the ball rolling.
#28
If there is a new discussion on this, please reference it from here so I may follow. I'm quite interested in a working solution. Am just in to the "learning the ropes" part of Drupal coding with other coding experience to bring to the table.
#29
@callison: This is /on/ topic, pls no new issue.
I will follow-on shortly with requirements and direction proposal.
@nimzie: you'r welcome to help. This is an 'all hands on deck' ;)
#30
I would be excited to help. I may need some direction as I haven't "groc'd" some of the "drupal way" of doing things.
Please keep me in the loop
#31
Requirements:
* admin can define subscriber fields.
* flexible field definition (field type, required, default, select options)
* subscriber can enter data in subscription form. Applicable for both anonymous and authenticated users.
+ admin can assign fields to subscription form
+ subscriber data is available in views
* admin can list and maintain subscriber field contents
+ authenticated users can edit their subscription data
+ subscription data is synchronized with authenticated users profile
(* = required; + = optional/future)
The availability of data in views needs an additional note. For the future of Simplenews I want to make it possible for simplenews to send mailings to flexible target groups. The data collected by a view could be a target group. This would allow the admin to determine the target group by creating a view.
Solution:
* The subscriber field requires the flexibility of CCK
* Create a node type containing the system fields such as email. Admin can add additional fields.
* Use Content Profile module to use the subscription data as user profile data (option?)
* Create a user account for each anonymous subscriber just like Ubercart does this for anonymous webshop customers.
* Include node fields into the subscription form.
#32
This all could be build for simplenews 6.x in a new module. I'm prepared to advise or coach any one who want to write code for this. Alternatively I can devote my time to develop the module myself if a sponsor steps forward for this.
#33
I am hoping that with the knowledge I glean from this year's Drupalcon DC, I will be able to add valuable input to this job.
#34
Changing title.
#35
Sutharsan,
If I understand well on your #32 comment you are proposing a solution that uses the "user profile" functionality for fields ? I am in favor of such a solution that integrates with user module ...
I am WILLING to split costs with a few other people to sponsor this development, can you come up with an estimated amount of how much would be appropriate for this development ? How about if you develop it such that these fields are exposed to the actual email send (i.e. for personalized emails, with name of the subscriber)
Anyone else willing to put some money for this development please post here or contact me (so we can calculate how much each one should pay ...)
BTW there is a similar issue with PATCH here http://drupal.org/node/87071
#36
@GiorgosK: thanks for offering sponsorship. I send you a pm with a price and other remarks.
A solution based on profile fields is not as flexibility I would like it to be (access control, type of fields) therefore I prefer to use Content Profile module which is based on CCK and can be used as profile system too.
#37
Attached you'll find the D6 version of #8 including some fixes as mentioned above (file simplenews_oldstyle.inc) and a new file simplenews.inc which displays all available newsletters as checkboxes, so people can select more newsletters at the same time. It's working for me, but please test this first before using on a live site :p
PS: Don't use both of them at the same time, I guess it will break things.
#38
We'd rather use CCK or similar for this, not profile, as we have people subscribing to newsletters who don't otherwise have an account on the system. We're willing to help fund. PM if you've got an estimate of cost. We are on Drupal 5.x until this summer, however, so we'll need this to be for 5.x.
#39
@yraber: Tnx for this fantastic fix:D Works like a charm.
@attiks: Uploading both files will give a fatal error. Deleting one is the solution :) Thanks for the handy ready-files.
When there is a test-version of a seperate module, I'm willing to test (and with my little knowledge) try to help debug.
#40
Question:
what are you all doing w/ the subscriber data you collect? are you using it to personalize outgoing emails?
also, how are you getting the subscription setup. does that happen inside the webform?
thanks,
m
#41
We use this for personalizing contacts, and also for collecting information about which of several graduate programs the prospective subscriber is interested in. We don't have different newsletters for the different programs at this point, we just need to collect that info for other purposes. We're currently using webform and then manually importing the collected addresses into Simplenews, which seems very roundabout. We haven't been able to get the Simplenews webform component to work, and of course when using webform we no longer have the RSS subscription button, either. We also have to use nodeblock to get the webform into a block. It's very convoluted. :(
#42
Subscribing. It would be very nice and useful to be able to select recipients according to city or zipcode.
#43
Thank you for the component with the checkbox, that is the one i try to use (post #37).
If i send my contact form (webform 2.4), unfortunately drupal 6.9 give me the following error:
warning: mysql_real_escape_string() expects parameter 1 to be string, array given in /mydomain/drupal69/includes/database.mysql.inc on line 321.
I receive only the submited contact form datas via email, no subscription email.
can anyone help me out to fix this problem, please?
Many TIA, 4ud
#44
subscribe
#45
I am also very interested on having a bit more info of subscribers, like Name (in two fields as First Name an Surname would be better) and a couple of other ones like City, ZIP, Age/Date of Birth, Occupation so I could make statistics of people. Being also able to activate these fields or not (I have different needs from different sites) should be possible, I think.
Thanks for your work anyway !
psc
#46
subscribing
#47
@#45
Hey,
I had the same problem and it happend to be the following:
On the Form-Components of my Webform I did put the simplenews type into a fieldgroup, what messed the following code in simplenews.inc up:
line 9 was:
$email = $_POST['submitted'][$emailfield];
I named the simplenews field 'emailfield' and put it into the fieldgroup 'informations'. Then I changed line 9 to the following:
$email = $_POST['submitted']['informations']['emailfield'];
After this change it worked, email confirmation is sent out and email is subscribed.
Hope this is helping you as well..
Seba
#48
Hey guys,
Could someone please do a nice wrap-up of how to integrate this feature without hacking any modules.
The concept is to be able to have additional fields in simplenews for Anonymous/Registered users.
Lorenzo.
#49
@kiela69
I attached the webform solution outlined in #8 (thanks). This has worked for me on 4-5 websites so far. Just remove the".txt" and place the simplenews.inc file in /sites/all/modules/webform/components/ p.s. Im running D6 with the latest stable for simplenews and webform as of (6/19/09)
@everyone
I must say though this solution is far from ideal. I think a CCK like solution would be ideal, but as subscriptions are not nodes i dont think/know if that would work.
Maybe instead we should take a vote and get the most common fields developers are wanting and include them?
i think first name & last name or full name are a given..
My reasoning for wanting this feature is to provide customized newsletters. I couldnt seem to find a way to pull the subscribers uid from within the template. If i was able to do that i could pull the other data i needed on the fly. Grated i know this solution would also not be ideal as we would be calling to the database far more often then necessary.
Ideas? comments?
#50
Thank for this! I'll implement it on Monday and let you know.
My vote is ON, for a CCK-type interface for adding custom fields for collecting data. Now having it done on a newsletter basis (different data depending on newsletter) is probably for a later project.
Most common fields for me are: Firstname, Lastname, Country/Company
Lorenzo.
#51
@jackinloadup: "I think a CCK like solution would be ideal"
I think profile fields would make much more sense than the node system. The problem here is storing data for subscriptions that aren't users. Still, if you used the profile system, you could simply use the fields defined in the profile form, or even better, a fieldset of the profile form (e.g. contact details).
Storing data for non-users depends somewhat on what currently happens if non-users subscribe. Does the email address become associated with the new account? If not, then basically this module would require a whole new table for non-subscriber contact data. That might be true anyway though...
#52
@naught101: "I think profile fields would make much more sense than the node system"
Wow, i dont know why i never thought of taking advantage of the profile system. I suppose maybe it was due to the non-user issue. But in either case.. still a very interesting idea. This would also allow any changes the user made to their profile to be reflected in their emails. ex: First name.
In this solution it seem almost unavoidable to create a new table to store user data. :-( This would need to get synced with the profiles sense some subscribers would become users after subscribing.
It sure seems like this would not be an issue in D7 with fields.
I suppose the next logical step is to see what kind of information this table should collect and how flexible we can make it. correct?
#53
I have posted an improved version of the new Webform component into Webform's issue queue at #525446: Support for Simplenews module.
#54
For the task to collect subscriber data through user/register this issue is relevant as well Mandatory Newsletter Option
#55
There's a new module called "contact manager" that interfaces with the profile module. The current release doesn't work, but apparently should be fixed in a few days.
I've started an issue there that I think might cover this issue better for me, and would make more sense than pushing this functionality into simplenews: #531798: Interface with Simplenews
#56
subscribe
#57
subscribe
#58
Subscribe