3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
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-2018
33 class CRM_Mailing_Form_Unsubscribe
extends CRM_Core_Form
{
35 public function preProcess() {
37 $this->_type
= 'unsubscribe';
39 $this->_job_id
= $job_id = CRM_Utils_Request
::retrieve('jid', 'Integer', $this);
40 $this->_queue_id
= $queue_id = CRM_Utils_Request
::retrieve('qid', 'Integer', $this);
41 $this->_hash
= $hash = CRM_Utils_Request
::retrieve('h', 'String', $this);
47 CRM_Core_Error
::fatal(ts("Missing Parameters"));
50 // verify that the three numbers above match
51 $q = CRM_Mailing_Event_BAO_Queue
::verify($job_id, $queue_id, $hash);
53 CRM_Core_Error
::fatal(ts("There was an error in your request"));
56 list($displayName, $email) = CRM_Mailing_Event_BAO_Queue
::getContactInfo($queue_id);
57 $this->assign('display_name', $displayName);
58 $emailMasked = CRM_Utils_String
::maskEmail($email);
59 $this->assign('email_masked', $emailMasked);
60 $this->assign('email', $email);
61 $this->_email
= $email;
63 $groups = CRM_Mailing_Event_BAO_Unsubscribe
::unsub_from_mailing($job_id, $queue_id, $hash, TRUE);
64 $this->assign('groups', $groups);
66 foreach ($groups as $key => $value) {
72 $statusMsg = ts('Email: %1 has been successfully unsubscribed from this Mailing List/Group.',
75 CRM_Core_Session
::setStatus($statusMsg, '', 'fail');
77 $this->assign('groupExist', $groupExist);
81 public function buildQuickForm() {
82 CRM_Utils_System
::addHTMLHead('<META NAME="ROBOTS" CONTENT="NOINDEX, NOFOLLOW">');
83 CRM_Utils_System
::setTitle(ts('Please Confirm Your Unsubscribe from this Mailing/Group'));
85 $this->add('text', 'email_confirm', ts('Verify email address to unsubscribe:'));
86 $this->addRule('email_confirm', ts('Email address is required to unsubscribe.'), 'required');
91 'name' => ts('Unsubscribe'),
96 'name' => ts('Cancel'),
100 $this->addButtons($buttons);
103 public function postProcess() {
104 $values = $this->exportValues();
106 // check if EmailTyped matches Email address
107 $result = CRM_Utils_String
::compareStr($this->_email
, $values['email_confirm'], TRUE);
108 $job_id = $this->_job_id
;
109 $queue_id = $this->_queue_id
;
110 $hash = $this->_hash
;
112 $confirmURL = CRM_Utils_System
::url("civicrm/mailing/{$this->_type}", "reset=1&jid={$job_id}&qid={$queue_id}&h={$hash}&confirm=1");
113 $this->assign('confirmURL', $confirmURL);
114 $session = CRM_Core_Session
::singleton();
115 $session->pushUserContext($confirmURL);
117 if ($result == TRUE) {
118 // Email address verified
120 $groups = CRM_Mailing_Event_BAO_Unsubscribe
::unsub_from_mailing($job_id, $queue_id, $hash);
121 if (count($groups)) {
122 CRM_Mailing_Event_BAO_Unsubscribe
::send_unsub_response($queue_id, $groups, FALSE, $job_id);
125 $statusMsg = ts('Email: %1 has been successfully unsubscribed from this Mailing List/Group.',
126 array(1 => $values['email_confirm'])
129 CRM_Core_Session
::setStatus($statusMsg, '', 'success');
131 elseif ($result == FALSE) {
132 // Email address not verified
134 $statusMsg = ts('The email address: %1 you have entered does not match the email associated with this unsubscribe request.',
135 array(1 => $values['email_confirm'])
138 CRM_Core_Session
::setStatus($statusMsg, '', 'fail');