3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
35 class CRM_Mailing_Form_Unsubscribe
extends CRM_Core_Form
{
37 function preProcess() {
39 $this->_type
= 'unsubscribe';
41 $this->_job_id
= $job_id = CRM_Utils_Request
::retrieve('jid', 'Integer', $this);
42 $this->_queue_id
= $queue_id = CRM_Utils_Request
::retrieve('qid', 'Integer', $this);
43 $this->_hash
= $hash = CRM_Utils_Request
::retrieve('h', 'String', $this);
49 CRM_Core_Error
::fatal(ts("Missing Parameters"));
52 // verify that the three numbers above match
53 $q = CRM_Mailing_Event_BAO_Queue
::verify($job_id, $queue_id, $hash);
55 CRM_Core_Error
::fatal(ts("There was an error in your request"));
58 list($displayName, $email) = CRM_Mailing_Event_BAO_Queue
::getContactInfo($queue_id);
59 $this->assign('display_name', $displayName);
60 $emailMasked = CRM_Utils_String
::maskEmail($email);
61 $this->assign('email_masked', $emailMasked);
62 $this->assign('email', $email);
63 $this->_email
= $email;
65 $groups = CRM_Mailing_Event_BAO_Unsubscribe
::unsub_from_mailing($job_id, $queue_id, $hash, TRUE);
66 $this->assign('groups', $groups);
68 foreach ($groups as $key => $value) {
73 $this->assign('groupExist', $groupExist);
77 function buildQuickForm() {
78 CRM_Utils_System
::addHTMLHead('<META NAME="ROBOTS" CONTENT="NOINDEX, NOFOLLOW">');
79 CRM_Utils_System
::setTitle(ts('Please Confirm Your Unsubscribe from this Mailing/Group'));
81 $this->add('text', 'email_confirm', ts('Verify email address to unsubscribe:'));
82 $this->addRule('email_confirm', ts('Email address is required to unsubscribe.'), 'required');
87 'name' => 'Unsubscribe',
92 'name' => ts('Cancel'),
96 $this->addButtons($buttons);
99 function postProcess() {
101 $values = $this->exportValues();
103 // check if EmailTyped matches Email address
104 $result = CRM_Utils_String
::compareStr($this->_email
, $values['email_confirm'], TRUE);
107 $job_id = $this->_job_id
;
108 $queue_id = $this->_queue_id
;
109 $hash = $this->_hash
;
111 $confirmURL = CRM_Utils_System
::url("civicrm/mailing/{$this->_type}","reset=1&jid={$job_id}&qid={$queue_id}&h={$hash}&confirm=1");
112 $this->assign('confirmURL', $confirmURL);
113 $session = CRM_Core_Session
::singleton();
114 $session->pushUserContext($confirmURL);
116 if ($result == TRUE) {
117 // Email address verified
119 $groups = CRM_Mailing_Event_BAO_Unsubscribe
::unsub_from_mailing($job_id, $queue_id, $hash);
120 if (count($groups)) {
121 CRM_Mailing_Event_BAO_Unsubscribe
::send_unsub_response($queue_id, $groups, FALSE, $job_id);
124 $statusMsg = ts('Email: %1 has been successfully unsubscribed from this Mailing List/Group.',
125 array(1 => $values['email_confirm'])
128 CRM_Core_Session
::setStatus( $statusMsg, '', 'success' );
130 else if ($result == FALSE) {
131 // Email address not verified
133 $statusMsg = ts('The email address: %1 you have entered does not match the email associated with this unsubscribe request.',
134 array(1 => $values['email_confirm'])
137 CRM_Core_Session
::setStatus( $statusMsg, '', 'fail' );